diff --git a/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.DocumentAnalysisClient.yml b/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.DocumentAnalysisClient.yml
index bee4251cb28c..95ff48bba0db 100644
--- a/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.DocumentAnalysisClient.yml
+++ b/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.DocumentAnalysisClient.yml
@@ -71,26 +71,27 @@ examples:
- "Creating the DocumentAnalysisClient with an endpoint and API key.<!--[!code-python[Main](les\\\
v3.2_and_later\\sample_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.2_and_later\\\\sample_authentication.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials import\
- \ AzureKeyCredential\n from azure.ai.formrecognizer import DocumentAnalysisClient\n\
- \n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"\
- AZURE_FORM_RECOGNIZER_KEY\"]\n\n document_analysis_client = DocumentAnalysisClient(endpoint,\
- \ AzureKeyCredential(key))\n\n ````\n\nCreating the DocumentAnalysisClient with\
- \ a token credential.<!--[!code-python[Main](les\\v3.2_and_later\\sample_authentication.py\
- \ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\\sample_authentication.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n \"\"\"DefaultAzureCredential\
- \ will use the values from these environment\n variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,\
- \ AZURE_CLIENT_SECRET\n \"\"\"\n from azure.ai.formrecognizer import DocumentAnalysisClient\n\
- \ from azure.identity import DefaultAzureCredential\n\n endpoint = os.environ[\"\
- AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n credential = DefaultAzureCredential()\n\n\
- \ document_analysis_client = DocumentAnalysisClient(endpoint, credential)\n\n\
- \ ````\n"
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\
+ \\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false}\
+ \ -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.ai.formrecognizer import DocumentAnalysisClient\n\n endpoint =\
+ \ os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"\
+ ]\n\n document_analysis_client = DocumentAnalysisClient(endpoint, AzureKeyCredential(key))\n\
+ \n ````\n\nCreating the DocumentAnalysisClient with a token credential.<!--[!code-python[Main](les\\\
+ v3.2_and_later\\sample_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [],\
+ \ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\
+ \\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false}\
+ \ -->\n\n````python\n\n \"\"\"DefaultAzureCredential will use the values from\
+ \ these environment\n variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET\n\
+ \ \"\"\"\n from azure.ai.formrecognizer import DocumentAnalysisClient\n from\
+ \ azure.identity import DefaultAzureCredential\n\n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"\
+ ]\n credential = DefaultAzureCredential()\n\n document_analysis_client = DocumentAnalysisClient(endpoint,\
+ \ credential)\n\n ````\n"
methods:
- uid: azure.ai.formrecognizer.DocumentAnalysisClient.begin_analyze_document
name: begin_analyze_document
@@ -151,14 +152,15 @@ methods:
- "Analyze an invoice. For more samples see the *samples* folder.<!--[!code-python[Main](les\\\
v3.2_and_later\\sample_analyze_invoices.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.2_and_later\\\\sample_analyze_invoices.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.formrecognizer import DocumentAnalysisClient\n\
- \n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"\
- AZURE_FORM_RECOGNIZER_KEY\"]\n\n document_analysis_client = DocumentAnalysisClient(\n\
- \ endpoint=endpoint, credential=AzureKeyCredential(key)\n )\n with open(path_to_sample_documents,\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\
+ \\sample_analyze_invoices.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.ai.formrecognizer import DocumentAnalysisClient\n\n endpoint\
+ \ = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"\
+ ]\n\n document_analysis_client = DocumentAnalysisClient(\n endpoint=endpoint,\
+ \ credential=AzureKeyCredential(key)\n )\n with open(path_to_sample_documents,\
\ \"rb\") as f:\n poller = document_analysis_client.begin_analyze_document(\n\
\ \"prebuilt-invoice\", document=f, locale=\"en-US\"\n )\n invoices\
\ = poller.result()\n\n for idx, invoice in enumerate(invoices.documents):\n\
@@ -263,7 +265,8 @@ methods:
\ a custom document. For more samples see the *samples* folder.<!--[!code-python[Main](les\\\
v3.2_and_later\\sample_analyze_custom_documents.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
\\samples\\\\v3.2_and_later\\\\sample_analyze_custom_documents.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
@@ -361,7 +364,8 @@ methods:
- "Analyze a receipt. For more samples see the *samples* folder.<!--[!code-python[Main](les\\\
v3.2_and_later\\sample_analyze_receipts_from_url.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
\\samples\\\\v3.2_and_later\\\\sample_analyze_receipts_from_url.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
@@ -442,16 +446,16 @@ methods:
- "Classify a document. For more samples see the *samples* folder.<!--[!code-python[Main](les\\\
v3.2_and_later\\sample_classify_document.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.2_and_later\\\\sample_classify_document.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.formrecognizer import DocumentAnalysisClient\n\
- \n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"\
- AZURE_FORM_RECOGNIZER_KEY\"]\n classifier_id = os.getenv(\"CLASSIFIER_ID\",\
- \ classifier_id)\n\n document_analysis_client = DocumentAnalysisClient(\n \
- \ endpoint=endpoint, credential=AzureKeyCredential(key)\n )\n with open(path_to_sample_documents,\
- \ \"rb\") as f:\n poller = document_analysis_client.begin_classify_document(\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\
+ \\sample_classify_document.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.ai.formrecognizer import DocumentAnalysisClient\n\n endpoint\
+ \ = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"\
+ ]\n classifier_id = os.getenv(\"CLASSIFIER_ID\", classifier_id)\n\n document_analysis_client\
+ \ = DocumentAnalysisClient(\n endpoint=endpoint, credential=AzureKeyCredential(key)\n\
+ \ )\n with open(path_to_sample_documents, \"rb\") as f:\n poller = document_analysis_client.begin_classify_document(\n\
\ classifier_id, document=f\n )\n result = poller.result()\n\
\n print(\"----Classified documents----\")\n for doc in result.documents:\n\
\ print(\n f\"Found document of type '{doc.doc_type or 'N/A'}'\
@@ -500,7 +504,8 @@ methods:
- "Classify a document. For more samples see the *samples* folder.<!--[!code-python[Main](les\\\
v3.2_and_later\\sample_classify_document_from_url.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
\\samples\\\\v3.2_and_later\\\\sample_classify_document_from_url.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
diff --git a/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.DocumentModelAdministrationClient.yml b/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.DocumentModelAdministrationClient.yml
index ddf908c608c6..61925eff581d 100644
--- a/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.DocumentModelAdministrationClient.yml
+++ b/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.DocumentModelAdministrationClient.yml
@@ -72,21 +72,23 @@ examples:
- "Creating the DocumentModelAdministrationClient with an endpoint and API key.<!--[!code-python[Main](les\\\
v3.2_and_later\\sample_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.2_and_later\\\\sample_authentication.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials import\
- \ AzureKeyCredential\n from azure.ai.formrecognizer import DocumentModelAdministrationClient\n\
- \n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\
+ \\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false}\
+ \ -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.ai.formrecognizer import DocumentModelAdministrationClient\n\n \
+ \ endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"\
AZURE_FORM_RECOGNIZER_KEY\"]\n\n document_model_admin_client = DocumentModelAdministrationClient(\n\
\ endpoint, AzureKeyCredential(key)\n )\n\n ````\n\nCreating the DocumentModelAdministrationClient\
\ with a token credential.<!--[!code-python[Main](les\\v3.2_and_later\\sample_authentication.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\\sample_authentication.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n \"\"\"DefaultAzureCredential\
- \ will use the values from these environment\n variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
+ \\samples\\\\v3.2_and_later\\\\sample_authentication.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n \"\"\"DefaultAzureCredential will\
+ \ use the values from these environment\n variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,\
\ AZURE_CLIENT_SECRET\n \"\"\"\n from azure.ai.formrecognizer import DocumentModelAdministrationClient\n\
\ from azure.identity import DefaultAzureCredential\n\n endpoint = os.environ[\"\
AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n credential = DefaultAzureCredential()\n\n\
@@ -133,16 +135,16 @@ methods:
examples:
- "Build a document classifier.<!--[!code-python[Main](les\\v3.2_and_later\\sample_build_classifier.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\
- \\sample_build_classifier.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n import os\n from azure.ai.formrecognizer import\
- \ (\n DocumentModelAdministrationClient,\n ClassifierDocumentTypeDetails,\n\
- \ BlobSource,\n BlobFileListSource,\n )\n from azure.core.credentials\
- \ import AzureKeyCredential\n\n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"\
- ]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"]\n container_sas_url =\
- \ os.environ[\"CLASSIFIER_CONTAINER_SAS_URL\"]\n\n document_model_admin_client\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\\sample_build_classifier.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n import os\n from azure.ai.formrecognizer import (\n DocumentModelAdministrationClient,\n\
+ \ ClassifierDocumentTypeDetails,\n BlobSource,\n BlobFileListSource,\n\
+ \ )\n from azure.core.credentials import AzureKeyCredential\n\n endpoint\
+ \ = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"\
+ ]\n container_sas_url = os.environ[\"CLASSIFIER_CONTAINER_SAS_URL\"]\n\n document_model_admin_client\
\ = DocumentModelAdministrationClient(\n endpoint=endpoint, credential=AzureKeyCredential(key)\n\
\ )\n\n poller = document_model_admin_client.begin_build_document_classifier(\n\
\ doc_types={\n \"IRS-1040-A\": ClassifierDocumentTypeDetails(\n\
@@ -249,18 +251,18 @@ methods:
examples:
- "Building a model from training files.<!--[!code-python[Main](les\\v3.2_and_later\\\
sample_build_model.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
- \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\\
- _work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\
- \\v3.2_and_later\\\\sample_build_model.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.ai.formrecognizer import\
- \ (\n DocumentModelAdministrationClient,\n ModelBuildMode,\n )\n\
- \ from azure.core.credentials import AzureKeyCredential\n\n endpoint = os.environ[\"\
- AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"\
- ]\n container_sas_url = os.environ[\"CONTAINER_SAS_URL\"]\n\n document_model_admin_client\
- \ = DocumentModelAdministrationClient(\n endpoint, AzureKeyCredential(key)\n\
- \ )\n poller = document_model_admin_client.begin_build_document_model(\n \
- \ ModelBuildMode.TEMPLATE,\n blob_container_url=container_sas_url,\n\
+ \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\\sample_build_model.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.ai.formrecognizer import (\n DocumentModelAdministrationClient,\n\
+ \ ModelBuildMode,\n )\n from azure.core.credentials import AzureKeyCredential\n\
+ \n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"\
+ AZURE_FORM_RECOGNIZER_KEY\"]\n container_sas_url = os.environ[\"CONTAINER_SAS_URL\"\
+ ]\n\n document_model_admin_client = DocumentModelAdministrationClient(\n \
+ \ endpoint, AzureKeyCredential(key)\n )\n poller = document_model_admin_client.begin_build_document_model(\n\
+ \ ModelBuildMode.TEMPLATE,\n blob_container_url=container_sas_url,\n\
\ description=\"my model description\",\n )\n model = poller.result()\n\
\n print(f\"Model ID: {model.model_id}\")\n print(f\"Description: {model.description}\"\
)\n print(f\"Model created on: {model.created_on}\")\n print(f\"Model expires\
@@ -319,44 +321,45 @@ methods:
- "Creating a composed model with existing models.<!--[!code-python[Main](les\\\
v3.2_and_later\\sample_compose_model.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.2_and_later\\\\sample_compose_model.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.formrecognizer import (\n \
- \ DocumentModelAdministrationClient,\n ModelBuildMode,\n )\n\n endpoint\
- \ = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"\
- ]\n po_supplies = os.environ[\"PURCHASE_ORDER_OFFICE_SUPPLIES_SAS_URL\"]\n \
- \ po_equipment = os.environ[\"PURCHASE_ORDER_OFFICE_EQUIPMENT_SAS_URL\"]\n \
- \ po_furniture = os.environ[\"PURCHASE_ORDER_OFFICE_FURNITURE_SAS_URL\"]\n po_cleaning_supplies\
- \ = os.environ[\"PURCHASE_ORDER_OFFICE_CLEANING_SUPPLIES_SAS_URL\"]\n\n document_model_admin_client\
- \ = DocumentModelAdministrationClient(\n endpoint=endpoint, credential=AzureKeyCredential(key)\n\
- \ )\n supplies_poller = document_model_admin_client.begin_build_document_model(\n\
- \ ModelBuildMode.TEMPLATE,\n blob_container_url=po_supplies,\n \
- \ description=\"Purchase order-Office supplies\",\n )\n equipment_poller\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\
+ \\sample_compose_model.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.ai.formrecognizer import (\n DocumentModelAdministrationClient,\n\
+ \ ModelBuildMode,\n )\n\n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"\
+ ]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"]\n po_supplies = os.environ[\"\
+ PURCHASE_ORDER_OFFICE_SUPPLIES_SAS_URL\"]\n po_equipment = os.environ[\"PURCHASE_ORDER_OFFICE_EQUIPMENT_SAS_URL\"\
+ ]\n po_furniture = os.environ[\"PURCHASE_ORDER_OFFICE_FURNITURE_SAS_URL\"]\n\
+ \ po_cleaning_supplies = os.environ[\"PURCHASE_ORDER_OFFICE_CLEANING_SUPPLIES_SAS_URL\"\
+ ]\n\n document_model_admin_client = DocumentModelAdministrationClient(\n \
+ \ endpoint=endpoint, credential=AzureKeyCredential(key)\n )\n supplies_poller\
\ = document_model_admin_client.begin_build_document_model(\n ModelBuildMode.TEMPLATE,\n\
- \ blob_container_url=po_equipment,\n description=\"Purchase order-Office\
- \ Equipment\",\n )\n furniture_poller = document_model_admin_client.begin_build_document_model(\n\
- \ ModelBuildMode.TEMPLATE,\n blob_container_url=po_furniture,\n \
- \ description=\"Purchase order-Furniture\",\n )\n cleaning_supplies_poller\
+ \ blob_container_url=po_supplies,\n description=\"Purchase order-Office\
+ \ supplies\",\n )\n equipment_poller = document_model_admin_client.begin_build_document_model(\n\
+ \ ModelBuildMode.TEMPLATE,\n blob_container_url=po_equipment,\n \
+ \ description=\"Purchase order-Office Equipment\",\n )\n furniture_poller\
\ = document_model_admin_client.begin_build_document_model(\n ModelBuildMode.TEMPLATE,\n\
- \ blob_container_url=po_cleaning_supplies,\n description=\"Purchase\
- \ order-Cleaning Supplies\",\n )\n supplies_model = supplies_poller.result()\n\
- \ equipment_model = equipment_poller.result()\n furniture_model = furniture_poller.result()\n\
- \ cleaning_supplies_model = cleaning_supplies_poller.result()\n\n purchase_order_models\
- \ = [\n supplies_model.model_id,\n equipment_model.model_id,\n \
- \ furniture_model.model_id,\n cleaning_supplies_model.model_id,\n ]\n\
- \n poller = document_model_admin_client.begin_compose_document_model(\n \
- \ purchase_order_models, description=\"Office Supplies Composed Model\"\n \
- \ )\n model = poller.result()\n\n print(\"Office Supplies Composed Model Info:\"\
- )\n print(f\"Model ID: {model.model_id}\")\n print(f\"Description: {model.description}\"\
- )\n print(f\"Model created on: {model.created_on}\")\n print(f\"Model expires\
- \ on: {model.expires_on}\")\n print(\"Doc types the model can recognize:\")\n\
- \ for name, doc_type in model.doc_types.items():\n print(f\"Doc Type:\
- \ '{name}' which has the following fields:\")\n for field_name, field in\
- \ doc_type.field_schema.items():\n print(\n f\"Field:\
- \ '{field_name}' has type '{field['type']}' and confidence score \"\n \
- \ f\"{doc_type.field_confidence[field_name]}\"\n )\n\n ````\n"
+ \ blob_container_url=po_furniture,\n description=\"Purchase order-Furniture\"\
+ ,\n )\n cleaning_supplies_poller = document_model_admin_client.begin_build_document_model(\n\
+ \ ModelBuildMode.TEMPLATE,\n blob_container_url=po_cleaning_supplies,\n\
+ \ description=\"Purchase order-Cleaning Supplies\",\n )\n supplies_model\
+ \ = supplies_poller.result()\n equipment_model = equipment_poller.result()\n\
+ \ furniture_model = furniture_poller.result()\n cleaning_supplies_model =\
+ \ cleaning_supplies_poller.result()\n\n purchase_order_models = [\n supplies_model.model_id,\n\
+ \ equipment_model.model_id,\n furniture_model.model_id,\n cleaning_supplies_model.model_id,\n\
+ \ ]\n\n poller = document_model_admin_client.begin_compose_document_model(\n\
+ \ purchase_order_models, description=\"Office Supplies Composed Model\"\n\
+ \ )\n model = poller.result()\n\n print(\"Office Supplies Composed Model\
+ \ Info:\")\n print(f\"Model ID: {model.model_id}\")\n print(f\"Description:\
+ \ {model.description}\")\n print(f\"Model created on: {model.created_on}\")\n\
+ \ print(f\"Model expires on: {model.expires_on}\")\n print(\"Doc types the\
+ \ model can recognize:\")\n for name, doc_type in model.doc_types.items():\n\
+ \ print(f\"Doc Type: '{name}' which has the following fields:\")\n \
+ \ for field_name, field in doc_type.field_schema.items():\n print(\n\
+ \ f\"Field: '{field_name}' has type '{field['type']}' and confidence\
+ \ score \"\n f\"{doc_type.field_confidence[field_name]}\"\n \
+ \ )\n\n ````\n"
- uid: azure.ai.formrecognizer.DocumentModelAdministrationClient.begin_copy_document_model_to
name: begin_copy_document_model_to
summary: 'Copy a document model stored in this resource (the source) to the user
@@ -401,12 +404,13 @@ methods:
- "Copy a model from the source resource to the target resource<!--[!code-python[Main](les\\\
v3.2_and_later\\sample_copy_model_to.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.2_and_later\\\\sample_copy_model_to.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.formrecognizer import DocumentModelAdministrationClient\n\
- \n source_endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_SOURCE_ENDPOINT\"]\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\
+ \\sample_copy_model_to.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.ai.formrecognizer import DocumentModelAdministrationClient\n\n\
+ \ source_endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_SOURCE_ENDPOINT\"]\n\
\ source_key = os.environ[\"AZURE_FORM_RECOGNIZER_SOURCE_KEY\"]\n target_endpoint\
\ = os.environ[\"AZURE_FORM_RECOGNIZER_TARGET_ENDPOINT\"]\n target_key = os.environ[\"\
AZURE_FORM_RECOGNIZER_TARGET_KEY\"]\n source_model_id = os.getenv(\"AZURE_SOURCE_MODEL_ID\"\
@@ -455,12 +459,13 @@ methods:
examples:
- "Delete a classifier.<!--[!code-python[Main](les\\v3.2_and_later\\sample_manage_classifiers.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\
- \\sample_manage_classifiers.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n document_model_admin_client.delete_document_classifier(\n\
- \ classifier_id=my_classifier.classifier_id\n )\n\n try:\n document_model_admin_client.get_document_classifier(\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\\sample_manage_classifiers.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n document_model_admin_client.delete_document_classifier(\n classifier_id=my_classifier.classifier_id\n\
+ \ )\n\n try:\n document_model_admin_client.get_document_classifier(\n\
\ classifier_id=my_classifier.classifier_id\n )\n except ResourceNotFoundError:\n\
\ print(f\"Successfully deleted classifier with ID {my_classifier.classifier_id}\"\
)\n\n ````\n"
@@ -484,11 +489,12 @@ methods:
examples:
- "Delete a model.<!--[!code-python[Main](les\\v3.2_and_later\\sample_manage_models.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\
- \\sample_manage_models.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
- language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n document_model_admin_client.delete_document_model(model_id=my_model.model_id)\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\\sample_manage_models.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n document_model_admin_client.delete_document_model(model_id=my_model.model_id)\n\
\n try:\n document_model_admin_client.get_document_model(model_id=my_model.model_id)\n\
\ except ResourceNotFoundError:\n print(f\"Successfully deleted model\
\ with ID {my_model.model_id}\")\n\n ````\n"
@@ -555,12 +561,13 @@ methods:
examples:
- "Get a classifier by its ID.<!--[!code-python[Main](les\\v3.2_and_later\\sample_manage_classifiers.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\
- \\sample_manage_classifiers.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n my_classifier = document_model_admin_client.get_document_classifier(\n\
- \ classifier_id=classifier_model.classifier_id\n )\n print(f\"\\nClassifier\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\\sample_manage_classifiers.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n my_classifier = document_model_admin_client.get_document_classifier(\n \
+ \ classifier_id=classifier_model.classifier_id\n )\n print(f\"\\nClassifier\
\ ID: {my_classifier.classifier_id}\")\n print(f\"Description: {my_classifier.description}\"\
)\n print(f\"Classifier created on: {my_classifier.created_on}\")\n\n ````\n"
- uid: azure.ai.formrecognizer.DocumentModelAdministrationClient.get_document_model
@@ -583,11 +590,12 @@ methods:
examples:
- "Get a model by its ID.<!--[!code-python[Main](les\\v3.2_and_later\\sample_manage_models.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\
- \\sample_manage_models.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
- language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n my_model = document_model_admin_client.get_document_model(model_id=model.model_id)\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\\sample_manage_models.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n my_model = document_model_admin_client.get_document_model(model_id=model.model_id)\n\
\ print(f\"\\nModel ID: {my_model.model_id}\")\n print(f\"Description: {my_model.description}\"\
)\n print(f\"Model created on: {my_model.created_on}\")\n print(f\"Model expires\
\ on: {my_model.expires_on}\")\n\n ````\n"
@@ -620,12 +628,13 @@ methods:
examples:
- "Get a document model operation by its ID.<!--[!code-python[Main](les\\v3.2_and_later\\\
sample_get_operations.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\
- \\v3.2_and_later\\\\sample_get_operations.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n # Get an operation by ID\n \
- \ if operations:\n print(f\"\\nGetting operation info by ID: {operations[0].operation_id}\"\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\
+ \\sample_get_operations.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n # Get an operation by ID\n if operations:\n\
+ \ print(f\"\\nGetting operation info by ID: {operations[0].operation_id}\"\
)\n operation_info = document_model_admin_client.get_operation(\n \
\ operations[0].operation_id\n )\n if operation_info.status ==\
\ \"succeeded\":\n print(f\"My {operation_info.kind} operation is completed.\"\
@@ -652,14 +661,15 @@ methods:
- "Get model counts and limits under the Form Recognizer resource.<!--[!code-python[Main](les\\\
v3.2_and_later\\sample_manage_models.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.2_and_later\\\\sample_manage_models.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n document_model_admin_client\
- \ = DocumentModelAdministrationClient(\n endpoint=endpoint, credential=AzureKeyCredential(key)\n\
- \ )\n\n account_details = document_model_admin_client.get_resource_details()\n\
- \ print(\n f\"Our resource has {account_details.custom_document_models.count}\
- \ custom models, \"\n f\"and we can have at most {account_details.custom_document_models.limit}\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\
+ \\sample_manage_models.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n document_model_admin_client = DocumentModelAdministrationClient(\n\
+ \ endpoint=endpoint, credential=AzureKeyCredential(key)\n )\n\n account_details\
+ \ = document_model_admin_client.get_resource_details()\n print(\n f\"\
+ Our resource has {account_details.custom_document_models.count} custom models,\
+ \ \"\n f\"and we can have at most {account_details.custom_document_models.limit}\
\ custom models\"\n )\n neural_models = account_details.neural_document_model_quota\n\
\ print(\n f\"The quota limit for custom neural document models is {neural_models.quota}\
\ and the resource has\"\n f\"used {neural_models.used}. The resource quota\
@@ -684,14 +694,14 @@ methods:
- "List all classifiers that were built successfully under the Form Recognizer resource.<!--[!code-python[Main](les\\\
v3.2_and_later\\sample_manage_classifiers.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.2_and_later\\\\sample_manage_classifiers.py\", \"xml:space\":\
- \ \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n classifiers\
- \ = document_model_admin_client.list_document_classifiers()\n\n print(\"We have\
- \ the following 'ready' models with IDs and descriptions:\")\n for classifier\
- \ in classifiers:\n print(f\"{classifier.classifier_id} | {classifier.description}\"\
- )\n\n ````\n"
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\
+ \\sample_manage_classifiers.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n classifiers = document_model_admin_client.list_document_classifiers()\n\
+ \n print(\"We have the following 'ready' models with IDs and descriptions:\"\
+ )\n for classifier in classifiers:\n print(f\"{classifier.classifier_id}\
+ \ | {classifier.description}\")\n\n ````\n"
- uid: azure.ai.formrecognizer.DocumentModelAdministrationClient.list_document_models
name: list_document_models
summary: 'List information for each model, including its model ID,
@@ -708,10 +718,11 @@ methods:
- "List all models that were built successfully under the Form Recognizer resource.<!--[!code-python[Main](les\\\
v3.2_and_later\\sample_manage_models.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.2_and_later\\\\sample_manage_models.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n models = document_model_admin_client.list_document_models()\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\
+ \\sample_manage_models.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n models = document_model_admin_client.list_document_models()\n\
\n print(\"We have the following 'ready' models with IDs and descriptions:\"\
)\n for model in models:\n print(f\"{model.model_id} | {model.description}\"\
)\n\n ````\n"
@@ -739,12 +750,13 @@ methods:
- "List all document model operations in the past 24 hours.<!--[!code-python[Main](les\\\
v3.2_and_later\\sample_get_operations.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.2_and_later\\\\sample_get_operations.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.formrecognizer import DocumentModelAdministrationClient\n\
- \n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\
+ \\sample_get_operations.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.ai.formrecognizer import DocumentModelAdministrationClient\n\n\
+ \ endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"\
AZURE_FORM_RECOGNIZER_KEY\"]\n\n document_model_admin_client = DocumentModelAdministrationClient(\n\
\ endpoint=endpoint, credential=AzureKeyCredential(key)\n )\n\n operations\
\ = list(document_model_admin_client.list_operations())\n\n print(\"The following\
diff --git a/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.FormRecognizerClient.yml b/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.FormRecognizerClient.yml
index b911a0e21978..efbd6ba60ebc 100644
--- a/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.FormRecognizerClient.yml
+++ b/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.FormRecognizerClient.yml
@@ -65,25 +65,27 @@ examples:
- "Creating the FormRecognizerClient with an endpoint and API key.<!--[!code-python[Main](les\\\
v3.1\\sample_authentication_v3_1.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"\
- D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\\
- samples\\\\v3.1\\\\sample_authentication_v3_1.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials import\
- \ AzureKeyCredential\n from azure.ai.formrecognizer import FormRecognizerClient\n\
- \ endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"\
- AZURE_FORM_RECOGNIZER_KEY\"]\n\n form_recognizer_client = FormRecognizerClient(endpoint,\
- \ AzureKeyCredential(key))\n\n ````\n\nCreating the FormRecognizerClient with\
- \ a token credential.<!--[!code-python[Main](les\\v3.1\\sample_authentication_v3_1.py\
- \ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\\sample_authentication_v3_1.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n \"\"\"DefaultAzureCredential\
- \ will use the values from these environment\n variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,\
- \ AZURE_CLIENT_SECRET\n \"\"\"\n from azure.ai.formrecognizer import FormRecognizerClient\n\
- \ from azure.identity import DefaultAzureCredential\n\n endpoint = os.environ[\"\
- AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n credential = DefaultAzureCredential()\n\n\
- \ form_recognizer_client = FormRecognizerClient(endpoint, credential)\n\n ````\n"
+ C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\
+ \\sample_authentication_v3_1.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.ai.formrecognizer import FormRecognizerClient\n endpoint = os.environ[\"\
+ AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"\
+ ]\n\n form_recognizer_client = FormRecognizerClient(endpoint, AzureKeyCredential(key))\n\
+ \n ````\n\nCreating the FormRecognizerClient with a token credential.<!--[!code-python[Main](les\\\
+ v3.1\\sample_authentication_v3_1.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
+ classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"\
+ C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\
+ \\sample_authentication_v3_1.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n \"\"\"DefaultAzureCredential will use the values\
+ \ from these environment\n variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET\n\
+ \ \"\"\"\n from azure.ai.formrecognizer import FormRecognizerClient\n from\
+ \ azure.identity import DefaultAzureCredential\n\n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"\
+ ]\n credential = DefaultAzureCredential()\n\n form_recognizer_client = FormRecognizerClient(endpoint,\
+ \ credential)\n\n ````\n"
methods:
- uid: azure.ai.formrecognizer.FormRecognizerClient.begin_recognize_business_cards
name: begin_recognize_business_cards
@@ -157,8 +159,9 @@ methods:
examples:
- "Recognize business cards from a file.<!--[!code-python[Main](les\\v3.1\\sample_recognize_business_cards.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\\sample_recognize_business_cards.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\\sample_recognize_business_cards.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.core.credentials import AzureKeyCredential\n from azure.ai.formrecognizer\
@@ -347,15 +350,15 @@ methods:
- "Recognize text and content/layout information from a form.<!--[!code-python[Main](les\\\
v3.1\\sample_recognize_content.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.1\\\\sample_recognize_content.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.formrecognizer import FormRecognizerClient\n\
- \n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"\
- AZURE_FORM_RECOGNIZER_KEY\"]\n\n form_recognizer_client = FormRecognizerClient(endpoint=endpoint,\
- \ credential=AzureKeyCredential(key))\n with open(path_to_sample_forms, \"rb\"\
- ) as f:\n poller = form_recognizer_client.begin_recognize_content(form=f)\n\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\
+ \\sample_recognize_content.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.ai.formrecognizer import FormRecognizerClient\n\n endpoint =\
+ \ os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"\
+ ]\n\n form_recognizer_client = FormRecognizerClient(endpoint=endpoint, credential=AzureKeyCredential(key))\n\
+ \ with open(path_to_sample_forms, \"rb\") as f:\n poller = form_recognizer_client.begin_recognize_content(form=f)\n\
\ form_pages = poller.result()\n\n for idx, content in enumerate(form_pages):\n\
\ print(\"----Recognizing content from page #{}----\".format(idx+1))\n \
\ print(\"Page has width: {} and height: {}, measured with unit: {}\".format(\n\
@@ -517,49 +520,50 @@ methods:
- "Recognize fields and values from a custom form.<!--[!code-python[Main](les\\\
v3.1\\sample_recognize_custom_forms.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.1\\\\sample_recognize_custom_forms.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.formrecognizer import FormRecognizerClient\n\
- \n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"\
- AZURE_FORM_RECOGNIZER_KEY\"]\n model_id = os.getenv(\"CUSTOM_TRAINED_MODEL_ID\"\
- , custom_model_id)\n\n form_recognizer_client = FormRecognizerClient(\n \
- \ endpoint=endpoint, credential=AzureKeyCredential(key)\n )\n\n # Make sure\
- \ your form's type is included in the list of form types the custom model can\
- \ recognize\n with open(path_to_sample_forms, \"rb\") as f:\n poller =\
- \ form_recognizer_client.begin_recognize_custom_forms(\n model_id=model_id,\
- \ form=f, include_field_elements=True\n )\n forms = poller.result()\n\n\
- \ for idx, form in enumerate(forms):\n print(\"--------Recognizing Form\
- \ #{}--------\".format(idx+1))\n print(\"Form has type {}\".format(form.form_type))\n\
- \ print(\"Form has form type confidence {}\".format(form.form_type_confidence))\n\
- \ print(\"Form was analyzed with model with ID {}\".format(form.model_id))\n\
- \ for name, field in form.fields.items():\n # each field is of\
- \ type FormField\n # label_data is populated if you are using a model\
- \ trained without labels,\n # since the service needs to make predictions\
- \ for labels if not explicitly given to it.\n if field.label_data:\n\
- \ print(\"...Field '{}' has label '{}' with a confidence score of\
- \ {}\".format(\n name,\n field.label_data.text,\n\
- \ field.confidence\n ))\n\n print(\"\
- ...Label '{}' has value '{}' with a confidence score of {}\".format(\n \
- \ field.label_data.text if field.label_data else name, field.value, field.confidence\n\
- \ ))\n\n # iterate over tables, lines, and selection marks on\
- \ each page\n for page in form.pages:\n for i, table in enumerate(page.tables):\n\
- \ print(\"\\nTable {} on page {}\".format(i+1, table.page_number))\n\
- \ for cell in table.cells:\n print(\"...Cell[{}][{}]\
- \ has text '{}' with confidence {}\".format(\n cell.row_index,\
- \ cell.column_index, cell.text, cell.confidence\n ))\n \
- \ print(\"\\nLines found on page {}\".format(page.page_number))\n \
- \ for line in page.lines:\n print(\"...Line '{}' is made up of\
- \ the following words: \".format(line.text))\n for word in line.words:\n\
- \ print(\"......Word '{}' has a confidence of {}\".format(\n\
- \ word.text,\n word.confidence\n \
- \ ))\n if page.selection_marks:\n print(\"\
- \\nSelection marks found on page {}\".format(page.page_number))\n \
- \ for selection_mark in page.selection_marks:\n print(\"......Selection\
- \ mark is '{}' and has a confidence of {}\".format(\n selection_mark.state,\n\
- \ selection_mark.confidence\n ))\n\n \
- \ print(\"-----------------------------------\")\n\n ````\n"
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\
+ \\sample_recognize_custom_forms.py\", \"xml:space\": \"preserve\", \"force\":\
+ \ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.ai.formrecognizer import FormRecognizerClient\n\n endpoint =\
+ \ os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"\
+ ]\n model_id = os.getenv(\"CUSTOM_TRAINED_MODEL_ID\", custom_model_id)\n\n \
+ \ form_recognizer_client = FormRecognizerClient(\n endpoint=endpoint, credential=AzureKeyCredential(key)\n\
+ \ )\n\n # Make sure your form's type is included in the list of form types\
+ \ the custom model can recognize\n with open(path_to_sample_forms, \"rb\") as\
+ \ f:\n poller = form_recognizer_client.begin_recognize_custom_forms(\n \
+ \ model_id=model_id, form=f, include_field_elements=True\n )\n\
+ \ forms = poller.result()\n\n for idx, form in enumerate(forms):\n print(\"\
+ --------Recognizing Form #{}--------\".format(idx+1))\n print(\"Form has\
+ \ type {}\".format(form.form_type))\n print(\"Form has form type confidence\
+ \ {}\".format(form.form_type_confidence))\n print(\"Form was analyzed with\
+ \ model with ID {}\".format(form.model_id))\n for name, field in form.fields.items():\n\
+ \ # each field is of type FormField\n # label_data is populated\
+ \ if you are using a model trained without labels,\n # since the service\
+ \ needs to make predictions for labels if not explicitly given to it.\n \
+ \ if field.label_data:\n print(\"...Field '{}' has label '{}'\
+ \ with a confidence score of {}\".format(\n name,\n \
+ \ field.label_data.text,\n field.confidence\n \
+ \ ))\n\n print(\"...Label '{}' has value '{}' with a confidence\
+ \ score of {}\".format(\n field.label_data.text if field.label_data\
+ \ else name, field.value, field.confidence\n ))\n\n # iterate\
+ \ over tables, lines, and selection marks on each page\n for page in form.pages:\n\
+ \ for i, table in enumerate(page.tables):\n print(\"\\\
+ nTable {} on page {}\".format(i+1, table.page_number))\n for cell\
+ \ in table.cells:\n print(\"...Cell[{}][{}] has text '{}' with\
+ \ confidence {}\".format(\n cell.row_index, cell.column_index,\
+ \ cell.text, cell.confidence\n ))\n print(\"\\nLines\
+ \ found on page {}\".format(page.page_number))\n for line in page.lines:\n\
+ \ print(\"...Line '{}' is made up of the following words: \".format(line.text))\n\
+ \ for word in line.words:\n print(\"......Word\
+ \ '{}' has a confidence of {}\".format(\n word.text,\n \
+ \ word.confidence\n ))\n if page.selection_marks:\n\
+ \ print(\"\\nSelection marks found on page {}\".format(page.page_number))\n\
+ \ for selection_mark in page.selection_marks:\n \
+ \ print(\"......Selection mark is '{}' and has a confidence of {}\".format(\n\
+ \ selection_mark.state,\n selection_mark.confidence\n\
+ \ ))\n\n print(\"-----------------------------------\"\
+ )\n\n ````\n"
- uid: azure.ai.formrecognizer.FormRecognizerClient.begin_recognize_custom_forms_from_url
name: begin_recognize_custom_forms_from_url
summary: 'Analyze a custom form with a model trained with or without labels. The
@@ -679,8 +683,9 @@ methods:
examples:
- "Recognize identity document fields.<!--[!code-python[Main](les\\v3.1\\sample_recognize_identity_documents.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\\sample_recognize_identity_documents.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\\sample_recognize_identity_documents.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.core.credentials import AzureKeyCredential\n from azure.ai.formrecognizer\
@@ -833,8 +838,9 @@ methods:
examples:
- "Recognize invoices from a file.<!--[!code-python[Main](les\\v3.1\\sample_recognize_invoices.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\\sample_recognize_invoices.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\\sample_recognize_invoices.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.core.credentials import AzureKeyCredential\n from azure.ai.formrecognizer\
@@ -1062,8 +1068,9 @@ methods:
examples:
- "Recognize sales receipt fields.<!--[!code-python[Main](les\\v3.1\\sample_recognize_receipts.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\\sample_recognize_receipts.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\\sample_recognize_receipts.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.core.credentials import AzureKeyCredential\n from azure.ai.formrecognizer\
@@ -1167,15 +1174,15 @@ methods:
- "Recognize sales receipt fields from a URL.<!--[!code-python[Main](les\\v3.1\\\
sample_recognize_receipts_from_url.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.1\\\\sample_recognize_receipts_from_url.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.formrecognizer import FormRecognizerClient\n\
- \n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"\
- AZURE_FORM_RECOGNIZER_KEY\"]\n\n form_recognizer_client = FormRecognizerClient(\n\
- \ endpoint=endpoint, credential=AzureKeyCredential(key)\n )\n url =\
- \ \"https://raw.githubusercontent.com/Azure/azure-sdk-for-python/main/sdk/formrecognizer/azure-ai-formrecognizer/tests/sample_forms/receipt/contoso-receipt.png\"\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\
+ \\sample_recognize_receipts_from_url.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.ai.formrecognizer import FormRecognizerClient\n\n endpoint =\
+ \ os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"\
+ ]\n\n form_recognizer_client = FormRecognizerClient(\n endpoint=endpoint,\
+ \ credential=AzureKeyCredential(key)\n )\n url = \"https://raw.githubusercontent.com/Azure/azure-sdk-for-python/main/sdk/formrecognizer/azure-ai-formrecognizer/tests/sample_forms/receipt/contoso-receipt.png\"\
\n poller = form_recognizer_client.begin_recognize_receipts_from_url(receipt_url=url)\n\
\ receipts = poller.result()\n\n for idx, receipt in enumerate(receipts):\n\
\ print(\"--------Recognizing receipt #{}--------\".format(idx+1))\n \
diff --git a/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.FormTrainingClient.yml b/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.FormTrainingClient.yml
index a41690f137d4..4ac883ad61d6 100644
--- a/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.FormTrainingClient.yml
+++ b/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.FormTrainingClient.yml
@@ -62,25 +62,27 @@ examples:
- "Creating the FormTrainingClient with an endpoint and API key.<!--[!code-python[Main](les\\\
v3.1\\sample_authentication_v3_1.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"\
- D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\\
- samples\\\\v3.1\\\\sample_authentication_v3_1.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials import\
- \ AzureKeyCredential\n from azure.ai.formrecognizer import FormTrainingClient\n\
- \ endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"\
- AZURE_FORM_RECOGNIZER_KEY\"]\n\n form_training_client = FormTrainingClient(endpoint,\
- \ AzureKeyCredential(key))\n\n ````\n\nCreating the FormTrainingClient with a\
- \ token credential.<!--[!code-python[Main](les\\v3.1\\sample_authentication_v3_1.py\
- \ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\\sample_authentication_v3_1.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n \"\"\"DefaultAzureCredential\
- \ will use the values from these environment\n variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,\
- \ AZURE_CLIENT_SECRET\n \"\"\"\n from azure.ai.formrecognizer import FormTrainingClient\n\
- \ from azure.identity import DefaultAzureCredential\n\n endpoint = os.environ[\"\
- AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n credential = DefaultAzureCredential()\n\n\
- \ form_training_client = FormTrainingClient(endpoint, credential)\n\n ````\n"
+ C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\
+ \\sample_authentication_v3_1.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.ai.formrecognizer import FormTrainingClient\n endpoint = os.environ[\"\
+ AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"\
+ ]\n\n form_training_client = FormTrainingClient(endpoint, AzureKeyCredential(key))\n\
+ \n ````\n\nCreating the FormTrainingClient with a token credential.<!--[!code-python[Main](les\\\
+ v3.1\\sample_authentication_v3_1.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
+ classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"\
+ C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\
+ \\sample_authentication_v3_1.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n \"\"\"DefaultAzureCredential will use the values\
+ \ from these environment\n variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET\n\
+ \ \"\"\"\n from azure.ai.formrecognizer import FormTrainingClient\n from azure.identity\
+ \ import DefaultAzureCredential\n\n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"\
+ ]\n credential = DefaultAzureCredential()\n\n form_training_client = FormTrainingClient(endpoint,\
+ \ credential)\n\n ````\n"
methods:
- uid: azure.ai.formrecognizer.FormTrainingClient.begin_copy_model
name: begin_copy_model
@@ -125,11 +127,12 @@ methods:
examples:
- "Copy a model from the source resource to the target resource<!--[!code-python[Main](les\\\
v3.1\\sample_copy_model.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\
- \\v3.1\\\\sample_copy_model.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n source_client = FormTrainingClient(endpoint=source_endpoint,\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\
+ \\sample_copy_model.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
+ : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
+ \n````python\n\n source_client = FormTrainingClient(endpoint=source_endpoint,\
\ credential=AzureKeyCredential(source_key))\n\n poller = source_client.begin_copy_model(\n\
\ model_id=source_model_id,\n target=target # output from target\
\ client's call to get_copy_authorization()\n )\n copied_over_model = poller.result()\n\
@@ -178,8 +181,9 @@ methods:
examples:
- "Create a composed model<!--[!code-python[Main](les\\v3.1\\sample_create_composed_model.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\\sample_create_composed_model.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\\sample_create_composed_model.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.core.credentials import AzureKeyCredential\n from azure.ai.formrecognizer\
@@ -299,11 +303,12 @@ methods:
- "Training a model (without labels) with your custom forms.<!--[!code-python[Main](les\\\
v3.1\\sample_train_model_without_labels.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.1\\\\sample_train_model_without_labels.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.ai.formrecognizer\
- \ import FormTrainingClient\n from azure.core.credentials import AzureKeyCredential\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\
+ \\sample_train_model_without_labels.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.ai.formrecognizer import\
+ \ FormTrainingClient\n from azure.core.credentials import AzureKeyCredential\n\
\n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"\
AZURE_FORM_RECOGNIZER_KEY\"]\n container_sas_url = os.environ[\"CONTAINER_SAS_URL_V2\"\
]\n\n form_training_client = FormTrainingClient(endpoint, AzureKeyCredential(key))\n\
@@ -343,8 +348,9 @@ methods:
examples:
- "Delete a custom model.<!--[!code-python[Main](les\\v3.1\\sample_manage_custom_models.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\\sample_manage_custom_models.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\\sample_manage_custom_models.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n form_training_client.delete_model(model_id=custom_model.model_id)\n\n try:\n\
@@ -367,10 +373,11 @@ methods:
- "Get properties for the form recognizer account.<!--[!code-python[Main](les\\\
v3.1\\sample_manage_custom_models.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.1\\\\sample_manage_custom_models.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n form_training_client = FormTrainingClient(endpoint=endpoint,\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\
+ \\sample_manage_custom_models.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n form_training_client = FormTrainingClient(endpoint=endpoint,\
\ credential=AzureKeyCredential(key))\n # First, we see how many custom models\
\ we have, and what our limit is\n account_properties = form_training_client.get_account_properties()\n\
\ print(\"Our account has {} custom models, and we can have at most {} custom\
@@ -417,11 +424,12 @@ methods:
examples:
- "Authorize the target resource to receive the copied model<!--[!code-python[Main](les\\\
v3.1\\sample_copy_model.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\
- \\v3.1\\\\sample_copy_model.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n target_client = FormTrainingClient(endpoint=target_endpoint,\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\
+ \\sample_copy_model.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
+ : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
+ \n````python\n\n target_client = FormTrainingClient(endpoint=target_endpoint,\
\ credential=AzureKeyCredential(target_key))\n\n target = target_client.get_copy_authorization(\n\
\ resource_region=target_region,\n resource_id=target_resource_id\n\
\ )\n # model ID that target client will use to access the model once copy\
@@ -448,8 +456,9 @@ methods:
examples:
- "Get a custom model with a model ID.<!--[!code-python[Main](les\\v3.1\\sample_manage_custom_models.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\\sample_manage_custom_models.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\\sample_manage_custom_models.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n custom_model = form_training_client.get_custom_model(model_id=model.model_id)\n\
@@ -483,9 +492,10 @@ methods:
- "List model information for each model on the account.<!--[!code-python[Main](les\\\
v3.1\\sample_manage_custom_models.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.1\\\\sample_manage_custom_models.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n custom_models = form_training_client.list_custom_models()\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\
+ \\sample_manage_custom_models.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n custom_models = form_training_client.list_custom_models()\n\
\n print(\"We have models with the following IDs:\")\n for model_info in custom_models:\n\
\ print(model_info.model_id)\n\n ````\n"
diff --git a/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.aio.DocumentAnalysisClient.yml b/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.aio.DocumentAnalysisClient.yml
index a819161b7541..efe0191a4f0a 100644
--- a/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.aio.DocumentAnalysisClient.yml
+++ b/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.aio.DocumentAnalysisClient.yml
@@ -71,7 +71,8 @@ examples:
- "Creating the DocumentAnalysisClient with an endpoint and API key.<!--[!code-python[Main](les\\\
v3.2_and_later\\async_samples\\sample_authentication_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\":\
- \ [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
+ \ [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
\\samples\\\\v3.2_and_later\\\\async_samples\\\\sample_authentication_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
@@ -81,13 +82,14 @@ examples:
\ AzureKeyCredential(key))\n\n ````\n\nCreating the DocumentAnalysisClient with\
\ a token credential.<!--[!code-python[Main](les\\v3.2_and_later\\async_samples\\\
sample_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\
- \\v3.2_and_later\\\\async_samples\\\\sample_authentication_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
- \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n \"\"\"DefaultAzureCredential\
- \ will use the values from these environment\n variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,\
- \ AZURE_CLIENT_SECRET\n \"\"\"\n from azure.ai.formrecognizer.aio import DocumentAnalysisClient\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\\async_samples\\\
+ \\sample_authentication_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n \"\"\"DefaultAzureCredential will use the values\
+ \ from these environment\n variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET\n\
+ \ \"\"\"\n from azure.ai.formrecognizer.aio import DocumentAnalysisClient\n\
\ from azure.identity.aio import DefaultAzureCredential\n\n endpoint = os.environ[\"\
AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n credential = DefaultAzureCredential()\n\n\
\ document_analysis_client = DocumentAnalysisClient(endpoint, credential)\n\n\
@@ -152,36 +154,36 @@ methods:
- "Analyze an invoice. For more samples see the *samples* folder.<!--[!code-python[Main](les\\\
v3.2_and_later\\async_samples\\sample_analyze_invoices_async.py )]-->\n\n<!--\
\ literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [],\
- \ \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\\async_samples\\\
- \\sample_analyze_invoices_async.py\", \"xml:space\": \"preserve\", \"force\":\
- \ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
- \ from azure.ai.formrecognizer.aio import DocumentAnalysisClient\n\n endpoint\
- \ = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"\
- ]\n\n document_analysis_client = DocumentAnalysisClient(\n endpoint=endpoint,\
- \ credential=AzureKeyCredential(key)\n )\n async with document_analysis_client:\n\
- \ with open(path_to_sample_documents, \"rb\") as f:\n poller =\
- \ await document_analysis_client.begin_analyze_document(\n \"prebuilt-invoice\"\
- , document=f, locale=\"en-US\"\n )\n invoices = await poller.result()\n\
- \n for idx, invoice in enumerate(invoices.documents):\n print(f\"--------Analyzing\
- \ invoice #{idx + 1}--------\")\n vendor_name = invoice.fields.get(\"VendorName\"\
- )\n if vendor_name:\n print(\n f\"Vendor Name: {vendor_name.value}\
- \ has confidence: {vendor_name.confidence}\"\n )\n vendor_address\
- \ = invoice.fields.get(\"VendorAddress\")\n if vendor_address:\n \
- \ print(\n f\"Vendor Address: {vendor_address.value} has confidence:\
- \ {vendor_address.confidence}\"\n )\n vendor_address_recipient\
- \ = invoice.fields.get(\"VendorAddressRecipient\")\n if vendor_address_recipient:\n\
- \ print(\n f\"Vendor Address Recipient: {vendor_address_recipient.value}\
- \ has confidence: {vendor_address_recipient.confidence}\"\n )\n \
- \ customer_name = invoice.fields.get(\"CustomerName\")\n if customer_name:\n\
- \ print(\n f\"Customer Name: {customer_name.value} has\
- \ confidence: {customer_name.confidence}\"\n )\n customer_id =\
- \ invoice.fields.get(\"CustomerId\")\n if customer_id:\n print(\n\
- \ f\"Customer Id: {customer_id.value} has confidence: {customer_id.confidence}\"\
- \n )\n customer_address = invoice.fields.get(\"CustomerAddress\"\
- )\n if customer_address:\n print(\n f\"Customer\
- \ Address: {customer_address.value} has confidence: {customer_address.confidence}\"\
+ \ \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
+ \\samples\\\\v3.2_and_later\\\\async_samples\\\\sample_analyze_invoices_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.core.credentials import AzureKeyCredential\n from azure.ai.formrecognizer.aio\
+ \ import DocumentAnalysisClient\n\n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"\
+ ]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"]\n\n document_analysis_client\
+ \ = DocumentAnalysisClient(\n endpoint=endpoint, credential=AzureKeyCredential(key)\n\
+ \ )\n async with document_analysis_client:\n with open(path_to_sample_documents,\
+ \ \"rb\") as f:\n poller = await document_analysis_client.begin_analyze_document(\n\
+ \ \"prebuilt-invoice\", document=f, locale=\"en-US\"\n \
+ \ )\n invoices = await poller.result()\n\n for idx, invoice in enumerate(invoices.documents):\n\
+ \ print(f\"--------Analyzing invoice #{idx + 1}--------\")\n vendor_name\
+ \ = invoice.fields.get(\"VendorName\")\n if vendor_name:\n print(\n\
+ \ f\"Vendor Name: {vendor_name.value} has confidence: {vendor_name.confidence}\"\
+ \n )\n vendor_address = invoice.fields.get(\"VendorAddress\")\n\
+ \ if vendor_address:\n print(\n f\"Vendor Address:\
+ \ {vendor_address.value} has confidence: {vendor_address.confidence}\"\n \
+ \ )\n vendor_address_recipient = invoice.fields.get(\"VendorAddressRecipient\"\
+ )\n if vendor_address_recipient:\n print(\n f\"\
+ Vendor Address Recipient: {vendor_address_recipient.value} has confidence: {vendor_address_recipient.confidence}\"\
+ \n )\n customer_name = invoice.fields.get(\"CustomerName\")\n\
+ \ if customer_name:\n print(\n f\"Customer Name:\
+ \ {customer_name.value} has confidence: {customer_name.confidence}\"\n \
+ \ )\n customer_id = invoice.fields.get(\"CustomerId\")\n if customer_id:\n\
+ \ print(\n f\"Customer Id: {customer_id.value} has confidence:\
+ \ {customer_id.confidence}\"\n )\n customer_address = invoice.fields.get(\"\
+ CustomerAddress\")\n if customer_address:\n print(\n \
+ \ f\"Customer Address: {customer_address.value} has confidence: {customer_address.confidence}\"\
\n )\n customer_address_recipient = invoice.fields.get(\"CustomerAddressRecipient\"\
)\n if customer_address_recipient:\n print(\n f\"\
Customer Address Recipient: {customer_address_recipient.value} has confidence:\
@@ -266,15 +268,15 @@ methods:
\ a custom document. For more samples see the *samples* folder.<!--[!code-python[Main](les\\\
v3.2_and_later\\async_samples\\sample_analyze_custom_documents_async.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\\async_samples\\\
- \\sample_analyze_custom_documents_async.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.formrecognizer.aio import DocumentAnalysisClient\n\
- \n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"\
- AZURE_FORM_RECOGNIZER_KEY\"]\n model_id = os.getenv(\"CUSTOM_BUILT_MODEL_ID\"\
- , custom_model_id)\n\n document_analysis_client = DocumentAnalysisClient(\n\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
+ \\samples\\\\v3.2_and_later\\\\async_samples\\\\sample_analyze_custom_documents_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.core.credentials import AzureKeyCredential\n from azure.ai.formrecognizer.aio\
+ \ import DocumentAnalysisClient\n\n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"\
+ ]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"]\n model_id = os.getenv(\"\
+ CUSTOM_BUILT_MODEL_ID\", custom_model_id)\n\n document_analysis_client = DocumentAnalysisClient(\n\
\ endpoint=endpoint, credential=AzureKeyCredential(key)\n )\n\n async\
\ with document_analysis_client:\n # Make sure your document's type is included\
\ in the list of document types the custom model can analyze\n with open(path_to_sample_documents,\
@@ -365,16 +367,16 @@ methods:
- "Analyze a receipt. For more samples see the *samples* folder.<!--[!code-python[Main](les\\\
v3.2_and_later\\async_samples\\sample_analyze_receipts_from_url_async.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\\async_samples\\\
- \\sample_analyze_receipts_from_url_async.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.formrecognizer.aio import DocumentAnalysisClient\n\
- \n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"\
- AZURE_FORM_RECOGNIZER_KEY\"]\n\n document_analysis_client = DocumentAnalysisClient(\n\
- \ endpoint=endpoint, credential=AzureKeyCredential(key)\n )\n async\
- \ with document_analysis_client:\n url = \"https://raw.githubusercontent.com/Azure/azure-sdk-for-python/main/sdk/formrecognizer/azure-ai-formrecognizer/tests/sample_forms/receipt/contoso-receipt.png\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
+ \\samples\\\\v3.2_and_later\\\\async_samples\\\\sample_analyze_receipts_from_url_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.core.credentials import AzureKeyCredential\n from azure.ai.formrecognizer.aio\
+ \ import DocumentAnalysisClient\n\n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"\
+ ]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"]\n\n document_analysis_client\
+ \ = DocumentAnalysisClient(\n endpoint=endpoint, credential=AzureKeyCredential(key)\n\
+ \ )\n async with document_analysis_client:\n url = \"https://raw.githubusercontent.com/Azure/azure-sdk-for-python/main/sdk/formrecognizer/azure-ai-formrecognizer/tests/sample_forms/receipt/contoso-receipt.png\"\
\n poller = await document_analysis_client.begin_analyze_document_from_url(\n\
\ \"prebuilt-receipt\", document_url=url\n )\n receipts\
\ = await poller.result()\n\n for idx, receipt in enumerate(receipts.documents):\n\
@@ -448,17 +450,18 @@ methods:
- "Classify a document. For more samples see the *samples* folder.<!--[!code-python[Main](les\\\
v3.2_and_later\\async_samples\\sample_classify_document_async.py )]-->\n\n<!--\
\ literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [],\
- \ \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\\async_samples\\\
- \\sample_classify_document_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
- \ from azure.ai.formrecognizer.aio import DocumentAnalysisClient\n\n endpoint\
- \ = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"\
- ]\n classifier_id = os.getenv(\"CLASSIFIER_ID\", classifier_id)\n\n document_analysis_client\
- \ = DocumentAnalysisClient(\n endpoint=endpoint, credential=AzureKeyCredential(key)\n\
- \ )\n async with document_analysis_client:\n with open(path_to_sample_documents,\
- \ \"rb\") as f:\n poller = await document_analysis_client.begin_classify_document(\n\
+ \ \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
+ \\samples\\\\v3.2_and_later\\\\async_samples\\\\sample_classify_document_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.core.credentials import AzureKeyCredential\n from azure.ai.formrecognizer.aio\
+ \ import DocumentAnalysisClient\n\n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"\
+ ]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"]\n classifier_id = os.getenv(\"\
+ CLASSIFIER_ID\", classifier_id)\n\n document_analysis_client = DocumentAnalysisClient(\n\
+ \ endpoint=endpoint, credential=AzureKeyCredential(key)\n )\n async\
+ \ with document_analysis_client:\n with open(path_to_sample_documents, \"\
+ rb\") as f:\n poller = await document_analysis_client.begin_classify_document(\n\
\ classifier_id, document=f\n )\n result = await\
\ poller.result()\n\n print(\"----Classified documents----\")\n for doc in\
\ result.documents:\n print(\n f\"Found document of type '{doc.doc_type\
@@ -507,17 +510,17 @@ methods:
- "Classify a document. For more samples see the *samples* folder.<!--[!code-python[Main](les\\\
v3.2_and_later\\async_samples\\sample_classify_document_from_url_async.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\\async_samples\\\
- \\sample_classify_document_from_url_async.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.formrecognizer.aio import DocumentAnalysisClient\n\
- \n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"\
- AZURE_FORM_RECOGNIZER_KEY\"]\n classifier_id = os.getenv(\"CLASSIFIER_ID\",\
- \ classifier_id)\n\n document_analysis_client = DocumentAnalysisClient(\n \
- \ endpoint=endpoint, credential=AzureKeyCredential(key)\n )\n async with\
- \ document_analysis_client:\n url = \"https://raw.githubusercontent.com/Azure/azure-sdk-for-python/main/sdk/formrecognizer/azure-ai-formrecognizer/tests/sample_forms/forms/IRS-1040.pdf\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
+ \\samples\\\\v3.2_and_later\\\\async_samples\\\\sample_classify_document_from_url_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.core.credentials import AzureKeyCredential\n from azure.ai.formrecognizer.aio\
+ \ import DocumentAnalysisClient\n\n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"\
+ ]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"]\n classifier_id = os.getenv(\"\
+ CLASSIFIER_ID\", classifier_id)\n\n document_analysis_client = DocumentAnalysisClient(\n\
+ \ endpoint=endpoint, credential=AzureKeyCredential(key)\n )\n async\
+ \ with document_analysis_client:\n url = \"https://raw.githubusercontent.com/Azure/azure-sdk-for-python/main/sdk/formrecognizer/azure-ai-formrecognizer/tests/sample_forms/forms/IRS-1040.pdf\"\
\n\n poller = await document_analysis_client.begin_classify_document_from_url(\n\
\ classifier_id, document_url=url\n )\n result = await poller.result()\n\
\n print(\"----Classified documents----\")\n for doc in result.documents:\n\
diff --git a/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.aio.DocumentModelAdministrationClient.yml b/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.aio.DocumentModelAdministrationClient.yml
index b475a2a40733..3a9db2526962 100644
--- a/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.aio.DocumentModelAdministrationClient.yml
+++ b/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.aio.DocumentModelAdministrationClient.yml
@@ -72,7 +72,8 @@ examples:
- "Creating the DocumentModelAdministrationClient with an endpoint and API key.<!--[!code-python[Main](les\\\
v3.2_and_later\\async_samples\\sample_authentication_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\":\
- \ [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
+ \ [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
\\samples\\\\v3.2_and_later\\\\async_samples\\\\sample_authentication_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
@@ -82,13 +83,14 @@ examples:
\ endpoint, AzureKeyCredential(key)\n )\n\n ````\n\nCreating the DocumentModelAdministrationClient\
\ with a token credential.<!--[!code-python[Main](les\\v3.2_and_later\\async_samples\\\
sample_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\
- \\v3.2_and_later\\\\async_samples\\\\sample_authentication_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
- \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n \"\"\"DefaultAzureCredential\
- \ will use the values from these environment\n variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,\
- \ AZURE_CLIENT_SECRET\n \"\"\"\n from azure.ai.formrecognizer.aio import DocumentModelAdministrationClient\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\\async_samples\\\
+ \\sample_authentication_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n \"\"\"DefaultAzureCredential will use the values\
+ \ from these environment\n variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET\n\
+ \ \"\"\"\n from azure.ai.formrecognizer.aio import DocumentModelAdministrationClient\n\
\ from azure.identity.aio import DefaultAzureCredential\n\n endpoint = os.environ[\"\
AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n credential = DefaultAzureCredential()\n\n\
\ document_model_admin_client = DocumentModelAdministrationClient(\n endpoint,\
@@ -135,16 +137,16 @@ methods:
- "Build a document classifier.<!--[!code-python[Main](les\\v3.2_and_later\\async_samples\\\
sample_build_classifier_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.2_and_later\\\\async_samples\\\\sample_build_classifier_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n import os\n from azure.ai.formrecognizer.aio import DocumentModelAdministrationClient\n\
- \ from azure.ai.formrecognizer import (\n ClassifierDocumentTypeDetails,\n\
- \ BlobSource,\n BlobFileListSource,\n )\n from azure.core.credentials\
- \ import AzureKeyCredential\n\n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"\
- ]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"]\n container_sas_url =\
- \ os.environ[\"CLASSIFIER_CONTAINER_SAS_URL\"]\n\n document_model_admin_client\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\
+ \\async_samples\\\\sample_build_classifier_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.ai.formrecognizer.aio\
+ \ import DocumentModelAdministrationClient\n from azure.ai.formrecognizer import\
+ \ (\n ClassifierDocumentTypeDetails,\n BlobSource,\n BlobFileListSource,\n\
+ \ )\n from azure.core.credentials import AzureKeyCredential\n\n endpoint\
+ \ = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"\
+ ]\n container_sas_url = os.environ[\"CLASSIFIER_CONTAINER_SAS_URL\"]\n\n document_model_admin_client\
\ = DocumentModelAdministrationClient(\n endpoint=endpoint, credential=AzureKeyCredential(key)\n\
\ )\n\n async with document_model_admin_client:\n poller = await document_model_admin_client.begin_build_document_classifier(\n\
\ doc_types={\n \"IRS-1040-A\": ClassifierDocumentTypeDetails(\n\
@@ -254,16 +256,17 @@ methods:
- "Building a model from training files.<!--[!code-python[Main](les\\v3.2_and_later\\\
async_samples\\sample_build_model_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.2_and_later\\\\async_samples\\\\sample_build_model_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.ai.formrecognizer.aio import DocumentModelAdministrationClient\n\
- \ from azure.ai.formrecognizer import ModelBuildMode\n from azure.core.credentials\
- \ import AzureKeyCredential\n\n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"\
- ]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"]\n container_sas_url =\
- \ os.environ[\"CONTAINER_SAS_URL\"]\n\n document_model_admin_client = DocumentModelAdministrationClient(\n\
- \ endpoint, AzureKeyCredential(key)\n )\n async with document_model_admin_client:\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\
+ \\async_samples\\\\sample_build_model_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.ai.formrecognizer.aio\
+ \ import DocumentModelAdministrationClient\n from azure.ai.formrecognizer import\
+ \ ModelBuildMode\n from azure.core.credentials import AzureKeyCredential\n\n\
+ \ endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"\
+ AZURE_FORM_RECOGNIZER_KEY\"]\n container_sas_url = os.environ[\"CONTAINER_SAS_URL\"\
+ ]\n\n document_model_admin_client = DocumentModelAdministrationClient(\n \
+ \ endpoint, AzureKeyCredential(key)\n )\n async with document_model_admin_client:\n\
\ poller = await document_model_admin_client.begin_build_document_model(\n\
\ ModelBuildMode.TEMPLATE,\n blob_container_url=container_sas_url,\n\
\ description=\"my model description\",\n )\n model = await\
@@ -324,7 +327,8 @@ methods:
- "Creating a composed model with existing models.<!--[!code-python[Main](les\\\
v3.2_and_later\\async_samples\\sample_compose_model_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
\\samples\\\\v3.2_and_later\\\\async_samples\\\\sample_compose_model_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
@@ -410,7 +414,8 @@ methods:
- "Copy a model from the source resource to the target resource<!--[!code-python[Main](les\\\
v3.2_and_later\\async_samples\\sample_copy_model_to_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
\\samples\\\\v3.2_and_later\\\\async_samples\\\\sample_copy_model_to_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
@@ -467,15 +472,15 @@ methods:
- "Delete a classifier.<!--[!code-python[Main](les\\v3.2_and_later\\async_samples\\\
sample_manage_classifiers_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.2_and_later\\\\async_samples\\\\sample_manage_classifiers_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n await document_model_admin_client.delete_document_classifier(\n classifier_id=my_classifier.classifier_id\n\
- \ )\n\n try:\n await document_model_admin_client.get_document_classifier(\n\
- \ classifier_id=my_classifier.classifier_id\n )\n except ResourceNotFoundError:\n\
- \ print(\n f\"Successfully deleted classifier with ID {my_classifier.classifier_id}\"\
- \n )\n\n ````\n"
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\
+ \\async_samples\\\\sample_manage_classifiers_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n await document_model_admin_client.delete_document_classifier(\n\
+ \ classifier_id=my_classifier.classifier_id\n )\n\n try:\n await\
+ \ document_model_admin_client.get_document_classifier(\n classifier_id=my_classifier.classifier_id\n\
+ \ )\n except ResourceNotFoundError:\n print(\n f\"Successfully\
+ \ deleted classifier with ID {my_classifier.classifier_id}\"\n )\n\n ````\n"
- uid: azure.ai.formrecognizer.aio.DocumentModelAdministrationClient.delete_document_model
name: delete_document_model
summary: Delete a custom document model.
@@ -496,11 +501,12 @@ methods:
examples:
- "Delete a model.<!--[!code-python[Main](les\\v3.2_and_later\\async_samples\\sample_manage_models_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\
- \\async_samples\\\\sample_manage_models_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n await document_model_admin_client.delete_document_model(\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\\async_samples\\\
+ \\sample_manage_models_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n await document_model_admin_client.delete_document_model(\n\
\ model_id=my_model.model_id\n )\n\n try:\n await document_model_admin_client.get_document_model(\n\
\ model_id=my_model.model_id\n )\n except ResourceNotFoundError:\n\
\ print(f\"Successfully deleted model with ID {my_model.model_id}\")\n\n\
@@ -570,11 +576,11 @@ methods:
- "Get a classifier by its ID.<!--[!code-python[Main](les\\v3.2_and_later\\async_samples\\\
sample_manage_classifiers_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.2_and_later\\\\async_samples\\\\sample_manage_classifiers_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n my_classifier = await document_model_admin_client.get_document_classifier(\n\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\
+ \\async_samples\\\\sample_manage_classifiers_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n my_classifier = await document_model_admin_client.get_document_classifier(\n\
\ classifier_id=classifier_model.classifier_id\n )\n print(f\"\\nClassifier\
\ ID: {my_classifier.classifier_id}\")\n print(f\"Description: {my_classifier.description}\"\
)\n print(f\"Classifier created on: {my_classifier.created_on}\")\n\n ````\n"
@@ -598,15 +604,16 @@ methods:
examples:
- "Get a model by its ID.<!--[!code-python[Main](les\\v3.2_and_later\\async_samples\\\
sample_manage_models_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\
- \\v3.2_and_later\\\\async_samples\\\\sample_manage_models_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n my_model =\
- \ await document_model_admin_client.get_document_model(\n model_id=model.model_id\n\
- \ )\n print(f\"\\nModel ID: {my_model.model_id}\")\n print(f\"Description:\
- \ {my_model.description}\")\n print(f\"Model created on: {my_model.created_on}\"\
- )\n print(f\"Model expires on: {my_model.expires_on}\")\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\
+ \\async_samples\\\\sample_manage_models_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n my_model = await document_model_admin_client.get_document_model(\n\
+ \ model_id=model.model_id\n )\n print(f\"\\nModel ID: {my_model.model_id}\"\
+ )\n print(f\"Description: {my_model.description}\")\n print(f\"Model created\
+ \ on: {my_model.created_on}\")\n print(f\"Model expires on: {my_model.expires_on}\"\
+ )\n\n ````\n"
- uid: azure.ai.formrecognizer.aio.DocumentModelAdministrationClient.get_operation
name: get_operation
summary: 'Get an operation by its ID.
@@ -637,7 +644,8 @@ methods:
- "Get a document model operation by its ID.<!--[!code-python[Main](les\\v3.2_and_later\\\
async_samples\\sample_get_operations_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
\\samples\\\\v3.2_and_later\\\\async_samples\\\\sample_get_operations_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
@@ -670,7 +678,8 @@ methods:
- "Get model counts and limits under the Form Recognizer resource.<!--[!code-python[Main](les\\\
v3.2_and_later\\async_samples\\sample_manage_models_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
\\samples\\\\v3.2_and_later\\\\async_samples\\\\sample_manage_models_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
@@ -704,12 +713,13 @@ methods:
- "List all classifiers that were built successfully under the Form Recognizer resource.<!--[!code-python[Main](les\\\
v3.2_and_later\\async_samples\\sample_manage_classifiers_async.py )]-->\n\n<!--\
\ literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [],\
- \ \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.2_and_later\\\\async_samples\\\
- \\sample_manage_classifiers_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n classifiers = document_model_admin_client.list_document_classifiers()\n\
- \n print(\"We have the following 'ready' models with IDs and descriptions:\"\
+ \ \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
+ \\samples\\\\v3.2_and_later\\\\async_samples\\\\sample_manage_classifiers_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n classifiers = document_model_admin_client.list_document_classifiers()\n\n\
+ \ print(\"We have the following 'ready' models with IDs and descriptions:\"\
)\n async for classifier in classifiers:\n print(f\"{classifier.classifier_id}\
\ | {classifier.description}\")\n\n ````\n"
- uid: azure.ai.formrecognizer.aio.DocumentModelAdministrationClient.list_document_models
@@ -728,7 +738,8 @@ methods:
- "List all models that were built successfully under the Form Recognizer resource.<!--[!code-python[Main](les\\\
v3.2_and_later\\async_samples\\sample_manage_models_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
\\samples\\\\v3.2_and_later\\\\async_samples\\\\sample_manage_models_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
@@ -760,7 +771,8 @@ methods:
- "List all document model operations in the past 24 hours.<!--[!code-python[Main](les\\\
v3.2_and_later\\async_samples\\sample_get_operations_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
\\samples\\\\v3.2_and_later\\\\async_samples\\\\sample_get_operations_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
diff --git a/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.aio.FormRecognizerClient.yml b/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.aio.FormRecognizerClient.yml
index 2aa256e43b06..18abeb434917 100644
--- a/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.aio.FormRecognizerClient.yml
+++ b/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.aio.FormRecognizerClient.yml
@@ -65,7 +65,8 @@ examples:
- "Creating the FormRecognizerClient with an endpoint and API key.<!--[!code-python[Main](les\\\
v3.1\\async_samples\\sample_authentication_v3_1_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\":\
- \ [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
+ \ [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
\\samples\\\\v3.1\\\\async_samples\\\\sample_authentication_v3_1_async.py\", \"\
xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
@@ -75,9 +76,10 @@ examples:
\ AzureKeyCredential(key))\n\n ````\n\nCreating the FormRecognizerClient with\
\ a token credential.<!--[!code-python[Main](les\\v3.1\\async_samples\\sample_authentication_v3_1_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\\async_samples\\\\sample_authentication_v3_1_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
+ \\samples\\\\v3.1\\\\async_samples\\\\sample_authentication_v3_1_async.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n \"\"\"DefaultAzureCredential\
\ will use the values from these environment\n variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,\
\ AZURE_CLIENT_SECRET\n \"\"\"\n from azure.ai.formrecognizer.aio import FormRecognizerClient\n\
@@ -158,16 +160,17 @@ methods:
- "Recognize business cards from a file.<!--[!code-python[Main](les\\v3.1\\async_samples\\\
sample_recognize_business_cards_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.1\\\\async_samples\\\\sample_recognize_business_cards_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.core.credentials import AzureKeyCredential\n from azure.ai.formrecognizer.aio\
- \ import FormRecognizerClient\n\n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"\
- ]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"]\n\n form_recognizer_client\
- \ = FormRecognizerClient(\n endpoint=endpoint, credential=AzureKeyCredential(key)\n\
- \ )\n async with form_recognizer_client:\n with open(path_to_sample_forms,\
- \ \"rb\") as f:\n poller = await form_recognizer_client.begin_recognize_business_cards(business_card=f,\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\
+ \\async_samples\\\\sample_recognize_business_cards_async.py\", \"xml:space\":\
+ \ \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
+ \ import AzureKeyCredential\n from azure.ai.formrecognizer.aio import FormRecognizerClient\n\
+ \n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"\
+ AZURE_FORM_RECOGNIZER_KEY\"]\n\n form_recognizer_client = FormRecognizerClient(\n\
+ \ endpoint=endpoint, credential=AzureKeyCredential(key)\n )\n async\
+ \ with form_recognizer_client:\n with open(path_to_sample_forms, \"rb\"\
+ ) as f:\n poller = await form_recognizer_client.begin_recognize_business_cards(business_card=f,\
\ locale=\"en-US\")\n business_cards = await poller.result()\n\n for idx,\
\ business_card in enumerate(business_cards):\n print(\"--------Recognizing\
\ business card #{}--------\".format(idx+1))\n contact_names = business_card.fields.get(\"\
@@ -350,7 +353,8 @@ methods:
- "Recognize text and content/layout information from a form.<!--[!code-python[Main](les\\\
v3.1\\async_samples\\sample_recognize_content_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
\\samples\\\\v3.1\\\\async_samples\\\\sample_recognize_content_async.py\", \"\
xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
@@ -523,7 +527,8 @@ methods:
- "Recognize fields and values from a custom form.<!--[!code-python[Main](les\\\
v3.1\\async_samples\\sample_recognize_custom_forms_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
\\samples\\\\v3.1\\\\async_samples\\\\sample_recognize_custom_forms_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
@@ -689,7 +694,8 @@ methods:
- "Recognize identity documents from a file.<!--[!code-python[Main](les\\v3.1\\\
async_samples\\sample_recognize_identity_documents_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
\\samples\\\\v3.1\\\\async_samples\\\\sample_recognize_identity_documents_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
@@ -847,10 +853,11 @@ methods:
- "Recognize invoices from a file.<!--[!code-python[Main](les\\v3.1\\async_samples\\\
sample_recognize_invoices_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.1\\\\async_samples\\\\sample_recognize_invoices_async.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\
+ \\async_samples\\\\sample_recognize_invoices_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
\ import AzureKeyCredential\n from azure.ai.formrecognizer.aio import FormRecognizerClient\n\
\n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"\
AZURE_FORM_RECOGNIZER_KEY\"]\n\n async with FormRecognizerClient(\n endpoint=endpoint,\
@@ -1082,10 +1089,11 @@ methods:
- "Recognize sales receipt fields.<!--[!code-python[Main](les\\v3.1\\async_samples\\\
sample_recognize_receipts_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.1\\\\async_samples\\\\sample_recognize_receipts_async.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\
+ \\async_samples\\\\sample_recognize_receipts_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
\ import AzureKeyCredential\n from azure.ai.formrecognizer.aio import FormRecognizerClient\n\
\n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"\
AZURE_FORM_RECOGNIZER_KEY\"]\n\n async with FormRecognizerClient(\n endpoint=endpoint,\
@@ -1189,7 +1197,8 @@ methods:
- "Recognize sales receipt fields from a URL.<!--[!code-python[Main](les\\v3.1\\\
async_samples\\sample_recognize_receipts_from_url_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
\\samples\\\\v3.1\\\\async_samples\\\\sample_recognize_receipts_from_url_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
diff --git a/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.aio.FormTrainingClient.yml b/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.aio.FormTrainingClient.yml
index 054e2465f4f0..27dd5e0bb94e 100644
--- a/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.aio.FormTrainingClient.yml
+++ b/docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.aio.FormTrainingClient.yml
@@ -62,7 +62,8 @@ examples:
- "Creating the FormTrainingClient with an endpoint and API key.<!--[!code-python[Main](les\\\
v3.1\\async_samples\\sample_authentication_v3_1_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\":\
- \ [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
+ \ [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
\\samples\\\\v3.1\\\\async_samples\\\\sample_authentication_v3_1_async.py\", \"\
xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
@@ -72,9 +73,10 @@ examples:
\ AzureKeyCredential(key))\n\n ````\n\nCreating the FormTrainingClient with a\
\ token credential.<!--[!code-python[Main](les\\v3.1\\async_samples\\sample_authentication_v3_1_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\\async_samples\\\\sample_authentication_v3_1_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
+ \\samples\\\\v3.1\\\\async_samples\\\\sample_authentication_v3_1_async.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n \"\"\"DefaultAzureCredential\
\ will use the values from these environment\n variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,\
\ AZURE_CLIENT_SECRET\n \"\"\"\n from azure.ai.formrecognizer.aio import FormTrainingClient\n\
@@ -126,7 +128,8 @@ methods:
- "Copy a model from the source resource to the target resource<!--[!code-python[Main](les\\\
v3.1\\async_samples\\sample_copy_model_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
\\samples\\\\v3.1\\\\async_samples\\\\sample_copy_model_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n source_client\
@@ -179,14 +182,14 @@ methods:
examples:
- "Create a composed model<!--[!code-python[Main](les\\v3.1\\async_samples\\sample_create_composed_model_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\\async_samples\\\
- \\sample_create_composed_model_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
- \ from azure.ai.formrecognizer.aio import FormTrainingClient\n\n endpoint\
- \ = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"\
- ]\n po_supplies = os.environ['PURCHASE_ORDER_OFFICE_SUPPLIES_SAS_URL_V2']\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\\async_samples\\\\sample_create_composed_model_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.core.credentials import AzureKeyCredential\n from azure.ai.formrecognizer.aio\
+ \ import FormTrainingClient\n\n endpoint = os.environ[\"AZURE_FORM_RECOGNIZER_ENDPOINT\"\
+ ]\n key = os.environ[\"AZURE_FORM_RECOGNIZER_KEY\"]\n po_supplies = os.environ['PURCHASE_ORDER_OFFICE_SUPPLIES_SAS_URL_V2']\n\
\ po_equipment = os.environ['PURCHASE_ORDER_OFFICE_EQUIPMENT_SAS_URL_V2']\n\
\ po_furniture = os.environ['PURCHASE_ORDER_OFFICE_FURNITURE_SAS_URL_V2']\n\
\ po_cleaning_supplies = os.environ['PURCHASE_ORDER_OFFICE_CLEANING_SUPPLIES_SAS_URL_V2']\n\
@@ -302,8 +305,9 @@ methods:
- "Training a model (without labels) with your custom forms.<!--[!code-python[Main](les\\\
v3.1\\async_samples\\sample_train_model_without_labels_async.py )]-->\n\n<!--\
\ literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [],\
- \ \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\\async_samples\\\\sample_train_model_without_labels_async.py\"\
+ \ \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
+ \\samples\\\\v3.1\\\\async_samples\\\\sample_train_model_without_labels_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.ai.formrecognizer.aio import FormTrainingClient\n from azure.core.credentials\
@@ -349,11 +353,12 @@ methods:
examples:
- "Delete a custom model.<!--[!code-python[Main](les\\v3.1\\async_samples\\sample_manage_custom_models_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\\async_samples\\\
- \\sample_manage_custom_models_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n await form_training_client.delete_model(model_id=custom_model.model_id)\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\\async_samples\\\\sample_manage_custom_models_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n await form_training_client.delete_model(model_id=custom_model.model_id)\n\
\n try:\n await form_training_client.get_custom_model(model_id=custom_model.model_id)\n\
\ except ResourceNotFoundError:\n print(\"Successfully deleted model with\
\ id {}\".format(custom_model.model_id))\n\n ````\n"
@@ -373,7 +378,8 @@ methods:
- "Get properties for the form recognizer account.<!--[!code-python[Main](les\\\
v3.1\\async_samples\\sample_manage_custom_models_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
\\samples\\\\v3.1\\\\async_samples\\\\sample_manage_custom_models_async.py\",\
\ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
@@ -425,7 +431,8 @@ methods:
- "Authorize the target resource to receive the copied model<!--[!code-python[Main](les\\\
v3.1\\async_samples\\sample_copy_model_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
\\samples\\\\v3.1\\\\async_samples\\\\sample_copy_model_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n target_client\
@@ -458,11 +465,11 @@ methods:
- "Get a custom model with a model ID.<!--[!code-python[Main](les\\v3.1\\async_samples\\\
sample_manage_custom_models_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
- \\samples\\\\v3.1\\\\async_samples\\\\sample_manage_custom_models_async.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n custom_model = await form_training_client.get_custom_model(model_id=model_info.model_id)\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\\samples\\\\v3.1\\\
+ \\async_samples\\\\sample_manage_custom_models_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n custom_model = await form_training_client.get_custom_model(model_id=model_info.model_id)\n\
\ print(\"\\nModel ID: {}\".format(custom_model.model_id))\n print(\"Status:\
\ {}\".format(custom_model.status))\n print(\"Model name: {}\".format(custom_model.model_name))\n\
\ print(\"Is this a composed model?: {}\".format(custom_model.properties.is_composed_model))\n\
@@ -493,7 +500,8 @@ methods:
- "List model information for each model on the account.<!--[!code-python[Main](les\\\
v3.1\\async_samples\\sample_manage_custom_models_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\6\\\\azure-ai-formrecognizer-3.3.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure-ai-formrecognizer-3.3.0\\\
\\samples\\\\v3.1\\\\async_samples\\\\sample_manage_custom_models_async.py\",\
\ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
diff --git a/docs-ref-autogen/azure-ai-language-questionanswering/azure.ai.language.questionanswering.QuestionAnsweringClient.yml b/docs-ref-autogen/azure-ai-language-questionanswering/azure.ai.language.questionanswering.QuestionAnsweringClient.yml
index 9f5a64df0754..fd36a52ddeac 100644
--- a/docs-ref-autogen/azure-ai-language-questionanswering/azure.ai.language.questionanswering.QuestionAnsweringClient.yml
+++ b/docs-ref-autogen/azure-ai-language-questionanswering/azure.ai.language.questionanswering.QuestionAnsweringClient.yml
@@ -130,11 +130,12 @@ methods:
examples:
- "Answer the specified question using your knowledge base.<!--[!code-python[Main](les\\\
sample_query_knowledgebase.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\8\\\\azure-ai-language-questionanswering-1.1.0\\\
- \\samples\\\\sample_query_knowledgebase.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\7\\\\azure-ai-language-questionanswering-1.1.0\\\\\
+ samples\\\\sample_query_knowledgebase.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
\ import AzureKeyCredential\n from azure.ai.language.questionanswering import\
\ QuestionAnsweringClient\n from azure.ai.language.questionanswering import\
\ models as qna\n\n endpoint = os.environ[\"AZURE_QUESTIONANSWERING_ENDPOINT\"\
@@ -192,14 +193,15 @@ methods:
examples:
- "Answers the specified question using the provided text.<!--[!code-python[Main](les\\\
sample_query_text.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
- \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\\
- _work\\\\1\\\\s\\\\dist_temp\\\\8\\\\azure-ai-language-questionanswering-1.1.0\\\
- \\samples\\\\sample_query_text.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n import os\n from azure.core.credentials import\
- \ AzureKeyCredential\n from azure.ai.language.questionanswering import QuestionAnsweringClient\n\
- \ from azure.ai.language.questionanswering import models as qna\n\n endpoint\
- \ = os.environ[\"AZURE_QUESTIONANSWERING_ENDPOINT\"]\n key = os.environ[\"AZURE_QUESTIONANSWERING_KEY\"\
+ \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\7\\\\azure-ai-language-questionanswering-1.1.0\\\\samples\\\\sample_query_text.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n import os\n from azure.core.credentials import AzureKeyCredential\n from\
+ \ azure.ai.language.questionanswering import QuestionAnsweringClient\n from\
+ \ azure.ai.language.questionanswering import models as qna\n\n endpoint = os.environ[\"\
+ AZURE_QUESTIONANSWERING_ENDPOINT\"]\n key = os.environ[\"AZURE_QUESTIONANSWERING_KEY\"\
]\n\n client = QuestionAnsweringClient(endpoint, AzureKeyCredential(key))\n\
\ with client:\n question=\"How long it takes to charge surface?\"\n \
\ input = qna.AnswersFromTextOptions(\n question=question,\n \
diff --git a/docs-ref-autogen/azure-ai-language-questionanswering/azure.ai.language.questionanswering.aio.QuestionAnsweringClient.yml b/docs-ref-autogen/azure-ai-language-questionanswering/azure.ai.language.questionanswering.aio.QuestionAnsweringClient.yml
index 41ae419a6276..fe365beef810 100644
--- a/docs-ref-autogen/azure-ai-language-questionanswering/azure.ai.language.questionanswering.aio.QuestionAnsweringClient.yml
+++ b/docs-ref-autogen/azure-ai-language-questionanswering/azure.ai.language.questionanswering.aio.QuestionAnsweringClient.yml
@@ -131,7 +131,8 @@ methods:
- "Answer the specified question using your knowledge base.<!--[!code-python[Main](les\\\
async_samples\\sample_query_knowledgebase_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\8\\\\azure-ai-language-questionanswering-1.1.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\7\\\\azure-ai-language-questionanswering-1.1.0\\\
\\samples\\\\async_samples\\\\sample_query_knowledgebase_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -192,13 +193,14 @@ methods:
- "Answers the specified question using the provided text.<!--[!code-python[Main](les\\\
async_samples\\sample_query_text_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\8\\\\azure-ai-language-questionanswering-1.1.0\\\
- \\samples\\\\async_samples\\\\sample_query_text_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from\
- \ azure.core.credentials import AzureKeyCredential\n from azure.ai.language.questionanswering.aio\
- \ import QuestionAnsweringClient\n from azure.ai.language.questionanswering\
- \ import models as qna\n\n endpoint = os.environ[\"AZURE_QUESTIONANSWERING_ENDPOINT\"\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\7\\\\azure-ai-language-questionanswering-1.1.0\\\\\
+ samples\\\\async_samples\\\\sample_query_text_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
+ \ import AzureKeyCredential\n from azure.ai.language.questionanswering.aio import\
+ \ QuestionAnsweringClient\n from azure.ai.language.questionanswering import\
+ \ models as qna\n\n endpoint = os.environ[\"AZURE_QUESTIONANSWERING_ENDPOINT\"\
]\n key = os.environ[\"AZURE_QUESTIONANSWERING_KEY\"]\n\n client = QuestionAnsweringClient(endpoint,\
\ AzureKeyCredential(key))\n async with client:\n input = qna.AnswersFromTextOptions(\n\
\ question=\"How long it takes to charge surface?\",\n text_documents=[\n\
diff --git a/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.yml b/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.yml
index 4f44cec52795..7500dee699c1 100644
--- a/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.yml
+++ b/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.yml
@@ -31,16 +31,17 @@ constructor:
examples:
- "Authenticate MetricsAdvisorAdministrationClient with a MetricsAdvisorKeyCredential<!--[!code-python[Main](les\\\
sample_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\":\
- \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\
- \\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
- language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false}\
- \ -->\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"
+ \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_authentication.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\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
@@ -89,8 +90,9 @@ methods:
examples:
- "Create an anomaly alert configuration<!--[!code-python[Main](les\\sample_alert_configuration.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_alert_configuration.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_alert_configuration.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\
@@ -210,14 +212,14 @@ methods:
examples:
- "Create a data feed<!--[!code-python[Main](les\\sample_data_feeds.py )]-->\n\n\
<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_data_feeds.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\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\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\
+ \\samples\\\\sample_data_feeds.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\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\"\
@@ -261,8 +263,9 @@ methods:
examples:
- "Create a datasource credential<!--[!code-python[Main](les\\sample_datasource_credentials.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_datasource_credentials.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_datasource_credentials.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\
@@ -320,8 +323,9 @@ methods:
examples:
- "Create an anomaly detection configuration<!--[!code-python[Main](les\\sample_detection_configuration.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_detection_configuration.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_detection_configuration.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\
@@ -369,19 +373,20 @@ methods:
examples:
- "Create a notification hook<!--[!code-python[Main](les\\sample_hooks.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_hooks.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\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\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\
+ \\samples\\\\sample_hooks.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\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
@@ -402,13 +407,14 @@ methods:
examples:
- "Delete an anomaly alert configuration by its ID<!--[!code-python[Main](les\\\
sample_alert_configuration.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\
- \\sample_alert_configuration.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\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\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_alert_configuration.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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,\
@@ -434,15 +440,15 @@ methods:
examples:
- "Delete a data feed by its ID<!--[!code-python[Main](les\\sample_data_feeds.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_data_feeds.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_data_feeds.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\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.\"\
@@ -466,8 +472,9 @@ methods:
examples:
- "Delete a datasource credential by its ID<!--[!code-python[Main](les\\sample_datasource_credentials.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_datasource_credentials.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_datasource_credentials.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.core.exceptions import ResourceNotFoundError\n from azure.ai.metricsadvisor\
@@ -497,14 +504,15 @@ methods:
- "Delete an anomaly detection configuration by its ID<!--[!code-python[Main](les\\\
sample_detection_configuration.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
- \\samples\\\\sample_detection_configuration.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\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\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_detection_configuration.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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 \
@@ -529,14 +537,15 @@ methods:
examples:
- "Delete a hook by its ID<!--[!code-python[Main](les\\sample_hooks.py )]-->\n\n\
<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_hooks.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\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\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\
+ \\samples\\\\sample_hooks.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\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.\"\
@@ -561,14 +570,15 @@ methods:
examples:
- "Get a single anomaly alert configuration by its ID<!--[!code-python[Main](les\\\
sample_alert_configuration.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\
- \\sample_alert_configuration.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\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\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_alert_configuration.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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\
@@ -613,12 +623,13 @@ methods:
examples:
- "Get a single data feed by its ID<!--[!code-python[Main](les\\sample_data_feeds.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_data_feeds.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\
- \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_data_feeds.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\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,\
@@ -659,12 +670,13 @@ methods:
examples:
- "Get the progress of data feed ingestion<!--[!code-python[Main](les\\sample_ingestion.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_ingestion.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\
- \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_ingestion.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\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 \
@@ -693,8 +705,9 @@ methods:
examples:
- "Get a datasource credential by its ID<!--[!code-python[Main](les\\sample_datasource_credentials.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_datasource_credentials.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_datasource_credentials.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\
@@ -727,12 +740,12 @@ methods:
- "Get a single anomaly detection configuration by its ID<!--[!code-python[Main](les\\\
sample_detection_configuration.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
- \\samples\\\\sample_detection_configuration.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.ai.metricsadvisor\
- \ import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\n \
- \ service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_detection_configuration.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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,\
@@ -783,12 +796,13 @@ methods:
examples:
- "Get a notification hook by its ID<!--[!code-python[Main](les\\sample_hooks.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_hooks.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\
- \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_hooks.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\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,\
@@ -817,17 +831,18 @@ methods:
examples:
- "List all anomaly alert configurations for specific anomaly detection configuration<!--[!code-python[Main](les\\\
sample_alert_configuration.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\
- \\sample_alert_configuration.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\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\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_alert_configuration.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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"
@@ -864,14 +879,15 @@ methods:
examples:
- "List the data feed ingestion statuses by data feed ID<!--[!code-python[Main](les\\\
sample_ingestion.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
- \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\\
- _work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\
- \\sample_ingestion.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
- : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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\"\
+ \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_ingestion.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\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\
@@ -919,12 +935,13 @@ methods:
examples:
- "List data feeds under an account.<!--[!code-python[Main](les\\sample_data_feeds.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_data_feeds.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\
- \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_data_feeds.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\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,\
@@ -957,12 +974,12 @@ methods:
- "List all of the datasource credentials under the account<!--[!code-python[Main](les\\\
sample_datasource_credentials.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
- \\samples\\\\sample_datasource_credentials.py\", \"xml:space\": \"preserve\",\
- \ \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.ai.metricsadvisor\
- \ import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\n \
- \ service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_datasource_credentials.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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,\
@@ -990,12 +1007,12 @@ methods:
- "List all anomaly detection configurations for a specific metric<!--[!code-python[Main](les\\\
sample_detection_configuration.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
- \\samples\\\\sample_detection_configuration.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.ai.metricsadvisor\
- \ import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\n \
- \ service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_detection_configuration.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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 \
@@ -1027,12 +1044,13 @@ methods:
examples:
- "List all of the notification hooks under the account<!--[!code-python[Main](les\\\
sample_hooks.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"\
- names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\
- \\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_hooks.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\
- \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\
+ names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_hooks.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\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,\
@@ -1069,14 +1087,15 @@ methods:
examples:
- "Refresh data feed ingestion over a period of time<!--[!code-python[Main](les\\\
sample_ingestion.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
- \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\\
- _work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\
- \\sample_ingestion.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
- : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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\"\
+ \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_ingestion.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\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,\
@@ -1134,8 +1153,9 @@ methods:
examples:
- "Update an existing anomaly alert configuration<!--[!code-python[Main](les\\sample_alert_configuration.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_alert_configuration.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_alert_configuration.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\
@@ -1297,12 +1317,13 @@ methods:
examples:
- "Update an existing data feed<!--[!code-python[Main](les\\sample_data_feeds.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_data_feeds.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\
- \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_data_feeds.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\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,\
@@ -1337,8 +1358,9 @@ methods:
examples:
- "Update an existing datasource credential<!--[!code-python[Main](les\\sample_datasource_credentials.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_datasource_credentials.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_datasource_credentials.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\
@@ -1409,12 +1431,12 @@ methods:
- "Update an existing anomaly detection configuration<!--[!code-python[Main](les\\\
sample_detection_configuration.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
- \\samples\\\\sample_detection_configuration.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.ai.metricsadvisor\
- \ import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n from\
- \ azure.ai.metricsadvisor.models import (\n MetricSeriesGroupDetectionCondition,\n\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_detection_configuration.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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\
@@ -1512,12 +1534,13 @@ methods:
examples:
- "Update an existing notification hook<!--[!code-python[Main](les\\sample_hooks.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_hooks.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\
- \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_hooks.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\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,\
diff --git a/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.MetricsAdvisorClient.yml b/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.MetricsAdvisorClient.yml
index cd8db6041690..6f39340b11a8 100644
--- a/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.MetricsAdvisorClient.yml
+++ b/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.MetricsAdvisorClient.yml
@@ -48,22 +48,22 @@ methods:
examples:
- "Add new feedback.<!--[!code-python[Main](les\\sample_feedback.py )]-->\n\n<!--\
\ literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [],\
- \ \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_feedback.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\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\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 client.add_feedback(anomaly_feedback)\n\
+ \ \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\
+ \\samples\\\\sample_feedback.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\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\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 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,\
@@ -107,18 +107,18 @@ methods:
examples:
- "Get a metric feedback by its id.<!--[!code-python[Main](les\\sample_feedback.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_feedback.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_feedback.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\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.
@@ -161,8 +161,9 @@ methods:
examples:
- "Query anomaly detection results.<!--[!code-python[Main](les\\sample_alert_configuration.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_alert_configuration.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_alert_configuration.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n import datetime\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential,\
@@ -256,14 +257,15 @@ methods:
examples:
- "Query dimension values.<!--[!code-python[Main](les\\sample_queries.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_queries.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\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\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\
+ \\samples\\\\sample_queries.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\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 = \"city\"\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\
@@ -321,19 +323,19 @@ methods:
examples:
- "List feedback on the given metric.<!--[!code-python[Main](les\\sample_feedback.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_feedback.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_feedback.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\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.
@@ -359,17 +361,18 @@ methods:
examples:
- "Query incident root causes.<!--[!code-python[Main](les\\sample_incidents.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_incidents.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\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\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\
+ \\samples\\\\sample_incidents.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\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"
@@ -442,17 +445,18 @@ methods:
examples:
- "Query metric dimension values.<!--[!code-python[Main](les\\sample_queries.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_queries.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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 = \"city\"\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\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_queries.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\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\
+ \ = \"city\"\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
@@ -492,18 +496,18 @@ methods:
examples:
- "Query metric enriched series data.<!--[!code-python[Main](les\\sample_queries.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_queries.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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 = {\"city\"\
- : \"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\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_queries.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\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 = {\"city\": \"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"
@@ -540,14 +544,15 @@ methods:
examples:
- "Query metric enrichment status.<!--[!code-python[Main](les\\sample_queries.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_queries.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_queries.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\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 \
@@ -590,18 +595,18 @@ methods:
examples:
- "Query metrics series data.<!--[!code-python[Main](les\\sample_queries.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_queries.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\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,\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\
+ \\samples\\\\sample_queries.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\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 {\"city\": \"Los Angeles\"\
, \"category\": \"Homemade\"}\n ]\n )\n for result in results:\n\
\ print(str(result))\n\n\n ````\n"
@@ -640,14 +645,15 @@ methods:
examples:
- "Query metric series definitions.<!--[!code-python[Main](les\\sample_queries.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_queries.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\sample_queries.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\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\
diff --git a/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.yml b/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.yml
index c20a4019352f..7f888701a9fc 100644
--- a/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.yml
+++ b/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.yml
@@ -32,16 +32,17 @@ examples:
- "Authenticate MetricsAdvisorAdministrationClient with a MetricsAdvisorKeyCredential<!--[!code-python[Main](les\\\
async_samples\\sample_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
- \\samples\\\\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\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"
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\
+ \\sample_authentication_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\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
@@ -91,15 +92,15 @@ methods:
- "Create an anomaly alert configuration<!--[!code-python[Main](les\\async_samples\\\
sample_alert_configuration_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
- \\samples\\\\async_samples\\\\sample_alert_configuration_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\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\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\
+ \\sample_alert_configuration_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\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\"\
@@ -218,15 +219,16 @@ methods:
examples:
- "Create a data feed<!--[!code-python[Main](les\\async_samples\\sample_data_feeds_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\\
- sample_data_feeds_async.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
- language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\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\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\sample_data_feeds_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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\"\
@@ -273,20 +275,21 @@ methods:
examples:
- "Create a datasource credential<!--[!code-python[Main](les\\async_samples\\sample_datasource_credentials_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\\
- sample_datasource_credentials_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\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\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\sample_datasource_credentials_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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
@@ -334,25 +337,26 @@ methods:
- "Create an anomaly detection configuration<!--[!code-python[Main](les\\async_samples\\\
sample_detection_configuration_async.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
- \\samples\\\\async_samples\\\\sample_detection_configuration_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\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\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\
+ \\sample_detection_configuration_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\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\
@@ -384,13 +388,14 @@ methods:
examples:
- "Create a notification hook<!--[!code-python[Main](les\\async_samples\\sample_hooks_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\\
- sample_hooks_async.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
- : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\sample_hooks_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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 \
@@ -421,7 +426,8 @@ methods:
- "Delete an anomaly alert configuration by its ID<!--[!code-python[Main](les\\\
async_samples\\sample_alert_configuration_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\
\\samples\\\\async_samples\\\\sample_alert_configuration_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.exceptions\
@@ -454,15 +460,16 @@ methods:
examples:
- "Delete a data feed by its ID<!--[!code-python[Main](les\\async_samples\\sample_data_feeds_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\\
- sample_data_feeds_async.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
- language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\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\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\sample_data_feeds_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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\
@@ -486,14 +493,15 @@ methods:
- "Delete a datasource credential by its ID<!--[!code-python[Main](les\\async_samples\\\
sample_datasource_credentials_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
- \\samples\\\\async_samples\\\\sample_datasource_credentials_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\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\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\
+ \\sample_datasource_credentials_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\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"
@@ -518,7 +526,8 @@ methods:
- "Delete an anomaly detection configuration by its ID<!--[!code-python[Main](les\\\
async_samples\\sample_detection_configuration_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\
\\samples\\\\async_samples\\\\sample_detection_configuration_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.exceptions\
@@ -551,15 +560,16 @@ methods:
examples:
- "Delete a hook by its ID<!--[!code-python[Main](les\\async_samples\\sample_hooks_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\\
- sample_hooks_async.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
- : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\sample_hooks_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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\
@@ -585,7 +595,8 @@ methods:
- "Get a single anomaly alert configuration by its ID<!--[!code-python[Main](les\\\
async_samples\\sample_alert_configuration_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\
\\samples\\\\async_samples\\\\sample_alert_configuration_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.ai.metricsadvisor\
@@ -639,13 +650,14 @@ methods:
examples:
- "Get a data feed by its ID<!--[!code-python[Main](les\\async_samples\\sample_data_feeds_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\\
- sample_data_feeds_async.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
- language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\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\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\sample_data_feeds_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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,\
@@ -688,15 +700,16 @@ methods:
examples:
- "Get the progress of data feed ingestion<!--[!code-python[Main](les\\async_samples\\\
sample_ingestion_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\
- \\async_samples\\\\sample_ingestion_async.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\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\"\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\
+ \\sample_ingestion_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\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\
@@ -725,17 +738,18 @@ methods:
- "Get a datasource credential by its ID<!--[!code-python[Main](les\\async_samples\\\
sample_datasource_credentials_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
- \\samples\\\\async_samples\\\\sample_datasource_credentials_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\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(\"\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\
+ \\sample_datasource_credentials_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\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
@@ -759,7 +773,8 @@ methods:
- "Get a single anomaly detection configuration by its ID<!--[!code-python[Main](les\\\
async_samples\\sample_detection_configuration_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\
\\samples\\\\async_samples\\\\sample_detection_configuration_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.ai.metricsadvisor\
@@ -817,13 +832,14 @@ methods:
examples:
- "Get a notification hook by its ID<!--[!code-python[Main](les\\async_samples\\\
sample_hooks_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
- \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\\
- _work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\
- \\async_samples\\\\sample_hooks_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\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\
+ \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\sample_hooks_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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,\
@@ -853,7 +869,8 @@ methods:
- "List all anomaly alert configurations for specific anomaly detection configuration<!--[!code-python[Main](les\\\
async_samples\\sample_alert_configuration_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\
\\samples\\\\async_samples\\\\sample_alert_configuration_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.ai.metricsadvisor\
@@ -902,10 +919,11 @@ methods:
- "List the data feed ingestion statuses by data feed ID<!--[!code-python[Main](les\\\
async_samples\\sample_ingestion_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
- \\samples\\\\async_samples\\\\sample_ingestion_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import datetime\n from azure.ai.metricsadvisor\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\
+ \\sample_ingestion_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\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\
@@ -958,15 +976,16 @@ methods:
examples:
- "List data feeds under an account.<!--[!code-python[Main](les\\async_samples\\\
sample_data_feeds_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\
- \\async_samples\\\\sample_data_feeds_async.py\", \"xml:space\": \"preserve\",\
- \ \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\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\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\
+ \\sample_data_feeds_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\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: {}\"\
@@ -999,7 +1018,8 @@ methods:
- "List all of the datasource credentials under the account<!--[!code-python[Main](les\\\
async_samples\\sample_datasource_credentials_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\
\\samples\\\\async_samples\\\\sample_datasource_credentials_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.ai.metricsadvisor\
@@ -1032,7 +1052,8 @@ methods:
- "List all anomaly detection configurations for a specific metric<!--[!code-python[Main](les\\\
async_samples\\sample_detection_configuration_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\
\\samples\\\\async_samples\\\\sample_detection_configuration_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.ai.metricsadvisor\
@@ -1070,14 +1091,15 @@ methods:
- "List all the notification hooks under an account<!--[!code-python[Main](les\\\
async_samples\\sample_hooks_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
- \\samples\\\\async_samples\\\\sample_hooks_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\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\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\
+ \\sample_hooks_async.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
+ : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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\
@@ -1114,10 +1136,11 @@ methods:
- "Refresh data feed ingestion over a period of time<!--[!code-python[Main](les\\\
async_samples\\sample_ingestion_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
- \\samples\\\\async_samples\\\\sample_ingestion_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import datetime\n from azure.ai.metricsadvisor\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\
+ \\sample_ingestion_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\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\
@@ -1181,23 +1204,23 @@ methods:
- "Update an existing anomaly alert configuration<!--[!code-python[Main](les\\async_samples\\\
sample_alert_configuration_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
- \\samples\\\\async_samples\\\\sample_alert_configuration_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\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={'city':\
- \ 'Shenzhen'}\n ),\n alert_conditions=MetricAnomalyAlertConditions(\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\
+ \\sample_alert_configuration_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\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={'city': '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\
@@ -1347,13 +1370,14 @@ methods:
examples:
- "Update an existing data feed<!--[!code-python[Main](les\\async_samples\\sample_data_feeds_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\\
- sample_data_feeds_async.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
- language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\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\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\sample_data_feeds_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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,\
@@ -1392,19 +1416,20 @@ methods:
- "Update an existing datasource credential<!--[!code-python[Main](les\\async_samples\\\
sample_datasource_credentials_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
- \\samples\\\\async_samples\\\\sample_datasource_credentials_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\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\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\
+ \\sample_datasource_credentials_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\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
@@ -1465,7 +1490,8 @@ methods:
- "Update an existing anomaly detection configuration<!--[!code-python[Main](les\\\
async_samples\\sample_detection_configuration_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\
\\samples\\\\async_samples\\\\sample_detection_configuration_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.ai.metricsadvisor\
@@ -1571,13 +1597,14 @@ methods:
examples:
- "Update an existing notification hook<!--[!code-python[Main](les\\async_samples\\\
sample_hooks_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
- \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\\
- _work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\
- \\async_samples\\\\sample_hooks_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\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\
+ \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\sample_hooks_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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,\
diff --git a/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.aio.MetricsAdvisorClient.yml b/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.aio.MetricsAdvisorClient.yml
index 0cc1d53a7e81..350a350022ef 100644
--- a/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.aio.MetricsAdvisorClient.yml
+++ b/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.aio.MetricsAdvisorClient.yml
@@ -47,12 +47,13 @@ methods:
examples:
- "Add new feedback.<!--[!code-python[Main](les\\async_samples\\sample_feedback_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\\
- sample_feedback_async.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
- language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\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\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\sample_feedback_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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(\"\
@@ -110,19 +111,20 @@ methods:
examples:
- "Get a metric feedback by its id.<!--[!code-python[Main](les\\async_samples\\\
sample_feedback_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\
- \\async_samples\\\\sample_feedback_async.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\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"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\
+ \\sample_feedback_async.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\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.
@@ -165,12 +167,13 @@ methods:
- "Query anomaly detection results.<!--[!code-python[Main](les\\async_samples\\\
sample_alert_configuration_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\
- \\samples\\\\async_samples\\\\sample_alert_configuration_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\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\"\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\
+ \\sample_alert_configuration_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\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,\
@@ -261,11 +264,12 @@ methods:
examples:
- "Query dimension values.<!--[!code-python[Main](les\\async_samples\\sample_queries_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\\
- sample_queries_async.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
- : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
- \n````python\n\n import datetime\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\sample_queries_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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\"\
@@ -328,20 +332,20 @@ methods:
examples:
- "List feedback on the given metric.<!--[!code-python[Main](les\\async_samples\\\
sample_feedback_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\
- \\async_samples\\\\sample_feedback_async.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\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"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\
+ \\sample_feedback_async.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\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.
@@ -367,12 +371,13 @@ methods:
examples:
- "Query incident root causes.<!--[!code-python[Main](les\\async_samples\\sample_incidents_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\\
- sample_incidents_async.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
- language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential\n\
- \ from azure.ai.metricsadvisor.aio import MetricsAdvisorClient\n\n service_endpoint\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\sample_incidents_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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\"\
@@ -453,12 +458,13 @@ methods:
examples:
- "Query metric dimension values.<!--[!code-python[Main](les\\async_samples\\sample_queries_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\\
- sample_queries_async.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
- : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
- \n````python\n\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential\n\
- \ from azure.ai.metricsadvisor.aio import MetricsAdvisorClient\n\n service_endpoint\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\sample_queries_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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\
@@ -505,11 +511,12 @@ methods:
examples:
- "Query metric enriched series data.<!--[!code-python[Main](les\\async_samples\\\
sample_queries_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\
- \\async_samples\\\\sample_queries_async.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import datetime\n from azure.ai.metricsadvisor\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\
+ \\sample_queries_async.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\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\
@@ -555,11 +562,12 @@ methods:
examples:
- "Query metric enrichment status.<!--[!code-python[Main](les\\async_samples\\sample_queries_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\\
- sample_queries_async.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
- : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
- \n````python\n\n import datetime\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\sample_queries_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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\"\
@@ -606,11 +614,12 @@ methods:
examples:
- "Query metrics series data.<!--[!code-python[Main](les\\async_samples\\sample_queries_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\\
- sample_queries_async.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
- : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
- \n````python\n\n import datetime\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\\sample_queries_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\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\"\
@@ -657,11 +666,12 @@ methods:
examples:
- "Query metric series definitions.<!--[!code-python[Main](les\\async_samples\\\
sample_queries_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\9\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\
- \\async_samples\\\\sample_queries_async.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import datetime\n from azure.ai.metricsadvisor\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-metricsadvisor-1.0.0\\\\samples\\\\async_samples\\\
+ \\sample_queries_async.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\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\
diff --git a/docs-ref-autogen/azure-ai-ml/azure.ai.ml.MLClient.yml b/docs-ref-autogen/azure-ai-ml/azure.ai.ml.MLClient.yml
index d5daab1759ae..c6a799020f55 100644
--- a/docs-ref-autogen/azure-ai-ml/azure.ai.ml.MLClient.yml
+++ b/docs-ref-autogen/azure-ai-ml/azure.ai.ml.MLClient.yml
@@ -111,12 +111,12 @@ examples:
- "Creating the MLClient with Azure Identity credentials.<!--[!code-python[Main](les\\\
ml_samples_authentication_sovereign_cloud.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-ml-1.7.2\\\\samples\\\
- \\ml_samples_authentication_sovereign_cloud.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\":\
- \ 1}, \"linenos\": false} -->\n\n````python\n\n # Get a credential for authentication\n\
- \ # Default Azure Credentials attempt a chained set of authentication methods,\
- \ per documentation here: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\9\\\\azure-ai-ml-1.7.2\\\\samples\\\\ml_samples_authentication_sovereign_cloud.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # Get a credential\
+ \ for authentication\n # Default Azure Credentials attempt a chained set of authentication\
+ \ methods, per documentation here: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity\n\
\ # Alternately, one can specify the AZURE_TENANT_ID, AZURE_CLIENT_ID, and AZURE_CLIENT_SECRET\
\ to use the EnvironmentCredentialClass.\n # The docs above specify all mechanisms\
\ which the defaultCredential internally support.\n # Enter details of your subscription\n\
diff --git a/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.AnalyzeHealthcareEntitiesLROPoller.yml b/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.AnalyzeHealthcareEntitiesLROPoller.yml
index 0540cefa6661..bd3afe8f6c99 100644
--- a/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.AnalyzeHealthcareEntitiesLROPoller.yml
+++ b/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.AnalyzeHealthcareEntitiesLROPoller.yml
@@ -50,8 +50,9 @@ methods:
examples:
- "Cancel an existing health operation.<!--[!code-python[Main](les\\sample_analyze_healthcare_entities_with_cancellation.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\sample_analyze_healthcare_entities_with_cancellation.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 10\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\sample_analyze_healthcare_entities_with_cancellation.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n import os\n from azure.core.exceptions import HttpResponseError\n from\
diff --git a/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.TextAnalyticsClient.yml b/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.TextAnalyticsClient.yml
index b18b4d6a98ab..e661ed6ed63b 100644
--- a/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.TextAnalyticsClient.yml
+++ b/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.TextAnalyticsClient.yml
@@ -67,24 +67,26 @@ constructor:
examples:
- "Creating the TextAnalyticsClient with endpoint and API key.<!--[!code-python[Main](les\\\
sample_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\":\
- \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\
- \\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
- language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false}\
- \ -->\n\n````python\n\n import os\n from azure.core.credentials import AzureKeyCredential\n\
- \ from azure.ai.textanalytics import TextAnalyticsClient\n endpoint = os.environ[\"\
- AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client\
- \ = TextAnalyticsClient(endpoint, AzureKeyCredential(key))\n\n ````\n\nCreating\
- \ the TextAnalyticsClient with endpoint and token credential from Azure Active Directory.<!--[!code-python[Main](les\\\
+ \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\10\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\sample_authentication.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
+ \ from azure.core.credentials import AzureKeyCredential\n from azure.ai.textanalytics\
+ \ import TextAnalyticsClient\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"\
+ ]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(endpoint,\
+ \ AzureKeyCredential(key))\n\n ````\n\nCreating the TextAnalyticsClient with endpoint\
+ \ and token credential from Azure Active Directory.<!--[!code-python[Main](les\\\
sample_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\":\
- \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\
- \\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
- language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false}\
- \ -->\n\n````python\n\n import os\n from azure.ai.textanalytics import TextAnalyticsClient\n\
- \ from azure.identity import DefaultAzureCredential\n\n endpoint = os.environ[\"\
- AZURE_LANGUAGE_ENDPOINT\"]\n credential = DefaultAzureCredential()\n\n text_analytics_client\
- \ = TextAnalyticsClient(endpoint, credential=credential)\n\n ````\n"
+ \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\10\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\sample_authentication.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
+ \ from azure.ai.textanalytics import TextAnalyticsClient\n from azure.identity\
+ \ import DefaultAzureCredential\n\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"\
+ ]\n credential = DefaultAzureCredential()\n\n text_analytics_client = TextAnalyticsClient(endpoint,\
+ \ credential=credential)\n\n ````\n"
methods:
- uid: azure.ai.textanalytics.TextAnalyticsClient.analyze_sentiment
name: analyze_sentiment
@@ -222,8 +224,9 @@ methods:
examples:
- "Analyze sentiment in a batch of documents.<!--[!code-python[Main](les\\sample_analyze_sentiment.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\sample_analyze_sentiment.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 10\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\sample_analyze_sentiment.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n import os\n from azure.core.credentials import AzureKeyCredential\n from\
@@ -375,39 +378,40 @@ methods:
examples:
- "Perform abstractive summarization on a batch of documents.<!--[!code-python[Main](les\\\
sample_abstract_summary.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\
- \\sample_abstract_summary.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n import os\n from azure.core.credentials import\
- \ AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
- \n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
- AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(\n \
- \ endpoint=endpoint,\n credential=AzureKeyCredential(key),\n )\n\n\
- \ document = [\n \"At Microsoft, we have been on a quest to advance AI\
- \ beyond existing techniques, by taking a more holistic, \"\n \"human-centric\
- \ approach to learning and understanding. As Chief Technology Officer of Azure\
- \ AI Cognitive \"\n \"Services, I have been working with a team of amazing\
- \ scientists and engineers to turn this quest into a \"\n \"reality. In\
- \ my role, I enjoy a unique perspective in viewing the relationship among three\
- \ attributes of \"\n \"human cognition: monolingual text (X), audio or visual\
- \ sensory signals, (Y) and multilingual (Z). At the \"\n \"intersection\
- \ of all three, there's magic-what we call XYZ-code as illustrated in Figure 1-a\
- \ joint \"\n \"representation to create more powerful AI that can speak,\
- \ hear, see, and understand humans better. \"\n \"We believe XYZ-code will\
- \ enable us to fulfill our long-term vision: cross-domain transfer learning, \"\
- \n \"spanning modalities and languages. The goal is to have pretrained models\
- \ that can jointly learn \"\n \"representations to support a broad range\
- \ of downstream AI tasks, much in the way humans do today. \"\n \"Over the\
- \ past five years, we have achieved human performance on benchmarks in conversational\
- \ speech \"\n \"recognition, machine translation, conversational question\
- \ answering, machine reading comprehension, \"\n \"and image captioning.\
- \ These five breakthroughs provided us with strong signals toward our more ambitious\
- \ \"\n \"aspiration to produce a leap in AI capabilities, achieving multisensory\
- \ and multilingual learning that \"\n \"is closer in line with how humans\
- \ learn and understand. I believe the joint XYZ-code is a foundational \"\n \
- \ \"component of this aspiration, if grounded with external knowledge sources\
- \ in the downstream AI tasks.\"\n ]\n\n poller = text_analytics_client.begin_abstract_summary(document)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\sample_abstract_summary.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n import os\n from azure.core.credentials import AzureKeyCredential\n from\
+ \ azure.ai.textanalytics import TextAnalyticsClient\n\n endpoint = os.environ[\"\
+ AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"]\n\n \
+ \ text_analytics_client = TextAnalyticsClient(\n endpoint=endpoint,\n \
+ \ credential=AzureKeyCredential(key),\n )\n\n document = [\n \"\
+ At Microsoft, we have been on a quest to advance AI beyond existing techniques,\
+ \ by taking a more holistic, \"\n \"human-centric approach to learning and\
+ \ understanding. As Chief Technology Officer of Azure AI Cognitive \"\n \
+ \ \"Services, I have been working with a team of amazing scientists and engineers\
+ \ to turn this quest into a \"\n \"reality. In my role, I enjoy a unique\
+ \ perspective in viewing the relationship among three attributes of \"\n \
+ \ \"human cognition: monolingual text (X), audio or visual sensory signals, (Y)\
+ \ and multilingual (Z). At the \"\n \"intersection of all three, there's\
+ \ magic-what we call XYZ-code as illustrated in Figure 1-a joint \"\n \"\
+ representation to create more powerful AI that can speak, hear, see, and understand\
+ \ humans better. \"\n \"We believe XYZ-code will enable us to fulfill our\
+ \ long-term vision: cross-domain transfer learning, \"\n \"spanning modalities\
+ \ and languages. The goal is to have pretrained models that can jointly learn\
+ \ \"\n \"representations to support a broad range of downstream AI tasks,\
+ \ much in the way humans do today. \"\n \"Over the past five years, we have\
+ \ achieved human performance on benchmarks in conversational speech \"\n \
+ \ \"recognition, machine translation, conversational question answering, machine\
+ \ reading comprehension, \"\n \"and image captioning. These five breakthroughs\
+ \ provided us with strong signals toward our more ambitious \"\n \"aspiration\
+ \ to produce a leap in AI capabilities, achieving multisensory and multilingual\
+ \ learning that \"\n \"is closer in line with how humans learn and understand.\
+ \ I believe the joint XYZ-code is a foundational \"\n \"component of this\
+ \ aspiration, if grounded with external knowledge sources in the downstream AI\
+ \ tasks.\"\n ]\n\n poller = text_analytics_client.begin_abstract_summary(document)\n\
\ abstract_summary_results = poller.result()\n for result in abstract_summary_results:\n\
\ if result.kind == \"AbstractiveSummarization\":\n print(\"Summaries\
\ abstracted:\")\n [print(f\"{summary.text}\\n\") for summary in result.summaries]\n\
@@ -590,9 +594,10 @@ methods:
- "Start a long-running operation to perform a variety of text analysis\nactions\
\ over a batch of documents.<!--[!code-python[Main](les\\sample_analyze_actions.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\sample_analyze_actions.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 10\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\sample_analyze_actions.py\",\
+ \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n import os\n from azure.core.credentials import AzureKeyCredential\n from\
\ azure.ai.textanalytics import (\n TextAnalyticsClient,\n RecognizeEntitiesAction,\n\
@@ -796,19 +801,19 @@ methods:
- "Recognize healthcare entities in a batch of documents.<!--[!code-python[Main](les\\\
sample_analyze_healthcare_entities.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\
- \\samples\\\\sample_analyze_healthcare_entities.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n import typing\n\
- \ from azure.core.credentials import AzureKeyCredential\n from azure.ai.textanalytics\
- \ import TextAnalyticsClient, HealthcareEntityRelation\n\n endpoint = os.environ[\"\
- AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"]\n\n \
- \ text_analytics_client = TextAnalyticsClient(\n endpoint=endpoint,\n \
- \ credential=AzureKeyCredential(key),\n )\n\n documents = [\n \"\
- \"\"\n Patient needs to take 100 mg of ibuprofen, and 3 mg of potassium.\
- \ Also needs to take\n 10 mg of Zocor.\n \"\"\",\n \"\"\"\n\
- \ Patient needs to take 50 mg of ibuprofen, and 2 mg of Coumadin.\n \
- \ \"\"\"\n ]\n\n poller = text_analytics_client.begin_analyze_healthcare_entities(documents)\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\sample_analyze_healthcare_entities.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n import os\n import typing\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.ai.textanalytics import TextAnalyticsClient, HealthcareEntityRelation\n\
+ \n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
+ AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(\n \
+ \ endpoint=endpoint,\n credential=AzureKeyCredential(key),\n )\n\n\
+ \ documents = [\n \"\"\"\n Patient needs to take 100 mg of ibuprofen,\
+ \ and 3 mg of potassium. Also needs to take\n 10 mg of Zocor.\n \"\
+ \"\",\n \"\"\"\n Patient needs to take 50 mg of ibuprofen, and 2 mg\
+ \ of Coumadin.\n \"\"\"\n ]\n\n poller = text_analytics_client.begin_analyze_healthcare_entities(documents)\n\
\ result = poller.result()\n\n docs = [doc for doc in result if not doc.is_error]\n\
\n print(\"Let's first visualize the outputted healthcare result:\")\n for\
\ doc in docs:\n for entity in doc.entities:\n print(f\"Entity:\
@@ -964,39 +969,40 @@ methods:
examples:
- "Perform extractive summarization on a batch of documents.<!--[!code-python[Main](les\\\
sample_extract_summary.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\
- \\sample_extract_summary.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n import os\n from azure.core.credentials import\
- \ AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
- \n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
- AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(\n \
- \ endpoint=endpoint,\n credential=AzureKeyCredential(key),\n )\n\n\
- \ document = [\n \"At Microsoft, we have been on a quest to advance AI\
- \ beyond existing techniques, by taking a more holistic, \"\n \"human-centric\
- \ approach to learning and understanding. As Chief Technology Officer of Azure\
- \ AI Cognitive \"\n \"Services, I have been working with a team of amazing\
- \ scientists and engineers to turn this quest into a \"\n \"reality. In\
- \ my role, I enjoy a unique perspective in viewing the relationship among three\
- \ attributes of \"\n \"human cognition: monolingual text (X), audio or visual\
- \ sensory signals, (Y) and multilingual (Z). At the \"\n \"intersection\
- \ of all three, there's magic-what we call XYZ-code as illustrated in Figure 1-a\
- \ joint \"\n \"representation to create more powerful AI that can speak,\
- \ hear, see, and understand humans better. \"\n \"We believe XYZ-code will\
- \ enable us to fulfill our long-term vision: cross-domain transfer learning, \"\
- \n \"spanning modalities and languages. The goal is to have pretrained models\
- \ that can jointly learn \"\n \"representations to support a broad range\
- \ of downstream AI tasks, much in the way humans do today. \"\n \"Over the\
- \ past five years, we have achieved human performance on benchmarks in conversational\
- \ speech \"\n \"recognition, machine translation, conversational question\
- \ answering, machine reading comprehension, \"\n \"and image captioning.\
- \ These five breakthroughs provided us with strong signals toward our more ambitious\
- \ \"\n \"aspiration to produce a leap in AI capabilities, achieving multisensory\
- \ and multilingual learning that \"\n \"is closer in line with how humans\
- \ learn and understand. I believe the joint XYZ-code is a foundational \"\n \
- \ \"component of this aspiration, if grounded with external knowledge sources\
- \ in the downstream AI tasks.\"\n ]\n\n poller = text_analytics_client.begin_extract_summary(document)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\sample_extract_summary.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n import os\n from azure.core.credentials import AzureKeyCredential\n from\
+ \ azure.ai.textanalytics import TextAnalyticsClient\n\n endpoint = os.environ[\"\
+ AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"]\n\n \
+ \ text_analytics_client = TextAnalyticsClient(\n endpoint=endpoint,\n \
+ \ credential=AzureKeyCredential(key),\n )\n\n document = [\n \"\
+ At Microsoft, we have been on a quest to advance AI beyond existing techniques,\
+ \ by taking a more holistic, \"\n \"human-centric approach to learning and\
+ \ understanding. As Chief Technology Officer of Azure AI Cognitive \"\n \
+ \ \"Services, I have been working with a team of amazing scientists and engineers\
+ \ to turn this quest into a \"\n \"reality. In my role, I enjoy a unique\
+ \ perspective in viewing the relationship among three attributes of \"\n \
+ \ \"human cognition: monolingual text (X), audio or visual sensory signals, (Y)\
+ \ and multilingual (Z). At the \"\n \"intersection of all three, there's\
+ \ magic-what we call XYZ-code as illustrated in Figure 1-a joint \"\n \"\
+ representation to create more powerful AI that can speak, hear, see, and understand\
+ \ humans better. \"\n \"We believe XYZ-code will enable us to fulfill our\
+ \ long-term vision: cross-domain transfer learning, \"\n \"spanning modalities\
+ \ and languages. The goal is to have pretrained models that can jointly learn\
+ \ \"\n \"representations to support a broad range of downstream AI tasks,\
+ \ much in the way humans do today. \"\n \"Over the past five years, we have\
+ \ achieved human performance on benchmarks in conversational speech \"\n \
+ \ \"recognition, machine translation, conversational question answering, machine\
+ \ reading comprehension, \"\n \"and image captioning. These five breakthroughs\
+ \ provided us with strong signals toward our more ambitious \"\n \"aspiration\
+ \ to produce a leap in AI capabilities, achieving multisensory and multilingual\
+ \ learning that \"\n \"is closer in line with how humans learn and understand.\
+ \ I believe the joint XYZ-code is a foundational \"\n \"component of this\
+ \ aspiration, if grounded with external knowledge sources in the downstream AI\
+ \ tasks.\"\n ]\n\n poller = text_analytics_client.begin_extract_summary(document)\n\
\ extract_summary_results = poller.result()\n for result in extract_summary_results:\n\
\ if result.kind == \"ExtractiveSummarization\":\n print(\"Summary\
\ extracted: \\n{}\".format(\n \" \".join([sentence.text for sentence\
@@ -1125,18 +1131,19 @@ methods:
examples:
- "Perform multi label classification on a batch of documents.<!--[!code-python[Main](les\\\
sample_multi_label_classify.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\
- \\sample_multi_label_classify.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n import os\n from azure.core.credentials import\
- \ AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
- \n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
- AZURE_LANGUAGE_KEY\"]\n project_name = os.environ[\"MULTI_LABEL_CLASSIFY_PROJECT_NAME\"\
- ]\n deployment_name = os.environ[\"MULTI_LABEL_CLASSIFY_DEPLOYMENT_NAME\"]\n\
- \ path_to_sample_document = os.path.abspath(\n os.path.join(\n \
- \ os.path.abspath(__file__),\n \"..\",\n \"./text_samples/custom_classify_sample.txt\"\
- ,\n )\n )\n\n text_analytics_client = TextAnalyticsClient(\n endpoint=endpoint,\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\sample_multi_label_classify.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n import os\n from azure.core.credentials import AzureKeyCredential\n from\
+ \ azure.ai.textanalytics import TextAnalyticsClient\n\n endpoint = os.environ[\"\
+ AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"]\n project_name\
+ \ = os.environ[\"MULTI_LABEL_CLASSIFY_PROJECT_NAME\"]\n deployment_name = os.environ[\"\
+ MULTI_LABEL_CLASSIFY_DEPLOYMENT_NAME\"]\n path_to_sample_document = os.path.abspath(\n\
+ \ os.path.join(\n os.path.abspath(__file__),\n \"..\"\
+ ,\n \"./text_samples/custom_classify_sample.txt\",\n )\n )\n\
+ \n text_analytics_client = TextAnalyticsClient(\n endpoint=endpoint,\n\
\ credential=AzureKeyCredential(key),\n )\n\n with open(path_to_sample_document)\
\ as fd:\n document = [fd.read()]\n\n poller = text_analytics_client.begin_multi_label_classify(\n\
\ document,\n project_name=project_name,\n deployment_name=deployment_name\n\
@@ -1284,17 +1291,18 @@ methods:
- "Recognize custom entities in a batch of documents.<!--[!code-python[Main](les\\\
sample_recognize_custom_entities.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\
- \\samples\\\\sample_recognize_custom_entities.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
- \n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
- AZURE_LANGUAGE_KEY\"]\n project_name = os.environ[\"CUSTOM_ENTITIES_PROJECT_NAME\"\
- ]\n deployment_name = os.environ[\"CUSTOM_ENTITIES_DEPLOYMENT_NAME\"]\n path_to_sample_document\
- \ = os.path.abspath(\n os.path.join(\n os.path.abspath(__file__),\n\
- \ \"..\",\n \"./text_samples/custom_entities_sample.txt\"\
- ,\n )\n )\n\n text_analytics_client = TextAnalyticsClient(\n endpoint=endpoint,\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\sample_recognize_custom_entities.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n import os\n from azure.core.credentials import AzureKeyCredential\n from\
+ \ azure.ai.textanalytics import TextAnalyticsClient\n\n endpoint = os.environ[\"\
+ AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"]\n project_name\
+ \ = os.environ[\"CUSTOM_ENTITIES_PROJECT_NAME\"]\n deployment_name = os.environ[\"\
+ CUSTOM_ENTITIES_DEPLOYMENT_NAME\"]\n path_to_sample_document = os.path.abspath(\n\
+ \ os.path.join(\n os.path.abspath(__file__),\n \"..\"\
+ ,\n \"./text_samples/custom_entities_sample.txt\",\n )\n )\n\
+ \n text_analytics_client = TextAnalyticsClient(\n endpoint=endpoint,\n\
\ credential=AzureKeyCredential(key),\n )\n\n with open(path_to_sample_document)\
\ as fd:\n document = [fd.read()]\n\n poller = text_analytics_client.begin_recognize_custom_entities(\n\
\ document,\n project_name=project_name,\n deployment_name=deployment_name\n\
@@ -1429,18 +1437,19 @@ methods:
examples:
- "Perform single label classification on a batch of documents.<!--[!code-python[Main](les\\\
sample_single_label_classify.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\
- \\sample_single_label_classify.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n import os\n from azure.core.credentials import\
- \ AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
- \n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
- AZURE_LANGUAGE_KEY\"]\n project_name = os.environ[\"SINGLE_LABEL_CLASSIFY_PROJECT_NAME\"\
- ]\n deployment_name = os.environ[\"SINGLE_LABEL_CLASSIFY_DEPLOYMENT_NAME\"]\n\
- \ path_to_sample_document = os.path.abspath(\n os.path.join(\n \
- \ os.path.abspath(__file__),\n \"..\",\n \"./text_samples/custom_classify_sample.txt\"\
- ,\n )\n )\n\n text_analytics_client = TextAnalyticsClient(\n endpoint=endpoint,\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\sample_single_label_classify.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n import os\n from azure.core.credentials import AzureKeyCredential\n from\
+ \ azure.ai.textanalytics import TextAnalyticsClient\n\n endpoint = os.environ[\"\
+ AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"]\n project_name\
+ \ = os.environ[\"SINGLE_LABEL_CLASSIFY_PROJECT_NAME\"]\n deployment_name = os.environ[\"\
+ SINGLE_LABEL_CLASSIFY_DEPLOYMENT_NAME\"]\n path_to_sample_document = os.path.abspath(\n\
+ \ os.path.join(\n os.path.abspath(__file__),\n \"..\"\
+ ,\n \"./text_samples/custom_classify_sample.txt\",\n )\n )\n\
+ \n text_analytics_client = TextAnalyticsClient(\n endpoint=endpoint,\n\
\ credential=AzureKeyCredential(key),\n )\n\n with open(path_to_sample_document)\
\ as fd:\n document = [fd.read()]\n\n poller = text_analytics_client.begin_single_label_classify(\n\
\ document,\n project_name=project_name,\n deployment_name=deployment_name\n\
@@ -1564,9 +1573,10 @@ methods:
examples:
- "Detecting language in a batch of documents.<!--[!code-python[Main](les\\sample_detect_language.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\sample_detect_language.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 10\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\sample_detect_language.py\",\
+ \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n import os\n from azure.core.credentials import AzureKeyCredential\n from\
\ azure.ai.textanalytics import TextAnalyticsClient\n\n endpoint = os.environ[\"\
@@ -1698,27 +1708,28 @@ methods:
examples:
- "Extract the key phrases in a batch of documents.<!--[!code-python[Main](les\\\
sample_extract_key_phrases.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\
- \\sample_extract_key_phrases.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n import os\n from azure.core.credentials import\
- \ AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
- \n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
- AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(endpoint=endpoint,\
- \ credential=AzureKeyCredential(key))\n articles = [\n \"\"\"\n \
- \ Washington, D.C. Autumn in DC is a uniquely beautiful season. The leaves fall\
- \ from the trees\n in a city chock-full of forests, leaving yellow leaves\
- \ on the ground and a clearer view of the\n blue sky above...\n \"\
- \"\",\n \"\"\"\n Redmond, WA. In the past few days, Microsoft has\
- \ decided to further postpone the start date of\n its United States workers,\
- \ due to the pandemic that rages with no end in sight...\n \"\"\",\n \
- \ \"\"\"\n Redmond, WA. Employees at Microsoft can be excited about the\
- \ new coffee shop that will open on campus\n once workers no longer have\
- \ to work remotely...\n \"\"\"\n ]\n\n result = text_analytics_client.extract_key_phrases(articles)\n\
- \ for idx, doc in enumerate(result):\n if not doc.is_error:\n \
- \ print(\"Key phrases in article #{}: {}\".format(\n idx + 1,\n\
- \ \", \".join(doc.key_phrases)\n ))\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\sample_extract_key_phrases.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n import os\n from azure.core.credentials import AzureKeyCredential\n from\
+ \ azure.ai.textanalytics import TextAnalyticsClient\n\n endpoint = os.environ[\"\
+ AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"]\n\n \
+ \ text_analytics_client = TextAnalyticsClient(endpoint=endpoint, credential=AzureKeyCredential(key))\n\
+ \ articles = [\n \"\"\"\n Washington, D.C. Autumn in DC is a uniquely\
+ \ beautiful season. The leaves fall from the trees\n in a city chock-full\
+ \ of forests, leaving yellow leaves on the ground and a clearer view of the\n\
+ \ blue sky above...\n \"\"\",\n \"\"\"\n Redmond, WA.\
+ \ In the past few days, Microsoft has decided to further postpone the start date\
+ \ of\n its United States workers, due to the pandemic that rages with no\
+ \ end in sight...\n \"\"\",\n \"\"\"\n Redmond, WA. Employees\
+ \ at Microsoft can be excited about the new coffee shop that will open on campus\n\
+ \ once workers no longer have to work remotely...\n \"\"\"\n ]\n\
+ \n result = text_analytics_client.extract_key_phrases(articles)\n for idx,\
+ \ doc in enumerate(result):\n if not doc.is_error:\n print(\"\
+ Key phrases in article #{}: {}\".format(\n idx + 1,\n \
+ \ \", \".join(doc.key_phrases)\n ))\n\n ````\n"
- uid: azure.ai.textanalytics.TextAnalyticsClient.recognize_entities
name: recognize_entities
summary: 'Recognize entities for a batch of documents.
@@ -1837,8 +1848,9 @@ methods:
examples:
- "Recognize entities in a batch of documents.<!--[!code-python[Main](les\\sample_recognize_entities.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\sample_recognize_entities.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 10\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\sample_recognize_entities.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n import os\n import typing\n from azure.core.credentials import AzureKeyCredential\n\
@@ -1987,24 +1999,25 @@ methods:
- "Recognize linked entities in a batch of documents.<!--[!code-python[Main](les\\\
sample_recognize_linked_entities.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\
- \\samples\\\\sample_recognize_linked_entities.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
- \n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
- AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(endpoint=endpoint,\
- \ credential=AzureKeyCredential(key))\n documents = [\n \"\"\"\n \
- \ Microsoft was founded by Bill Gates with some friends he met at Harvard. One\
- \ of his friends,\n Steve Ballmer, eventually became CEO after Bill Gates\
- \ as well. Steve Ballmer eventually stepped\n down as CEO of Microsoft,\
- \ and was succeeded by Satya Nadella.\n Microsoft originally moved its headquarters\
- \ to Bellevue, Washington in January 1979, but is now\n headquartered in\
- \ Redmond.\n \"\"\"\n ]\n\n result = text_analytics_client.recognize_linked_entities(documents)\n\
- \ docs = [doc for doc in result if not doc.is_error]\n\n print(\n \"\
- Let's map each entity to it's Wikipedia article. I also want to see how many times\
- \ each \"\n \"entity is mentioned in a document\\n\\n\"\n )\n entity_to_url\
- \ = {}\n for doc in docs:\n for entity in doc.entities:\n print(\"\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\sample_recognize_linked_entities.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n import os\n from azure.core.credentials import AzureKeyCredential\n from\
+ \ azure.ai.textanalytics import TextAnalyticsClient\n\n endpoint = os.environ[\"\
+ AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"]\n\n \
+ \ text_analytics_client = TextAnalyticsClient(endpoint=endpoint, credential=AzureKeyCredential(key))\n\
+ \ documents = [\n \"\"\"\n Microsoft was founded by Bill Gates with\
+ \ some friends he met at Harvard. One of his friends,\n Steve Ballmer, eventually\
+ \ became CEO after Bill Gates as well. Steve Ballmer eventually stepped\n \
+ \ down as CEO of Microsoft, and was succeeded by Satya Nadella.\n Microsoft\
+ \ originally moved its headquarters to Bellevue, Washington in January 1979, but\
+ \ is now\n headquartered in Redmond.\n \"\"\"\n ]\n\n result =\
+ \ text_analytics_client.recognize_linked_entities(documents)\n docs = [doc for\
+ \ doc in result if not doc.is_error]\n\n print(\n \"Let's map each entity\
+ \ to it's Wikipedia article. I also want to see how many times each \"\n \
+ \ \"entity is mentioned in a document\\n\\n\"\n )\n entity_to_url = {}\n\
+ \ for doc in docs:\n for entity in doc.entities:\n print(\"\
Entity '{}' has been mentioned '{}' time(s)\".format(\n entity.name,\
\ len(entity.matches)\n ))\n if entity.data_source == \"Wikipedia\"\
:\n entity_to_url[entity.name] = entity.url\n\n ````\n"
@@ -2149,18 +2162,18 @@ methods:
- "Recognize personally identifiable information entities in a batch of documents.<!--[!code-python[Main](les\\\
sample_recognize_pii_entities.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\
- \\samples\\\\sample_recognize_pii_entities.py\", \"xml:space\": \"preserve\",\
- \ \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
- \n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
- AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(\n \
- \ endpoint=endpoint, credential=AzureKeyCredential(key)\n )\n documents\
- \ = [\n \"\"\"Parker Doe has repaid all of their loans as of 2020-04-25.\n\
- \ Their SSN is 859-98-0987. To contact them, use their phone number\n \
- \ 555-555-5555. They are originally from Brazil and have Brazilian CPF number\
- \ 998.214.865-68\"\"\"\n ]\n\n result = text_analytics_client.recognize_pii_entities(documents)\n\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\sample_recognize_pii_entities.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n import os\n from azure.core.credentials import AzureKeyCredential\n from\
+ \ azure.ai.textanalytics import TextAnalyticsClient\n\n endpoint = os.environ[\"\
+ AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"]\n\n \
+ \ text_analytics_client = TextAnalyticsClient(\n endpoint=endpoint, credential=AzureKeyCredential(key)\n\
+ \ )\n documents = [\n \"\"\"Parker Doe has repaid all of their loans\
+ \ as of 2020-04-25.\n Their SSN is 859-98-0987. To contact them, use their\
+ \ phone number\n 555-555-5555. They are originally from Brazil and have\
+ \ Brazilian CPF number 998.214.865-68\"\"\"\n ]\n\n result = text_analytics_client.recognize_pii_entities(documents)\n\
\ docs = [doc for doc in result if not doc.is_error]\n\n print(\n \"\
Let's compare the original document with the documents after redaction. \"\n \
\ \"I also want to comb through all of the entities that got redacted\"\n\
diff --git a/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.aio.AsyncAnalyzeHealthcareEntitiesLROPoller.yml b/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.aio.AsyncAnalyzeHealthcareEntitiesLROPoller.yml
index 45841a452dac..c407417fa745 100644
--- a/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.aio.AsyncAnalyzeHealthcareEntitiesLROPoller.yml
+++ b/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.aio.AsyncAnalyzeHealthcareEntitiesLROPoller.yml
@@ -37,7 +37,8 @@ methods:
- "Cancel an existing health operation.<!--[!code-python[Main](les\\async_samples\\\
sample_analyze_healthcare_entities_with_cancellation_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\
\\samples\\\\async_samples\\\\sample_analyze_healthcare_entities_with_cancellation_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
diff --git a/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.aio.TextAnalyticsClient.yml b/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.aio.TextAnalyticsClient.yml
index 3ae2671784b6..804a9cd6fa61 100644
--- a/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.aio.TextAnalyticsClient.yml
+++ b/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.aio.TextAnalyticsClient.yml
@@ -68,18 +68,19 @@ examples:
- "Creating the TextAnalyticsClient with endpoint and API key.<!--[!code-python[Main](les\\\
async_samples\\sample_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\
- \\samples\\\\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from\
- \ azure.core.credentials import AzureKeyCredential\n from azure.ai.textanalytics.aio\
- \ import TextAnalyticsClient\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"\
- ]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(endpoint,\
- \ AzureKeyCredential(key))\n\n ````\n\nCreating the TextAnalyticsClient with endpoint\
- \ and token credential from Azure Active Directory.<!--[!code-python[Main](les\\\
- async_samples\\sample_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\"\
- : [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\async_samples\\\
+ \\sample_authentication_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.core.credentials import\
+ \ AzureKeyCredential\n from azure.ai.textanalytics.aio import TextAnalyticsClient\n\
+ \ endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"\
+ ]\n\n text_analytics_client = TextAnalyticsClient(endpoint, AzureKeyCredential(key))\n\
+ \n ````\n\nCreating the TextAnalyticsClient with endpoint and token credential\
+ \ from Azure Active Directory.<!--[!code-python[Main](les\\async_samples\\sample_authentication_async.py\
+ \ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\
\\samples\\\\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"\
preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from\
@@ -225,13 +226,14 @@ methods:
- "Analyze sentiment in a batch of documents.<!--[!code-python[Main](les\\async_samples\\\
sample_analyze_sentiment_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\
- \\samples\\\\async_samples\\\\sample_analyze_sentiment_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
- \ from azure.core.credentials import AzureKeyCredential\n from azure.ai.textanalytics.aio\
- \ import TextAnalyticsClient\n\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"\
- ]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(endpoint=endpoint,\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\async_samples\\\
+ \\sample_analyze_sentiment_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
+ \ import AzureKeyCredential\n from azure.ai.textanalytics.aio import TextAnalyticsClient\n\
+ \n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
+ AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(endpoint=endpoint,\
\ credential=AzureKeyCredential(key))\n\n documents = [\n \"\"\"I had\
\ the best day of my life. I decided to go sky-diving and it made me appreciate\
\ my whole life so much more.\n I developed a deep-connection with my instructor\
@@ -379,7 +381,8 @@ methods:
- "Perform abstractive summarization on a batch of documents.<!--[!code-python[Main](les\\\
async_samples\\sample_abstract_summary_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\
\\samples\\\\async_samples\\\\sample_abstract_summary_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -595,77 +598,77 @@ methods:
- "Start a long-running operation to perform a variety of text analysis actions\
\ over\na batch of documents.<!--[!code-python[Main](les\\async_samples\\sample_analyze_actions_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\async_samples\\\\\
- sample_analyze_actions_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n import os\n from azure.core.credentials import\
- \ AzureKeyCredential\n from azure.ai.textanalytics.aio import TextAnalyticsClient\n\
- \ from azure.ai.textanalytics import (\n RecognizeEntitiesAction,\n \
- \ RecognizeLinkedEntitiesAction,\n RecognizePiiEntitiesAction,\n \
- \ ExtractKeyPhrasesAction,\n AnalyzeSentimentAction,\n )\n\n endpoint\
- \ = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"\
- ]\n\n text_analytics_client = TextAnalyticsClient(\n endpoint=endpoint,\n\
- \ credential=AzureKeyCredential(key),\n )\n\n documents = [\n \
- \ 'We went to Contoso Steakhouse located at midtown NYC last week for a dinner\
- \ party, and we adore the spot! '\n 'They provide marvelous food and they\
- \ have a great menu. The chief cook happens to be the owner (I think his name\
- \ is John Doe) '\n 'and he is super nice, coming out of the kitchen and\
- \ greeted us all.'\n ,\n\n 'We enjoyed very much dining in the place!\
- \ '\n 'The Sirloin steak I ordered was tender and juicy, and the place was\
- \ impeccably clean. You can even pre-order from their '\n 'online menu at\
- \ www.contososteakhouse.com, call 312-555-0176 or send email to order@contososteakhouse.com!\
- \ '\n 'The only complaint I have is the food didn\\'t come fast enough.\
- \ Overall I highly recommend it!'\n ]\n\n async with text_analytics_client:\n\
- \ poller = await text_analytics_client.begin_analyze_actions(\n \
- \ documents,\n display_name=\"Sample Text Analysis\",\n \
- \ actions=[\n RecognizeEntitiesAction(),\n RecognizePiiEntitiesAction(),\n\
- \ ExtractKeyPhrasesAction(),\n RecognizeLinkedEntitiesAction(),\n\
- \ AnalyzeSentimentAction(),\n ]\n )\n\n pages\
- \ = await poller.result()\n\n # To enumerate / zip for async, unless you\
- \ install a third party library,\n # you have to read in all of the elements\
- \ into memory first.\n # If you're not looking to enumerate / zip, we recommend\
- \ you just asynchronously\n # loop over it immediately, without going through\
- \ this step of reading them into memory\n document_results = []\n \
- \ async for page in pages:\n document_results.append(page)\n\n for\
- \ doc, action_results in zip(documents, document_results):\n print(f\"\\\
- nDocument text: {doc}\")\n for result in action_results:\n if\
- \ result.kind == \"EntityRecognition\":\n print(\"...Results of\
- \ Recognize Entities Action:\")\n for entity in result.entities:\n\
- \ print(f\"......Entity: {entity.text}\")\n \
- \ print(f\".........Category: {entity.category}\")\n print(f\"\
- .........Confidence Score: {entity.confidence_score}\")\n print(f\"\
- .........Offset: {entity.offset}\")\n\n elif result.kind == \"PiiEntityRecognition\"\
- :\n print(\"...Results of Recognize PII Entities action:\")\n \
- \ for pii_entity in result.entities:\n print(f\"\
- ......Entity: {pii_entity.text}\")\n print(f\".........Category:\
- \ {pii_entity.category}\")\n print(f\".........Confidence Score:\
- \ {pii_entity.confidence_score}\")\n\n elif result.kind == \"KeyPhraseExtraction\"\
- :\n print(\"...Results of Extract Key Phrases action:\")\n \
- \ print(f\"......Key Phrases: {result.key_phrases}\")\n\n elif\
- \ result.kind == \"EntityLinking\":\n print(\"...Results of Recognize\
- \ Linked Entities action:\")\n for linked_entity in result.entities:\n\
- \ print(f\"......Entity name: {linked_entity.name}\")\n \
- \ print(f\".........Data source: {linked_entity.data_source}\")\n\
- \ print(f\".........Data source language: {linked_entity.language}\"\
- )\n print(\n f\".........Data source entity\
- \ ID: {linked_entity.data_source_entity_id}\"\n )\n \
- \ print(f\".........Data source URL: {linked_entity.url}\")\n \
- \ print(\".........Document matches:\")\n for match\
- \ in linked_entity.matches:\n print(f\"............Match\
- \ text: {match.text}\")\n print(f\"............Confidence\
- \ Score: {match.confidence_score}\")\n print(f\"............Offset:\
- \ {match.offset}\")\n print(f\"............Length: {match.length}\"\
- )\n\n elif result.kind == \"SentimentAnalysis\":\n print(\"\
- ...Results of Analyze Sentiment action:\")\n print(f\"......Overall\
- \ sentiment: {result.sentiment}\")\n print(\n \
- \ f\"......Scores: positive={result.confidence_scores.positive}; \\\n \
- \ neutral={result.confidence_scores.neutral}; \\\n \
- \ negative={result.confidence_scores.negative} \\n\"\n )\n\n \
- \ elif result.is_error is True:\n print(\n \
- \ f\"...Is an error with code '{result.error.code}' and message '{result.error.message}'\"\
- \n )\n\n print(\"------------------------------------------\"\
- )\n\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 10\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\async_samples\\\\sample_analyze_actions_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n import os\n from azure.core.credentials import AzureKeyCredential\n from\
+ \ azure.ai.textanalytics.aio import TextAnalyticsClient\n from azure.ai.textanalytics\
+ \ import (\n RecognizeEntitiesAction,\n RecognizeLinkedEntitiesAction,\n\
+ \ RecognizePiiEntitiesAction,\n ExtractKeyPhrasesAction,\n AnalyzeSentimentAction,\n\
+ \ )\n\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
+ AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(\n \
+ \ endpoint=endpoint,\n credential=AzureKeyCredential(key),\n )\n\n\
+ \ documents = [\n 'We went to Contoso Steakhouse located at midtown NYC\
+ \ last week for a dinner party, and we adore the spot! '\n 'They provide\
+ \ marvelous food and they have a great menu. The chief cook happens to be the\
+ \ owner (I think his name is John Doe) '\n 'and he is super nice, coming\
+ \ out of the kitchen and greeted us all.'\n ,\n\n 'We enjoyed very\
+ \ much dining in the place! '\n 'The Sirloin steak I ordered was tender\
+ \ and juicy, and the place was impeccably clean. You can even pre-order from their\
+ \ '\n 'online menu at www.contososteakhouse.com, call 312-555-0176 or send\
+ \ email to order@contososteakhouse.com! '\n 'The only complaint I have is\
+ \ the food didn\\'t come fast enough. Overall I highly recommend it!'\n ]\n\n\
+ \ async with text_analytics_client:\n poller = await text_analytics_client.begin_analyze_actions(\n\
+ \ documents,\n display_name=\"Sample Text Analysis\",\n \
+ \ actions=[\n RecognizeEntitiesAction(),\n \
+ \ RecognizePiiEntitiesAction(),\n ExtractKeyPhrasesAction(),\n\
+ \ RecognizeLinkedEntitiesAction(),\n AnalyzeSentimentAction(),\n\
+ \ ]\n )\n\n pages = await poller.result()\n\n # To\
+ \ enumerate / zip for async, unless you install a third party library,\n \
+ \ # you have to read in all of the elements into memory first.\n # If you're\
+ \ not looking to enumerate / zip, we recommend you just asynchronously\n \
+ \ # loop over it immediately, without going through this step of reading them\
+ \ into memory\n document_results = []\n async for page in pages:\n\
+ \ document_results.append(page)\n\n for doc, action_results in zip(documents,\
+ \ document_results):\n print(f\"\\nDocument text: {doc}\")\n for result\
+ \ in action_results:\n if result.kind == \"EntityRecognition\":\n \
+ \ print(\"...Results of Recognize Entities Action:\")\n \
+ \ for entity in result.entities:\n print(f\"......Entity:\
+ \ {entity.text}\")\n print(f\".........Category: {entity.category}\"\
+ )\n print(f\".........Confidence Score: {entity.confidence_score}\"\
+ )\n print(f\".........Offset: {entity.offset}\")\n\n \
+ \ elif result.kind == \"PiiEntityRecognition\":\n print(\"...Results\
+ \ of Recognize PII Entities action:\")\n for pii_entity in result.entities:\n\
+ \ print(f\"......Entity: {pii_entity.text}\")\n \
+ \ print(f\".........Category: {pii_entity.category}\")\n \
+ \ print(f\".........Confidence Score: {pii_entity.confidence_score}\")\n\n\
+ \ elif result.kind == \"KeyPhraseExtraction\":\n print(\"\
+ ...Results of Extract Key Phrases action:\")\n print(f\"......Key\
+ \ Phrases: {result.key_phrases}\")\n\n elif result.kind == \"EntityLinking\"\
+ :\n print(\"...Results of Recognize Linked Entities action:\")\n\
+ \ for linked_entity in result.entities:\n print(f\"\
+ ......Entity name: {linked_entity.name}\")\n print(f\".........Data\
+ \ source: {linked_entity.data_source}\")\n print(f\".........Data\
+ \ source language: {linked_entity.language}\")\n print(\n \
+ \ f\".........Data source entity ID: {linked_entity.data_source_entity_id}\"\
+ \n )\n print(f\".........Data source URL:\
+ \ {linked_entity.url}\")\n print(\".........Document matches:\"\
+ )\n for match in linked_entity.matches:\n \
+ \ print(f\"............Match text: {match.text}\")\n \
+ \ print(f\"............Confidence Score: {match.confidence_score}\")\n \
+ \ print(f\"............Offset: {match.offset}\")\n \
+ \ print(f\"............Length: {match.length}\")\n\n elif\
+ \ result.kind == \"SentimentAnalysis\":\n print(\"...Results of\
+ \ Analyze Sentiment action:\")\n print(f\"......Overall sentiment:\
+ \ {result.sentiment}\")\n print(\n f\"......Scores:\
+ \ positive={result.confidence_scores.positive}; \\\n neutral={result.confidence_scores.neutral};\
+ \ \\\n negative={result.confidence_scores.negative} \\n\"\n\
+ \ )\n\n elif result.is_error is True:\n \
+ \ print(\n f\"...Is an error with code '{result.error.code}'\
+ \ and message '{result.error.message}'\"\n )\n\n print(\"\
+ ------------------------------------------\")\n\n\n ````\n"
- uid: azure.ai.textanalytics.aio.TextAnalyticsClient.begin_analyze_healthcare_entities
name: begin_analyze_healthcare_entities
summary: 'Analyze healthcare entities and identify relationships between these entities
@@ -806,7 +809,8 @@ methods:
- "Analyze healthcare entities in a batch of documents.<!--[!code-python[Main](les\\\
async_samples\\sample_analyze_healthcare_entities_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\
\\samples\\\\async_samples\\\\sample_analyze_healthcare_entities_async.py\", \"\
xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -976,7 +980,8 @@ methods:
- "Perform extractive summarization on a batch of documents.<!--[!code-python[Main](les\\\
async_samples\\sample_extract_summary_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\
\\samples\\\\async_samples\\\\sample_extract_summary_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -1139,7 +1144,8 @@ methods:
- "Perform multi label classification on a batch of documents.<!--[!code-python[Main](les\\\
async_samples\\sample_multi_label_classify_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\
\\samples\\\\async_samples\\\\sample_multi_label_classify_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -1302,7 +1308,8 @@ methods:
- "Recognize custom entities in a batch of documents.<!--[!code-python[Main](les\\\
async_samples\\sample_recognize_custom_entities_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\
\\samples\\\\async_samples\\\\sample_recognize_custom_entities_async.py\", \"\
xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -1451,7 +1458,8 @@ methods:
- "Perform single label classification on a batch of documents.<!--[!code-python[Main](les\\\
async_samples\\sample_single_label_classify_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\
\\samples\\\\async_samples\\\\sample_single_label_classify_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -1587,12 +1595,13 @@ methods:
examples:
- "Detecting language in a batch of documents.<!--[!code-python[Main](les\\async_samples\\\
sample_detect_language_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\
- \\async_samples\\\\sample_detect_language_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.textanalytics.aio import TextAnalyticsClient\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\async_samples\\\
+ \\sample_detect_language_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.core.credentials import\
+ \ AzureKeyCredential\n from azure.ai.textanalytics.aio import TextAnalyticsClient\n\
\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(endpoint=endpoint,\
\ credential=AzureKeyCredential(key))\n documents = [\n \"\"\"\n \
@@ -1722,7 +1731,8 @@ methods:
- "Extract the key phrases in a batch of documents.<!--[!code-python[Main](les\\\
async_samples\\sample_extract_key_phrases_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\
\\samples\\\\async_samples\\\\sample_extract_key_phrases_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -1865,24 +1875,25 @@ methods:
- "Recognize entities in a batch of documents.<!--[!code-python[Main](les\\async_samples\\\
sample_recognize_entities_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\
- \\samples\\\\async_samples\\\\sample_recognize_entities_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
- \ import typing\n from azure.core.credentials import AzureKeyCredential\n\
- \ from azure.ai.textanalytics.aio import TextAnalyticsClient\n\n endpoint\
- \ = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"\
- ]\n\n text_analytics_client = TextAnalyticsClient(endpoint=endpoint, credential=AzureKeyCredential(key))\n\
- \ reviews = [\n \"\"\"I work for Foo Company, and we hired Contoso for\
- \ our annual founding ceremony. The food\n was amazing and we all can't\
- \ say enough good words about the quality and the level of service.\"\"\",\n \
- \ \"\"\"We at the Foo Company re-hired Contoso after all of our past successes\
- \ with the company.\n Though the food was still great, I feel there has\
- \ been a quality drop since their last time\n catering for us. Is anyone\
- \ else running into the same problem?\"\"\",\n \"\"\"Bar Company is over\
- \ the moon about the service we received from Contoso, the best sliders ever!!!!\"\
- \"\"\n ]\n\n async with text_analytics_client:\n result = await text_analytics_client.recognize_entities(reviews)\n\
- \n result = [review for review in result if not review.is_error]\n organization_to_reviews:\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\async_samples\\\
+ \\sample_recognize_entities_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n import os\n import typing\n from\
+ \ azure.core.credentials import AzureKeyCredential\n from azure.ai.textanalytics.aio\
+ \ import TextAnalyticsClient\n\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"\
+ ]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(endpoint=endpoint,\
+ \ credential=AzureKeyCredential(key))\n reviews = [\n \"\"\"I work for\
+ \ Foo Company, and we hired Contoso for our annual founding ceremony. The food\n\
+ \ was amazing and we all can't say enough good words about the quality and\
+ \ the level of service.\"\"\",\n \"\"\"We at the Foo Company re-hired Contoso\
+ \ after all of our past successes with the company.\n Though the food was\
+ \ still great, I feel there has been a quality drop since their last time\n \
+ \ catering for us. Is anyone else running into the same problem?\"\"\",\n\
+ \ \"\"\"Bar Company is over the moon about the service we received from\
+ \ Contoso, the best sliders ever!!!!\"\"\"\n ]\n\n async with text_analytics_client:\n\
+ \ result = await text_analytics_client.recognize_entities(reviews)\n\n \
+ \ result = [review for review in result if not review.is_error]\n organization_to_reviews:\
\ typing.Dict[str, typing.List[str]] = {}\n\n for idx, review in enumerate(result):\n\
\ for entity in review.entities:\n print(f\"Entity '{entity.text}'\
\ has category '{entity.category}'\")\n\n if entity.category == 'Organization':\n\
@@ -2015,7 +2026,8 @@ methods:
- "Recognize linked entities in a batch of documents.<!--[!code-python[Main](les\\\
async_samples\\sample_recognize_linked_entities_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\
\\samples\\\\async_samples\\\\sample_recognize_linked_entities_async.py\", \"\
xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -2178,18 +2190,18 @@ methods:
- "Recognize personally identifiable information entities in a batch of documents.<!--[!code-python[Main](les\\\
sample_recognize_pii_entities.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-textanalytics-5.3.0\\\
- \\samples\\\\sample_recognize_pii_entities.py\", \"xml:space\": \"preserve\",\
- \ \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
- \n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
- AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(\n \
- \ endpoint=endpoint, credential=AzureKeyCredential(key)\n )\n documents\
- \ = [\n \"\"\"Parker Doe has repaid all of their loans as of 2020-04-25.\n\
- \ Their SSN is 859-98-0987. To contact them, use their phone number\n \
- \ 555-555-5555. They are originally from Brazil and have Brazilian CPF number\
- \ 998.214.865-68\"\"\"\n ]\n\n result = text_analytics_client.recognize_pii_entities(documents)\n\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0\\\\samples\\\\sample_recognize_pii_entities.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n import os\n from azure.core.credentials import AzureKeyCredential\n from\
+ \ azure.ai.textanalytics import TextAnalyticsClient\n\n endpoint = os.environ[\"\
+ AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"]\n\n \
+ \ text_analytics_client = TextAnalyticsClient(\n endpoint=endpoint, credential=AzureKeyCredential(key)\n\
+ \ )\n documents = [\n \"\"\"Parker Doe has repaid all of their loans\
+ \ as of 2020-04-25.\n Their SSN is 859-98-0987. To contact them, use their\
+ \ phone number\n 555-555-5555. They are originally from Brazil and have\
+ \ Brazilian CPF number 998.214.865-68\"\"\"\n ]\n\n result = text_analytics_client.recognize_pii_entities(documents)\n\
\ docs = [doc for doc in result if not doc.is_error]\n\n print(\n \"\
Let's compare the original document with the documents after redaction. \"\n \
\ \"I also want to comb through all of the entities that got redacted\"\n\
diff --git a/docs-ref-autogen/azure-ai-translation-document/azure.ai.translation.document.DocumentTranslationClient.yml b/docs-ref-autogen/azure-ai-translation-document/azure.ai.translation.document.DocumentTranslationClient.yml
index 1d913519bd29..52cb57eed042 100644
--- a/docs-ref-autogen/azure-ai-translation-document/azure.ai.translation.document.DocumentTranslationClient.yml
+++ b/docs-ref-autogen/azure-ai-translation-document/azure.ai.translation.document.DocumentTranslationClient.yml
@@ -44,22 +44,23 @@ constructor:
examples:
- "Creating the DocumentTranslationClient with an endpoint and API key.<!--[!code-python[Main](les\\\
sample_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\":\
- \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\dist_temp\\\\12\\\\azure-ai-translation-document-1.0.0\\\\\
- samples\\\\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
- \ from azure.ai.translation.document import DocumentTranslationClient\n\n endpoint\
- \ = os.environ[\"AZURE_DOCUMENT_TRANSLATION_ENDPOINT\"]\n key = os.environ[\"\
+ \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\11\\\\azure-ai-translation-document-1.0.0\\\\samples\\\\sample_authentication.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
+ \ import AzureKeyCredential\n from azure.ai.translation.document import DocumentTranslationClient\n\
+ \n endpoint = os.environ[\"AZURE_DOCUMENT_TRANSLATION_ENDPOINT\"]\n key = os.environ[\"\
AZURE_DOCUMENT_TRANSLATION_KEY\"]\n\n document_translation_client = DocumentTranslationClient(endpoint,\
\ AzureKeyCredential(key))\n\n ````\n\nCreating the DocumentTranslationClient\
\ with a token credential.<!--[!code-python[Main](les\\sample_authentication.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 12\\\\azure-ai-translation-document-1.0.0\\\\samples\\\\sample_authentication.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n \"\"\"DefaultAzureCredential\
- \ will use the values from these environment\n variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0\\\
+ \\samples\\\\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n \"\"\"DefaultAzureCredential will use\
+ \ the values from these environment\n variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,\
\ AZURE_CLIENT_SECRET\n \"\"\"\n from azure.identity import DefaultAzureCredential\n\
\ from azure.ai.translation.document import DocumentTranslationClient\n\n endpoint\
\ = os.environ[\"AZURE_DOCUMENT_TRANSLATION_ENDPOINT\"]\n credential = DefaultAzureCredential()\n\
@@ -200,12 +201,13 @@ methods:
examples:
- "Translate the documents in your storage container.<!--[!code-python[Main](les\\\
sample_begin_translation.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\12\\\\azure-ai-translation-document-1.0.0\\\
- \\samples\\\\sample_begin_translation.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.translation.document import DocumentTranslationClient\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0\\\\samples\\\
+ \\sample_begin_translation.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.core.credentials import\
+ \ AzureKeyCredential\n from azure.ai.translation.document import DocumentTranslationClient\n\
\n endpoint = os.environ[\"AZURE_DOCUMENT_TRANSLATION_ENDPOINT\"]\n key =\
\ os.environ[\"AZURE_DOCUMENT_TRANSLATION_KEY\"]\n source_container_url = os.environ[\"\
AZURE_SOURCE_CONTAINER_URL\"]\n target_container_url = os.environ[\"AZURE_TARGET_CONTAINER_URL\"\
@@ -388,21 +390,22 @@ methods:
- "List all the document statuses as they are being translated.<!--[!code-python[Main](les\\\
sample_check_document_statuses.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\12\\\\azure-ai-translation-document-1.0.0\\\
- \\samples\\\\sample_check_document_statuses.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n import time\n\
- \ from azure.core.credentials import AzureKeyCredential\n from azure.ai.translation.document\
- \ import DocumentTranslationClient\n\n endpoint = os.environ[\"AZURE_DOCUMENT_TRANSLATION_ENDPOINT\"\
- ]\n key = os.environ[\"AZURE_DOCUMENT_TRANSLATION_KEY\"]\n source_container_url\
- \ = os.environ[\"AZURE_SOURCE_CONTAINER_URL\"]\n target_container_url = os.environ[\"\
- AZURE_TARGET_CONTAINER_URL\"]\n\n client = DocumentTranslationClient(endpoint,\
- \ AzureKeyCredential(key))\n\n poller = client.begin_translation(source_container_url,\
- \ target_container_url, \"es\")\n\n completed_docs = []\n while not poller.done():\n\
- \ time.sleep(30)\n\n doc_statuses = client.list_document_statuses(poller.id)\n\
- \ for document in doc_statuses:\n if document.id not in completed_docs:\n\
- \ if document.status == \"Succeeded\":\n print(f\"\
- Document at {document.source_document_url} was translated to {document.translated_to}\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0\\\\samples\\\
+ \\sample_check_document_statuses.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n import os\n import time\n from azure.core.credentials\
+ \ import AzureKeyCredential\n from azure.ai.translation.document import DocumentTranslationClient\n\
+ \n endpoint = os.environ[\"AZURE_DOCUMENT_TRANSLATION_ENDPOINT\"]\n key =\
+ \ os.environ[\"AZURE_DOCUMENT_TRANSLATION_KEY\"]\n source_container_url = os.environ[\"\
+ AZURE_SOURCE_CONTAINER_URL\"]\n target_container_url = os.environ[\"AZURE_TARGET_CONTAINER_URL\"\
+ ]\n\n client = DocumentTranslationClient(endpoint, AzureKeyCredential(key))\n\
+ \n poller = client.begin_translation(source_container_url, target_container_url,\
+ \ \"es\")\n\n completed_docs = []\n while not poller.done():\n time.sleep(30)\n\
+ \n doc_statuses = client.list_document_statuses(poller.id)\n for document\
+ \ in doc_statuses:\n if document.id not in completed_docs:\n \
+ \ if document.status == \"Succeeded\":\n print(f\"Document\
+ \ at {document.source_document_url} was translated to {document.translated_to}\
\ \"\n f\"language. You can find translated document at\
\ {document.translated_document_url}\")\n completed_docs.append(document.id)\n\
\ if document.status == \"Failed\":\n print(f\"\
@@ -475,11 +478,12 @@ methods:
examples:
- "List all submitted translations under the resource.<!--[!code-python[Main](les\\\
sample_list_translations.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\12\\\\azure-ai-translation-document-1.0.0\\\
- \\samples\\\\sample_list_translations.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0\\\\samples\\\
+ \\sample_list_translations.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
\ from azure.ai.translation.document import DocumentTranslationClient\n\n\n\
\ endpoint = os.environ[\"AZURE_DOCUMENT_TRANSLATION_ENDPOINT\"]\n key = os.environ[\"\
AZURE_DOCUMENT_TRANSLATION_KEY\"]\n\n client = DocumentTranslationClient(endpoint,\
diff --git a/docs-ref-autogen/azure-ai-translation-document/azure.ai.translation.document.aio.DocumentTranslationClient.yml b/docs-ref-autogen/azure-ai-translation-document/azure.ai.translation.document.aio.DocumentTranslationClient.yml
index 508060ab271f..dce086abb124 100644
--- a/docs-ref-autogen/azure-ai-translation-document/azure.ai.translation.document.aio.DocumentTranslationClient.yml
+++ b/docs-ref-autogen/azure-ai-translation-document/azure.ai.translation.document.aio.DocumentTranslationClient.yml
@@ -45,20 +45,22 @@ examples:
- "Creating the DocumentTranslationClient with an endpoint and API key.<!--[!code-python[Main](les\\\
async_samples\\sample_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\12\\\\azure-ai-translation-document-1.0.0\\\
- \\samples\\\\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.translation.document.aio import DocumentTranslationClient\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0\\\\samples\\\
+ \\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials import\
+ \ AzureKeyCredential\n from azure.ai.translation.document.aio import DocumentTranslationClient\n\
\n endpoint = os.environ[\"AZURE_DOCUMENT_TRANSLATION_ENDPOINT\"]\n key = os.environ[\"\
AZURE_DOCUMENT_TRANSLATION_KEY\"]\n\n document_translation_client = DocumentTranslationClient(endpoint,\
\ AzureKeyCredential(key))\n\n ````\n\nCreating the DocumentTranslationClient\
\ with a token credential.<!--[!code-python[Main](les\\async_samples\\sample_authentication_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 12\\\\azure-ai-translation-document-1.0.0\\\\samples\\\\async_samples\\\\sample_authentication_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n \"\"\"DefaultAzureCredential\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0\\\
+ \\samples\\\\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"\
+ preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
+ linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n \"\"\"DefaultAzureCredential\
\ will use the values from these environment\n variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,\
\ AZURE_CLIENT_SECRET\n \"\"\"\n from azure.identity.aio import DefaultAzureCredential\n\
\ from azure.ai.translation.document.aio import DocumentTranslationClient\n\n\
@@ -201,7 +203,8 @@ methods:
- "Translate the documents in your storage container.<!--[!code-python[Main](les\\\
async_samples\\sample_begin_translation_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\12\\\\azure-ai-translation-document-1.0.0\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0\\\
\\samples\\\\async_samples\\\\sample_begin_translation_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -389,7 +392,8 @@ methods:
- "List all the document statuses as they are being translated.<!--[!code-python[Main](les\\\
async_samples\\sample_check_document_statuses_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\12\\\\azure-ai-translation-document-1.0.0\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0\\\
\\samples\\\\async_samples\\\\sample_check_document_statuses_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -479,7 +483,8 @@ methods:
- "List all submitted translations under the resource.<!--[!code-python[Main](les\\\
async_samples\\sample_list_translations_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\12\\\\azure-ai-translation-document-1.0.0\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0\\\
\\samples\\\\async_samples\\\\sample_list_translations_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
diff --git a/docs-ref-autogen/azure-communication-chat/azure.communication.chat.ChatClient.yml b/docs-ref-autogen/azure-communication-chat/azure.communication.chat.ChatClient.yml
index 7a4b3ffb538f..c9720f12e52e 100644
--- a/docs-ref-autogen/azure-communication-chat/azure.communication.chat.ChatClient.yml
+++ b/docs-ref-autogen/azure-communication-chat/azure.communication.chat.ChatClient.yml
@@ -28,13 +28,14 @@ constructor:
examples:
- "Creating the ChatClient from a URL and token.<!--[!code-python[Main](les\\chat_client_sample.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_client_sample.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
- \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.chat\
- \ import ChatClient, CommunicationTokenCredential\n\n # set `endpoint` to an existing\
- \ ACS endpoint\n chat_client = ChatClient(endpoint, CommunicationTokenCredential(token))\n\
- \n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\25\\\\azure-communication-chat-1.1.0\\\
+ \\samples\\\\chat_client_sample.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.chat import ChatClient,\
+ \ CommunicationTokenCredential\n\n # set `endpoint` to an existing ACS endpoint\n\
+ \ chat_client = ChatClient(endpoint, CommunicationTokenCredential(token))\n\n\
+ \ ````\n"
methods:
- uid: azure.communication.chat.ChatClient.close
name: close
@@ -79,20 +80,21 @@ methods:
examples:
- "Creating a new chat thread.<!--[!code-python[Main](les\\chat_client_sample.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_client_sample.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from datetime import datetime\n\n from azure.communication.chat import(\n\
- \ ChatClient,\n ChatParticipant,\n CommunicationUserIdentifier,\n\
- \ CommunicationTokenCredential\n )\n\n # set `endpoint` to an existing\
- \ ACS endpoint\n chat_client = ChatClient(endpoint, CommunicationTokenCredential(token))\n\
- \n topic = \"test topic\"\n participants = [ChatParticipant(\n identifier=user,\n\
- \ display_name='name',\n share_history_time=datetime.utcnow()\n \
- \ )]\n\n # creates a new chat_thread everytime\n create_chat_thread_result\
- \ = chat_client.create_chat_thread(topic, thread_participants=participants)\n\n\
- \ # creates a new chat_thread if not exists\n idempotency_token = 'b66d6031-fdcc-41df-8306-e524c9f226b8'\
- \ # unique identifier\n create_chat_thread_result_w_repeatability_id = chat_client.create_chat_thread(\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_client_sample.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from datetime\
+ \ import datetime\n\n from azure.communication.chat import(\n ChatClient,\n\
+ \ ChatParticipant,\n CommunicationUserIdentifier,\n CommunicationTokenCredential\n\
+ \ )\n\n # set `endpoint` to an existing ACS endpoint\n chat_client = ChatClient(endpoint,\
+ \ CommunicationTokenCredential(token))\n\n topic = \"test topic\"\n participants\
+ \ = [ChatParticipant(\n identifier=user,\n display_name='name',\n\
+ \ share_history_time=datetime.utcnow()\n )]\n\n # creates a new chat_thread\
+ \ everytime\n create_chat_thread_result = chat_client.create_chat_thread(topic,\
+ \ thread_participants=participants)\n\n # creates a new chat_thread if not exists\n\
+ \ idempotency_token = 'b66d6031-fdcc-41df-8306-e524c9f226b8' # unique identifier\n\
+ \ create_chat_thread_result_w_repeatability_id = chat_client.create_chat_thread(\n\
\ topic,\n thread_participants=participants,\n idempotency_token=idempotency_token\n\
\ )\n\n ````\n"
- uid: azure.communication.chat.ChatClient.delete_chat_thread
@@ -114,14 +116,15 @@ methods:
examples:
- "Deleting a chat thread.<!--[!code-python[Main](les\\chat_client_sample.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_client_sample.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.communication.chat import ChatClient, CommunicationTokenCredential\n\
- \n # set `endpoint` to an existing ACS endpoint\n chat_client = ChatClient(endpoint,\
- \ CommunicationTokenCredential(token))\n\n # set `thread_id` to an existing\
- \ chat thread id\n chat_client.delete_chat_thread(thread_id)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\25\\\\azure-communication-chat-1.1.0\\\
+ \\samples\\\\chat_client_sample.py\", \"xml:space\": \"preserve\", \"force\":\
+ \ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.chat import\
+ \ ChatClient, CommunicationTokenCredential\n\n # set `endpoint` to an existing\
+ \ ACS endpoint\n chat_client = ChatClient(endpoint, CommunicationTokenCredential(token))\n\
+ \n # set `thread_id` to an existing chat thread id\n chat_client.delete_chat_thread(thread_id)\n\
+ \n ````\n"
- uid: azure.communication.chat.ChatClient.get_chat_thread_client
name: get_chat_thread_client
summary: Get ChatThreadClient by providing a thread_id.
@@ -141,11 +144,12 @@ methods:
examples:
- "Retrieving the ChatThreadClient from an existing chat thread id.<!--[!code-python[Main](les\\\
chat_client_sample.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
- \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\\
- _work\\\\1\\\\s\\\\dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\
- \\chat_client_sample.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
- : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
- \n````python\n\n from azure.communication.chat import ChatClient, CommunicationTokenCredential\n\
+ \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_client_sample.py\",\
+ \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.communication.chat import ChatClient, CommunicationTokenCredential\n\
\n # set `endpoint` to an existing ACS endpoint\n chat_client = ChatClient(endpoint,\
\ CommunicationTokenCredential(token))\n\n # set `thread_id` to an existing\
\ chat thread id\n chat_thread_client = chat_client.get_chat_thread_client(thread_id)\n\
@@ -172,14 +176,15 @@ methods:
examples:
- "Listing chat threads.<!--[!code-python[Main](les\\chat_client_sample.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_client_sample.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.communication.chat import ChatClient, CommunicationTokenCredential\n\
- \ from datetime import datetime, timedelta\n\n # set `endpoint` to an existing\
- \ ACS endpoint\n chat_client = ChatClient(endpoint, CommunicationTokenCredential(token))\n\
- \ start_time = datetime.utcnow() - timedelta(days=2)\n chat_threads = chat_client.list_chat_threads(results_per_page=5,\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\25\\\\azure-communication-chat-1.1.0\\\
+ \\samples\\\\chat_client_sample.py\", \"xml:space\": \"preserve\", \"force\":\
+ \ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.chat import\
+ \ ChatClient, CommunicationTokenCredential\n from datetime import datetime,\
+ \ timedelta\n\n # set `endpoint` to an existing ACS endpoint\n chat_client\
+ \ = ChatClient(endpoint, CommunicationTokenCredential(token))\n start_time =\
+ \ datetime.utcnow() - timedelta(days=2)\n chat_threads = chat_client.list_chat_threads(results_per_page=5,\
\ start_time=start_time)\n\n print(\"list_threads succeeded with results_per_page\
\ is 5, and were created since 2 days ago.\")\n for chat_thread_item_page in\
\ chat_threads.by_page():\n for chat_thread_item in chat_thread_item_page:\n\
diff --git a/docs-ref-autogen/azure-communication-chat/azure.communication.chat.ChatThreadClient.yml b/docs-ref-autogen/azure-communication-chat/azure.communication.chat.ChatThreadClient.yml
index beb9f50420a8..d6bc53033d5e 100644
--- a/docs-ref-autogen/azure-communication-chat/azure.communication.chat.ChatThreadClient.yml
+++ b/docs-ref-autogen/azure-communication-chat/azure.communication.chat.ChatThreadClient.yml
@@ -46,14 +46,15 @@ variables:
examples:
- "Creating the ChatThreadClient.<!--[!code-python[Main](les\\chat_thread_client_sample.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from datetime\
- \ import datetime\n from azure.communication.chat import (\n ChatClient,\n\
- \ ChatParticipant,\n CommunicationUserIdentifier,\n CommunicationTokenCredential\n\
- \ )\n # retrieve `token` using CommunicationIdentityClient.get_token method\n\
- \ # set `endpoint` to ACS service endpoint\n # create `user` using CommunicationIdentityClient.create_user\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\25\\\\azure-communication-chat-1.1.0\\\
+ \\samples\\\\chat_thread_client_sample.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from datetime import datetime\n from\
+ \ azure.communication.chat import (\n ChatClient,\n ChatParticipant,\n\
+ \ CommunicationUserIdentifier,\n CommunicationTokenCredential\n )\n\
+ \ # retrieve `token` using CommunicationIdentityClient.get_token method\n #\
+ \ set `endpoint` to ACS service endpoint\n # create `user` using CommunicationIdentityClient.create_user\
\ method for new users;\n # else for existing users set `user` = CommunicationUserIdentifier(some_user_id)\n\
\ chat_client = ChatClient(endpoint, CommunicationTokenCredential(token))\n \
\ topic = \"test topic\"\n participants = [ChatParticipant(\n identifier=user,\n\
@@ -90,8 +91,9 @@ methods:
examples:
- "Adding participants to chat thread.<!--[!code-python[Main](les\\chat_thread_client_sample.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.communication.chat import ChatParticipant\n from datetime import\
@@ -129,8 +131,9 @@ methods:
examples:
- "Deleting a message.<!--[!code-python[Main](les\\chat_thread_client_sample.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # set `thread_id` to an existing thread id\n chat_thread_client = chat_client.get_chat_thread_client(thread_id=thread_id)\n\
@@ -155,8 +158,9 @@ methods:
examples:
- "Retrieving a message by message id.<!--[!code-python[Main](les\\chat_thread_client_sample.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # set `thread_id` to an existing thread id\n chat_thread_client = chat_client.get_chat_thread_client(thread_id=thread_id)\n\
@@ -176,13 +180,14 @@ methods:
examples:
- "Retrieving chat thread properties by chat thread id.<!--[!code-python[Main](les\\\
chat_thread_client_sample.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\\
- samples\\\\chat_thread_client_sample.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.communication.chat import\
- \ ChatClient, CommunicationTokenCredential\n\n # set `endpoint` to an existing\
- \ ACS endpoint\n chat_client = ChatClient(endpoint, CommunicationTokenCredential(token))\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\25\\\\azure-communication-chat-1.1.0\\\\samples\\\\\
+ chat_thread_client_sample.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.chat import ChatClient,\
+ \ CommunicationTokenCredential\n\n # set `endpoint` to an existing ACS endpoint\n\
+ \ chat_client = ChatClient(endpoint, CommunicationTokenCredential(token))\n\
\ chat_thread_client = chat_client.get_chat_thread_client(thread_id)\n chat_thread_properties\
\ = chat_thread_client.get_properties()\n print('Expected Thread Id: ', thread_id,\
\ ' Actual Value: ', chat_thread_properties.id)\n\n ````\n"
@@ -211,8 +216,9 @@ methods:
examples:
- "Listing messages of a chat thread.<!--[!code-python[Main](les\\chat_thread_client_sample.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from datetime import datetime, timedelta\n\n # set `thread_id` to an existing\
@@ -244,8 +250,9 @@ methods:
examples:
- "Listing participants of chat thread.<!--[!code-python[Main](les\\chat_thread_client_sample.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n\n # set `thread_id` to an existing thread id\n chat_thread_client = chat_client.get_chat_thread_client(thread_id=thread_id)\n\
@@ -276,8 +283,9 @@ methods:
examples:
- "Listing read receipts.<!--[!code-python[Main](les\\chat_thread_client_sample.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # set `thread_id` to an existing thread id\n chat_thread_client = chat_client.get_chat_thread_client(thread_id=thread_id)\n\
@@ -305,8 +313,9 @@ methods:
examples:
- "Removing participant from chat thread.<!--[!code-python[Main](les\\chat_thread_client_sample.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Option 1 : Iterate through all participants, find and delete Fred Flinstone\n\
@@ -355,14 +364,15 @@ methods:
examples:
- "Sending a message.<!--[!code-python[Main](les\\chat_thread_client_sample.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.communication.chat import ChatMessageType\n\n # set `thread_id`\
- \ to an existing thread id\n chat_thread_client = chat_client.get_chat_thread_client(thread_id=thread_id)\n\
- \n # Scenario 1: Send message without specifying chat_message_type\n send_message_result\
- \ = chat_thread_client.send_message(\n \"Hello! My name is Fred Flinstone\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\25\\\\azure-communication-chat-1.1.0\\\
+ \\samples\\\\chat_thread_client_sample.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.chat import\
+ \ ChatMessageType\n\n # set `thread_id` to an existing thread id\n chat_thread_client\
+ \ = chat_client.get_chat_thread_client(thread_id=thread_id)\n\n # Scenario 1:\
+ \ Send message without specifying chat_message_type\n send_message_result =\
+ \ chat_thread_client.send_message(\n \"Hello! My name is Fred Flinstone\"\
,\n sender_display_name=\"Fred Flinstone\")\n send_message_result_id =\
\ send_message_result.id\n\n # Scenario 2: Send message specifying chat_message_type\n\
\ send_message_result_w_type = chat_thread_client.send_message(\n \"Hello!\
@@ -391,8 +401,9 @@ methods:
examples:
- "Sending read receipt of a chat message.<!--[!code-python[Main](les\\chat_thread_client_sample.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # set `thread_id` to an existing thread id\n chat_thread_client = chat_client.get_chat_thread_client(thread_id=thread_id)\n\
@@ -418,8 +429,9 @@ methods:
examples:
- "Send typing notification.<!--[!code-python[Main](les\\chat_thread_client_sample.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # set `thread_id` to an existing thread id\n chat_thread_client = chat_client.get_chat_thread_client(thread_id=thread_id)\n\
@@ -453,8 +465,9 @@ methods:
examples:
- "Updating an already sent message.<!--[!code-python[Main](les\\chat_thread_client_sample.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # set `thread_id` to an existing thread id\n chat_thread_client = chat_client.get_chat_thread_client(thread_id=thread_id)\n\
@@ -485,8 +498,9 @@ methods:
examples:
- "Updating chat thread.<!--[!code-python[Main](les\\chat_thread_client_sample.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # set `thread_id` to an existing thread id\n chat_thread_client = chat_client.get_chat_thread_client(thread_id=thread_id)\n\
diff --git a/docs-ref-autogen/azure-communication-chat/azure.communication.chat.aio.ChatClient.yml b/docs-ref-autogen/azure-communication-chat/azure.communication.chat.aio.ChatClient.yml
index ee7e9520ec5d..2756e70a2084 100644
--- a/docs-ref-autogen/azure-communication-chat/azure.communication.chat.aio.ChatClient.yml
+++ b/docs-ref-autogen/azure-communication-chat/azure.communication.chat.aio.ChatClient.yml
@@ -28,11 +28,12 @@ constructor:
examples:
- "Creating the ChatClient from a URL and token.<!--[!code-python[Main](les\\chat_client_sample_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_client_sample_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.chat.aio\
- \ import ChatClient, CommunicationTokenCredential\n\n # set `endpoint` to an existing\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\25\\\\azure-communication-chat-1.1.0\\\
+ \\samples\\\\chat_client_sample_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.chat.aio import\
+ \ ChatClient, CommunicationTokenCredential\n\n # set `endpoint` to an existing\
\ ACS endpoint\n chat_client = ChatClient(endpoint, CommunicationTokenCredential(token))\n\
\n ````\n"
methods:
@@ -79,8 +80,9 @@ methods:
examples:
- "Creating a new chat thread.<!--[!code-python[Main](les\\chat_client_sample_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_client_sample_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_client_sample_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n datetime import datetime\n azure.communication.chat.aio import ChatClient,\
@@ -114,8 +116,9 @@ methods:
examples:
- "Deleting a chat thread.<!--[!code-python[Main](les\\chat_client_sample_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_client_sample_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_client_sample_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n azure.communication.chat.aio import ChatClient, CommunicationTokenCredential\n\
@@ -142,15 +145,16 @@ methods:
examples:
- "Retrieving the ChatThreadClient from an existing chat thread id.<!--[!code-python[Main](les\\\
chat_client_sample_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\\
- samples\\\\chat_client_sample_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.communication.chat.aio import\
- \ ChatClient, CommunicationTokenCredential\n\n # set `endpoint` to an existing\
- \ ACS endpoint\n chat_client = ChatClient(endpoint, CommunicationTokenCredential(token))\n\
- \n # set `thread_id` to an existing chat thread id\n chat_thread_client =\
- \ chat_client.get_chat_thread_client(thread_id)\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\25\\\\azure-communication-chat-1.1.0\\\\samples\\\\\
+ chat_client_sample_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.chat.aio import ChatClient,\
+ \ CommunicationTokenCredential\n\n # set `endpoint` to an existing ACS endpoint\n\
+ \ chat_client = ChatClient(endpoint, CommunicationTokenCredential(token))\n\n\
+ \ # set `thread_id` to an existing chat thread id\n chat_thread_client = chat_client.get_chat_thread_client(thread_id)\n\
+ \n ````\n"
- uid: azure.communication.chat.aio.ChatClient.list_chat_threads
name: list_chat_threads
summary: Gets the list of chat threads of a user.
@@ -173,8 +177,9 @@ methods:
examples:
- "Listing chat threads.<!--[!code-python[Main](les\\chat_client_sample_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_client_sample_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_client_sample_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n azure.communication.chat.aio import ChatClient, CommunicationTokenCredential\n\
diff --git a/docs-ref-autogen/azure-communication-chat/azure.communication.chat.aio.ChatThreadClient.yml b/docs-ref-autogen/azure-communication-chat/azure.communication.chat.aio.ChatThreadClient.yml
index 87499c7c102b..3f9866811338 100644
--- a/docs-ref-autogen/azure-communication-chat/azure.communication.chat.aio.ChatThreadClient.yml
+++ b/docs-ref-autogen/azure-communication-chat/azure.communication.chat.aio.ChatThreadClient.yml
@@ -46,11 +46,12 @@ variables:
examples:
- "Creating the ChatThreadClient.<!--[!code-python[Main](les\\chat_thread_client_sample_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from datetime\
- \ import datetime\n from azure.communication.chat.aio import ChatClient, CommunicationTokenCredential\n\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\25\\\\azure-communication-chat-1.1.0\\\
+ \\samples\\\\chat_thread_client_sample_async.py\", \"xml:space\": \"preserve\",\
+ \ \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from datetime import datetime\n\
+ \ from azure.communication.chat.aio import ChatClient, CommunicationTokenCredential\n\
\ from azure.communication.chat import ChatParticipant, CommunicationUserIdentifier\n\
\ # set `endpoint` to an existing ACS endpoint\n chat_client = ChatClient(endpoint,\
\ CommunicationTokenCredential(token))\n\n async with chat_client:\n topic\
@@ -88,8 +89,9 @@ methods:
examples:
- "Adding participants to chat thread.<!--[!code-python[Main](les\\chat_thread_client_sample_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n decide_to_retry(error):\n \"\"\"\n Custom logic to decide whether to\
@@ -125,8 +127,9 @@ methods:
examples:
- "Deleting a message.<!--[!code-python[Main](les\\chat_thread_client_sample_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n c with chat_client:\n # set `thread_id` to an existing thread id\n chat_thread_client\
@@ -152,8 +155,9 @@ methods:
examples:
- "Retrieving a message by message id.<!--[!code-python[Main](les\\chat_thread_client_sample_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n c with chat_client:\n # set `thread_id` to an existing thread id\n chat_thread_client\
@@ -176,12 +180,13 @@ methods:
- "Retrieving chat thread properties by chat thread id.<!--[!code-python[Main](les\\\
chat_thread_client_sample_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\
- \\samples\\\\chat_thread_client_sample_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n azure.communication.chat.aio\
- \ import ChatClient, CommunicationTokenCredential\n\n t `endpoint` to an existing\
- \ ACS endpoint\n _client = ChatClient(endpoint, CommunicationTokenCredential(token))\n\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\25\\\\azure-communication-chat-1.1.0\\\\samples\\\\\
+ chat_thread_client_sample_async.py\", \"xml:space\": \"preserve\", \"force\":\
+ \ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n azure.communication.chat.aio import\
+ \ ChatClient, CommunicationTokenCredential\n\n t `endpoint` to an existing ACS\
+ \ endpoint\n _client = ChatClient(endpoint, CommunicationTokenCredential(token))\n\
\ c with chat_client:\n chat_thread_client = chat_client.get_chat_thread_client(thread_id)\n\
\n async with chat_thread_client:\n chat_thread_properties = chat_thread_client.get_properties()\n\
\ print('Expected Thread Id: ', thread_id, ' Actual Value: ', chat_thread_properties.id)\n\
@@ -208,8 +213,9 @@ methods:
examples:
- "Listing messages of a chat thread.<!--[!code-python[Main](les\\chat_thread_client_sample_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n datetime import datetime, timedelta\n c with chat_client:\n # set `thread_id`\
@@ -242,8 +248,9 @@ methods:
examples:
- "Listing participants of chat thread.<!--[!code-python[Main](les\\chat_thread_client_sample_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n c with chat_client:\n # set `thread_id` to an existing thread id\n chat_thread_client\
@@ -276,8 +283,9 @@ methods:
examples:
- "Listing read receipts.<!--[!code-python[Main](les\\chat_thread_client_sample_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n c with chat_client:\n # set `thread_id` to an existing thread id\n chat_thread_client\
@@ -307,8 +315,9 @@ methods:
examples:
- "Removing participant from chat thread.<!--[!code-python[Main](les\\chat_thread_client_sample_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Option 1 : Iterate through all participants, find and delete Fred Flinstone\n\
@@ -358,8 +367,9 @@ methods:
examples:
- "Sending a message.<!--[!code-python[Main](les\\chat_thread_client_sample_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n azure.communication.chat import ChatMessageType\n c with chat_client:\n\
@@ -397,8 +407,9 @@ methods:
examples:
- "Sending read receipt of a chat message.<!--[!code-python[Main](les\\chat_thread_client_sample_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n c with chat_client:\n # set `thread_id` to an existing thread id\n chat_thread_client\
@@ -426,8 +437,9 @@ methods:
examples:
- "Send typing notification.<!--[!code-python[Main](les\\chat_thread_client_sample_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n c with chat_client:\n # set `thread_id` to an existing thread id\n chat_thread_client\
@@ -459,8 +471,9 @@ methods:
examples:
- "Updating an already sent message.<!--[!code-python[Main](les\\chat_thread_client_sample_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n c with chat_client:\n # set `thread_id` to an existing thread id\n chat_thread_client\
@@ -493,8 +506,9 @@ methods:
examples:
- "Updating chat thread.<!--[!code-python[Main](les\\chat_thread_client_sample_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\26\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 25\\\\azure-communication-chat-1.1.0\\\\samples\\\\chat_thread_client_sample_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n t `thread_id` to an existing thread id\n c with chat_client:\n chat_thread_client\
diff --git a/docs-ref-autogen/azure-communication-identity/azure.communication.identity.CommunicationIdentityClient.yml b/docs-ref-autogen/azure-communication-identity/azure.communication.identity.CommunicationIdentityClient.yml
index 22f1a5d9c5a7..eb4bac920344 100644
--- a/docs-ref-autogen/azure-communication-identity/azure.communication.identity.CommunicationIdentityClient.yml
+++ b/docs-ref-autogen/azure-communication-identity/azure.communication.identity.CommunicationIdentityClient.yml
@@ -30,7 +30,8 @@ constructor:
examples:
- "<!--[!code-python[Main](les\\identity_samples.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"\
- source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-identity-1.3.1\\\
+ source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\
+ \\site-packages\\\\py2docfx\\\\dist_temp\\\\27\\\\azure-communication-identity-1.3.1\\\
\\samples\\\\identity_samples.py\", \"xml:space\": \"preserve\", \"force\": false,\
\ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
: false} -->\n\n````python\n\n : utf-8\n\n -------------------------------------------------------------------\n\
diff --git a/docs-ref-autogen/azure-containerregistry/azure.containerregistry.ContainerRegistryClient.yml b/docs-ref-autogen/azure-containerregistry/azure.containerregistry.ContainerRegistryClient.yml
index 8ff455d29948..bc8b0b7a7f83 100644
--- a/docs-ref-autogen/azure-containerregistry/azure.containerregistry.ContainerRegistryClient.yml
+++ b/docs-ref-autogen/azure-containerregistry/azure.containerregistry.ContainerRegistryClient.yml
@@ -41,9 +41,10 @@ constructor:
examples:
- "Instantiate an instance of *ContainerRegistryClient*<!--[!code-python[Main](les\\\
sample_hello_world.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
- \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\
- \\1\\\\s\\\\dist_temp\\\\34\\\\azure-containerregistry-1.2.0\\\\samples\\\\sample_hello_world.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\33\\\\azure-containerregistry-1.2.0\\\\samples\\\\sample_hello_world.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n with ContainerRegistryClient(self.endpoint,\
\ self.credential) as client:\n\n ````\n"
methods:
@@ -127,12 +128,12 @@ methods:
examples:
- "Delete a repository from the *ContainerRegistryClient*<!--[!code-python[Main](les\\\
sample_hello_world.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
- \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\\
- _work\\\\1\\\\s\\\\dist_temp\\\\34\\\\azure-containerregistry-1.2.0\\\\samples\\\
- \\sample_hello_world.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
- : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
- \n````python\n\n client.delete_repository(repository_name)\n\n \
- \ ````\n"
+ \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\33\\\\azure-containerregistry-1.2.0\\\\samples\\\\sample_hello_world.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n \
+ \ client.delete_repository(repository_name)\n\n ````\n"
- uid: azure.containerregistry.ContainerRegistryClient.delete_tag
name: delete_tag
summary: "Delete a tag from a repository. If the tag cannot be found or a response\
@@ -342,14 +343,14 @@ methods:
examples:
- "List repositories in a container registry account<!--[!code-python[Main](les\\\
sample_delete_tags.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
- \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\\
- _work\\\\1\\\\s\\\\dist_temp\\\\34\\\\azure-containerregistry-1.2.0\\\\samples\\\
- \\sample_delete_tags.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
- : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
- \n````python\n\n with ContainerRegistryClient(self.endpoint, self.credential)\
- \ as client:\n # Iterate through all the repositories\n for repository_name\
- \ in client.list_repository_names():\n print(repository_name)\n\n \
- \ ````\n"
+ \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\33\\\\azure-containerregistry-1.2.0\\\\samples\\\\sample_delete_tags.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n with ContainerRegistryClient(self.endpoint,\
+ \ self.credential) as client:\n # Iterate through all the repositories\n\
+ \ for repository_name in client.list_repository_names():\n print(repository_name)\n\
+ \n ````\n"
- uid: azure.containerregistry.ContainerRegistryClient.list_tag_properties
name: list_tag_properties
summary: "List the tags for a repository\n\nExample\n\n<!-- literal_block {\"ids\"\
diff --git a/docs-ref-autogen/azure-core/azure.core.AsyncPipelineClient.yml b/docs-ref-autogen/azure-core/azure.core.AsyncPipelineClient.yml
index 841ad1353a80..651d5c9024d1 100644
--- a/docs-ref-autogen/azure-core/azure.core.AsyncPipelineClient.yml
+++ b/docs-ref-autogen/azure-core/azure.core.AsyncPipelineClient.yml
@@ -53,14 +53,15 @@ constructor:
examples:
- "Builds the async pipeline client.<!--[!code-python[Main](les\\test_example_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\35\\\\azure-core-1.29.4\\\\samples\\\\test_example_async.py\", \"xml:space\":\
- \ \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
- \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core\
- \ import AsyncPipelineClient\n from azure.core.pipeline.policies import AsyncRedirectPolicy,\
- \ UserAgentPolicy\n from azure.core.rest import HttpRequest\n\n # example policies\n\
- \ request = HttpRequest(\"GET\", url)\n policies: Iterable[Union[AsyncHTTPPolicy,\
- \ SansIOHTTPPolicy]] = [\n UserAgentPolicy(\"myuseragent\"),\n AsyncRedirectPolicy(),\n\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\34\\\\azure-core-1.29.4\\\
+ \\samples\\\\test_example_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core import AsyncPipelineClient\n \
+ \ from azure.core.pipeline.policies import AsyncRedirectPolicy, UserAgentPolicy\n\
+ \ from azure.core.rest import HttpRequest\n\n # example policies\n request\
+ \ = HttpRequest(\"GET\", url)\n policies: Iterable[Union[AsyncHTTPPolicy, SansIOHTTPPolicy]]\
+ \ = [\n UserAgentPolicy(\"myuseragent\"),\n AsyncRedirectPolicy(),\n\
\ ]\n\n async with AsyncPipelineClient[HttpRequest, AsyncHttpResponse](base_url=url,\
\ policies=policies) as client:\n response = await client.send_request(request)\n\
\n ````\n"
diff --git a/docs-ref-autogen/azure-core/azure.core.PipelineClient.yml b/docs-ref-autogen/azure-core/azure.core.PipelineClient.yml
index b8e34c9252c0..015cf0f28d85 100644
--- a/docs-ref-autogen/azure-core/azure.core.PipelineClient.yml
+++ b/docs-ref-autogen/azure-core/azure.core.PipelineClient.yml
@@ -52,13 +52,14 @@ constructor:
examples:
- "Builds the pipeline client.<!--[!code-python[Main](les\\test_example_sync.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\35\\\\azure-core-1.29.4\\\\samples\\\\test_example_sync.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core import\
- \ PipelineClient\n from azure.core.rest import HttpRequest\n from azure.core.pipeline.policies\
- \ import RedirectPolicy, UserAgentPolicy\n\n # example configuration with some\
- \ policies\n policies: Iterable[Union[HTTPPolicy, SansIOHTTPPolicy]] = [UserAgentPolicy(\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\34\\\\azure-core-1.29.4\\\
+ \\samples\\\\test_example_sync.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core import PipelineClient\n from\
+ \ azure.core.rest import HttpRequest\n from azure.core.pipeline.policies import\
+ \ RedirectPolicy, UserAgentPolicy\n\n # example configuration with some policies\n\
+ \ policies: Iterable[Union[HTTPPolicy, SansIOHTTPPolicy]] = [UserAgentPolicy(\"\
myuseragent\"), RedirectPolicy()]\n\n client: PipelineClient[HttpRequest, HttpResponse]\
\ = PipelineClient(base_url=url, policies=policies)\n request = HttpRequest(\"\
GET\", \"https://bing.com\")\n\n pipeline_response = client._pipeline.run(request)\n\
diff --git a/docs-ref-autogen/azure-core/azure.core.pipeline.AsyncPipeline.yml b/docs-ref-autogen/azure-core/azure.core.pipeline.AsyncPipeline.yml
index b119e063b22b..58d03306f035 100644
--- a/docs-ref-autogen/azure-core/azure.core.pipeline.AsyncPipeline.yml
+++ b/docs-ref-autogen/azure-core/azure.core.pipeline.AsyncPipeline.yml
@@ -30,10 +30,11 @@ constructor:
examples:
- "Builds the async pipeline for asynchronous transport.<!--[!code-python[Main](les\\\
test_example_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
- \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\
- \\1\\\\s\\\\source_code\\\\35\\\\azure-core-1.29.4\\\\samples\\\\test_example_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.pipeline\
+ \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\34\\\\azure-core-1.29.4\\\\samples\\\\test_example_async.py\", \"xml:space\":\
+ \ \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
+ \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.pipeline\
\ import AsyncPipeline\n from azure.core.pipeline.policies import AsyncRedirectPolicy,\
\ UserAgentPolicy\n from azure.core.pipeline.transport import AioHttpTransport\n\
\ from azure.core.rest import HttpRequest\n\n # example: create request and\
diff --git a/docs-ref-autogen/azure-core/azure.core.pipeline.Pipeline.yml b/docs-ref-autogen/azure-core/azure.core.pipeline.Pipeline.yml
index 3f51c4c87779..991d72f4450e 100644
--- a/docs-ref-autogen/azure-core/azure.core.pipeline.Pipeline.yml
+++ b/docs-ref-autogen/azure-core/azure.core.pipeline.Pipeline.yml
@@ -30,17 +30,18 @@ constructor:
examples:
- "Builds the pipeline for synchronous transport.<!--[!code-python[Main](les\\test_example_sync.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\35\\\\azure-core-1.29.4\\\\samples\\\\test_example_sync.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.pipeline\
- \ import Pipeline\n from azure.core.pipeline.policies import RedirectPolicy, UserAgentPolicy\n\
- \ from azure.core.rest import HttpRequest\n from azure.core.pipeline.transport\
- \ import RequestsTransport\n\n # example: create request and policies\n request\
- \ = HttpRequest(\"GET\", \"https://bing.com\")\n policies: Iterable[Union[HTTPPolicy,\
- \ SansIOHTTPPolicy]] = [UserAgentPolicy(\"myuseragent\"), RedirectPolicy()]\n\n\
- \ # run the pipeline\n with Pipeline(transport=RequestsTransport(), policies=policies)\
- \ as pipeline:\n response = pipeline.run(request)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\34\\\\azure-core-1.29.4\\\
+ \\samples\\\\test_example_sync.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.pipeline import Pipeline\n from\
+ \ azure.core.pipeline.policies import RedirectPolicy, UserAgentPolicy\n from azure.core.rest\
+ \ import HttpRequest\n from azure.core.pipeline.transport import RequestsTransport\n\
+ \n # example: create request and policies\n request = HttpRequest(\"GET\", \"\
+ https://bing.com\")\n policies: Iterable[Union[HTTPPolicy, SansIOHTTPPolicy]]\
+ \ = [UserAgentPolicy(\"myuseragent\"), RedirectPolicy()]\n\n # run the pipeline\n\
+ \ with Pipeline(transport=RequestsTransport(), policies=policies) as pipeline:\n\
+ \ response = pipeline.run(request)\n\n ````\n"
methods:
- uid: azure.core.pipeline.Pipeline.run
name: run
diff --git a/docs-ref-autogen/azure-core/azure.core.pipeline.policies.AsyncRedirectPolicy.yml b/docs-ref-autogen/azure-core/azure.core.pipeline.policies.AsyncRedirectPolicy.yml
index 36d57f832de9..d9858642d51f 100644
--- a/docs-ref-autogen/azure-core/azure.core.pipeline.policies.AsyncRedirectPolicy.yml
+++ b/docs-ref-autogen/azure-core/azure.core.pipeline.policies.AsyncRedirectPolicy.yml
@@ -24,18 +24,19 @@ constructor:
examples:
- "Configuring an async redirect policy.<!--[!code-python[Main](les\\test_example_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\35\\\\azure-core-1.29.4\\\\samples\\\\test_example_async.py\", \"xml:space\":\
- \ \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
- \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.pipeline.policies\
- \ import AsyncRedirectPolicy\n\n redirect_policy = AsyncRedirectPolicy()\n\n \
- \ # Client allows redirects. Defaults to True.\n redirect_policy.allow = True\n\
- \n # The maximum allowed redirects. The default value is 30\n redirect_policy.max_redirects\
- \ = 10\n\n # Alternatively you can disable redirects entirely\n redirect_policy\
- \ = AsyncRedirectPolicy.no_redirects()\n\n # It can also be overridden per operation.\n\
- \ async with AsyncPipelineClient[HttpRequest, AsyncHttpResponse](base_url=url,\
- \ policies=[redirect_policy]) as client:\n response = await client._pipeline.run(request,\
- \ permit_redirects=True, redirect_max=5)\n\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\34\\\\azure-core-1.29.4\\\
+ \\samples\\\\test_example_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.pipeline.policies import AsyncRedirectPolicy\n\
+ \n redirect_policy = AsyncRedirectPolicy()\n\n # Client allows redirects. Defaults\
+ \ to True.\n redirect_policy.allow = True\n\n # The maximum allowed redirects.\
+ \ The default value is 30\n redirect_policy.max_redirects = 10\n\n # Alternatively\
+ \ you can disable redirects entirely\n redirect_policy = AsyncRedirectPolicy.no_redirects()\n\
+ \n # It can also be overridden per operation.\n async with AsyncPipelineClient[HttpRequest,\
+ \ AsyncHttpResponse](base_url=url, policies=[redirect_policy]) as client:\n \
+ \ response = await client._pipeline.run(request, permit_redirects=True, redirect_max=5)\n\
+ \n\n ````\n"
methods:
- uid: azure.core.pipeline.policies.AsyncRedirectPolicy.configure_redirects
name: configure_redirects
diff --git a/docs-ref-autogen/azure-core/azure.core.pipeline.policies.AsyncRetryPolicy.yml b/docs-ref-autogen/azure-core/azure.core.pipeline.policies.AsyncRetryPolicy.yml
index c0ee5f3a2403..28b670d40ec3 100644
--- a/docs-ref-autogen/azure-core/azure.core.pipeline.policies.AsyncRetryPolicy.yml
+++ b/docs-ref-autogen/azure-core/azure.core.pipeline.policies.AsyncRetryPolicy.yml
@@ -61,35 +61,35 @@ constructor:
examples:
- "Configuring an async retry policy.<!--[!code-python[Main](les\\test_example_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\35\\\\azure-core-1.29.4\\\\samples\\\\test_example_async.py\", \"xml:space\":\
- \ \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
- \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.pipeline.policies\
- \ import AsyncRetryPolicy\n\n retry_policy = AsyncRetryPolicy()\n\n # Total\
- \ number of retries to allow. Takes precedence over other counts.\n # Default\
- \ value is 10.\n retry_policy.total_retries = 5\n\n # How many connection-related\
- \ errors to retry on.\n # These are errors raised before the request is sent to\
- \ the remote server,\n # which we assume has not triggered the server to process\
- \ the request. Default value is 3\n retry_policy.connect_retries = 2\n\n # How\
- \ many times to retry on read errors.\n # These errors are raised after the request\
- \ was sent to the server, so the\n # request may have side-effects. Default value\
- \ is 3.\n retry_policy.read_retries = 4\n\n # How many times to retry on bad\
- \ status codes. Default value is 3.\n retry_policy.status_retries = 3\n\n #\
- \ A backoff factor to apply between attempts after the second try\n # (most errors\
- \ are resolved immediately by a second try without a delay).\n # Retry policy\
- \ will sleep for:\n # {backoff factor} * (2 ** ({number of total retries} -\
- \ 1))\n # seconds. If the backoff_factor is 0.1, then the retry will sleep\n \
- \ # for [0.0s, 0.2s, 0.4s, ...] between retries.\n # The default value is 0.8.\n\
- \ retry_policy.backoff_factor = 0.5\n\n # The maximum back off time. Default\
- \ value is 120 seconds (2 minutes).\n retry_policy.backoff_max = 120\n\n # Alternatively\
- \ you can disable redirects entirely\n retry_policy = AsyncRetryPolicy.no_retries()\n\
- \n # All of these settings can also be configured per operation.\n policies.append(retry_policy)\n\
- \ async with AsyncPipelineClient[HttpRequest, AsyncHttpResponse](base_url=url,\
- \ policies=policies) as client:\n response = await client._pipeline.run(\n\
- \ request,\n retry_total=10,\n retry_connect=1,\n\
- \ retry_read=1,\n retry_status=5,\n retry_backoff_factor=0.5,\n\
- \ retry_backoff_max=60,\n retry_on_methods=[\"GET\"],\n \
- \ )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\34\\\\azure-core-1.29.4\\\
+ \\samples\\\\test_example_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.pipeline.policies import AsyncRetryPolicy\n\
+ \n retry_policy = AsyncRetryPolicy()\n\n # Total number of retries to allow.\
+ \ Takes precedence over other counts.\n # Default value is 10.\n retry_policy.total_retries\
+ \ = 5\n\n # How many connection-related errors to retry on.\n # These are errors\
+ \ raised before the request is sent to the remote server,\n # which we assume\
+ \ has not triggered the server to process the request. Default value is 3\n retry_policy.connect_retries\
+ \ = 2\n\n # How many times to retry on read errors.\n # These errors are raised\
+ \ after the request was sent to the server, so the\n # request may have side-effects.\
+ \ Default value is 3.\n retry_policy.read_retries = 4\n\n # How many times to\
+ \ retry on bad status codes. Default value is 3.\n retry_policy.status_retries\
+ \ = 3\n\n # A backoff factor to apply between attempts after the second try\n\
+ \ # (most errors are resolved immediately by a second try without a delay).\n\
+ \ # Retry policy will sleep for:\n # {backoff factor} * (2 ** ({number of\
+ \ total retries} - 1))\n # seconds. If the backoff_factor is 0.1, then the retry\
+ \ will sleep\n # for [0.0s, 0.2s, 0.4s, ...] between retries.\n # The default\
+ \ value is 0.8.\n retry_policy.backoff_factor = 0.5\n\n # The maximum back off\
+ \ time. Default value is 120 seconds (2 minutes).\n retry_policy.backoff_max =\
+ \ 120\n\n # Alternatively you can disable redirects entirely\n retry_policy\
+ \ = AsyncRetryPolicy.no_retries()\n\n # All of these settings can also be configured\
+ \ per operation.\n policies.append(retry_policy)\n async with AsyncPipelineClient[HttpRequest,\
+ \ AsyncHttpResponse](base_url=url, policies=policies) as client:\n response\
+ \ = await client._pipeline.run(\n request,\n retry_total=10,\n\
+ \ retry_connect=1,\n retry_read=1,\n retry_status=5,\n\
+ \ retry_backoff_factor=0.5,\n retry_backoff_max=60,\n \
+ \ retry_on_methods=[\"GET\"],\n )\n\n ````\n"
methods:
- uid: azure.core.pipeline.policies.AsyncRetryPolicy.configure_retries
name: configure_retries
diff --git a/docs-ref-autogen/azure-core/azure.core.pipeline.policies.HeadersPolicy.yml b/docs-ref-autogen/azure-core/azure.core.pipeline.policies.HeadersPolicy.yml
index 7796f6576280..a7c3f029a10b 100644
--- a/docs-ref-autogen/azure-core/azure.core.pipeline.policies.HeadersPolicy.yml
+++ b/docs-ref-autogen/azure-core/azure.core.pipeline.policies.HeadersPolicy.yml
@@ -24,14 +24,15 @@ constructor:
examples:
- "Configuring a headers policy.<!--[!code-python[Main](les\\test_example_sansio.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\35\\\\azure-core-1.29.4\\\\samples\\\\test_example_sansio.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
- \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.pipeline.policies\
- \ import HeadersPolicy\n\n headers_policy = HeadersPolicy()\n headers_policy.add_header(\"\
- CustomValue\", \"Foo\")\n\n # Or headers can be added per operation. These headers\
- \ will supplement existing headers\n # or those defined in the config headers\
- \ policy. They will also overwrite existing\n # identical headers.\n policies.append(headers_policy)\n\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\34\\\\azure-core-1.29.4\\\
+ \\samples\\\\test_example_sansio.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.pipeline.policies import HeadersPolicy\n\
+ \n headers_policy = HeadersPolicy()\n headers_policy.add_header(\"CustomValue\"\
+ , \"Foo\")\n\n # Or headers can be added per operation. These headers will supplement\
+ \ existing headers\n # or those defined in the config headers policy. They will\
+ \ also overwrite existing\n # identical headers.\n policies.append(headers_policy)\n\
\ client: PipelineClient[HttpRequest, HttpResponse] = PipelineClient(base_url=url,\
\ policies=policies)\n request = HttpRequest(\"GET\", url)\n pipeline_response\
\ = client._pipeline.run(request, headers={\"CustomValue\": \"Bar\"})\n\n ````\n"
diff --git a/docs-ref-autogen/azure-core/azure.core.pipeline.policies.NetworkTraceLoggingPolicy.yml b/docs-ref-autogen/azure-core/azure.core.pipeline.policies.NetworkTraceLoggingPolicy.yml
index 46c2cb59c418..bb1b29883fed 100644
--- a/docs-ref-autogen/azure-core/azure.core.pipeline.policies.NetworkTraceLoggingPolicy.yml
+++ b/docs-ref-autogen/azure-core/azure.core.pipeline.policies.NetworkTraceLoggingPolicy.yml
@@ -21,13 +21,14 @@ constructor:
examples:
- "Configuring a network trace logging policy.<!--[!code-python[Main](les\\test_example_sansio.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\35\\\\azure-core-1.29.4\\\\samples\\\\test_example_sansio.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
- \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.pipeline.policies\
- \ import NetworkTraceLoggingPolicy\n import sys\n import logging\n\n # Create\
- \ a logger for the 'azure' SDK\n logger = logging.getLogger(\"azure\")\n logger.setLevel(logging.DEBUG)\n\
- \n # Configure a console output\n handler = logging.StreamHandler(stream=sys.stdout)\n\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\34\\\\azure-core-1.29.4\\\
+ \\samples\\\\test_example_sansio.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.pipeline.policies import NetworkTraceLoggingPolicy\n\
+ \ import sys\n import logging\n\n # Create a logger for the 'azure' SDK\n\
+ \ logger = logging.getLogger(\"azure\")\n logger.setLevel(logging.DEBUG)\n\n\
+ \ # Configure a console output\n handler = logging.StreamHandler(stream=sys.stdout)\n\
\ logger.addHandler(handler)\n\n # Configure a file output\n file_handler\
\ = logging.FileHandler(filename)\n logger.addHandler(file_handler)\n\n # Enable\
\ network trace logging. This will be logged at DEBUG level.\n # By default, logging\
diff --git a/docs-ref-autogen/azure-core/azure.core.pipeline.policies.ProxyPolicy.yml b/docs-ref-autogen/azure-core/azure.core.pipeline.policies.ProxyPolicy.yml
index 3f571bedd4de..b19ec26917e5 100644
--- a/docs-ref-autogen/azure-core/azure.core.pipeline.policies.ProxyPolicy.yml
+++ b/docs-ref-autogen/azure-core/azure.core.pipeline.policies.ProxyPolicy.yml
@@ -24,12 +24,13 @@ constructor:
examples:
- "Configuring a proxy policy.<!--[!code-python[Main](les\\test_example_sansio.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\35\\\\azure-core-1.29.4\\\\samples\\\\test_example_sansio.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
- \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.pipeline.policies\
- \ import ProxyPolicy\n\n proxy_policy = ProxyPolicy()\n\n # Example\n proxy_policy.proxies\
- \ = {\"http\": \"http://10.10.1.10:3148\"}\n\n # Use basic auth\n proxy_policy.proxies\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\34\\\\azure-core-1.29.4\\\
+ \\samples\\\\test_example_sansio.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.pipeline.policies import ProxyPolicy\n\
+ \n proxy_policy = ProxyPolicy()\n\n # Example\n proxy_policy.proxies = {\"\
+ http\": \"http://10.10.1.10:3148\"}\n\n # Use basic auth\n proxy_policy.proxies\
\ = {\"https\": \"http://user:password@10.10.1.10:1180/\"}\n\n # You can also\
\ configure proxies by setting the environment variables\n # HTTP_PROXY and HTTPS_PROXY.\n\
\n ````\n"
diff --git a/docs-ref-autogen/azure-core/azure.core.pipeline.policies.RedirectPolicy.yml b/docs-ref-autogen/azure-core/azure.core.pipeline.policies.RedirectPolicy.yml
index 8b2b9a37acbf..f5ee447390b8 100644
--- a/docs-ref-autogen/azure-core/azure.core.pipeline.policies.RedirectPolicy.yml
+++ b/docs-ref-autogen/azure-core/azure.core.pipeline.policies.RedirectPolicy.yml
@@ -24,19 +24,19 @@ constructor:
examples:
- "Configuring a redirect policy.<!--[!code-python[Main](les\\test_example_sync.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\35\\\\azure-core-1.29.4\\\\samples\\\\test_example_sync.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.rest\
- \ import HttpRequest\n from azure.core.pipeline.policies import RedirectPolicy\n\
- \n redirect_policy = RedirectPolicy()\n\n # Client allows redirects. Defaults\
- \ to True.\n redirect_policy.allow = True\n\n # The maximum allowed redirects.\
- \ The default value is 30\n redirect_policy.max_redirects = 10\n\n # Alternatively\
- \ you can disable redirects entirely\n redirect_policy = RedirectPolicy.no_redirects()\n\
- \n # It can also be overridden per operation.\n client: PipelineClient[HttpRequest,\
- \ HttpResponse] = PipelineClient(base_url=url, policies=[redirect_policy])\n request\
- \ = HttpRequest(\"GET\", url)\n pipeline_response = client._pipeline.run(request,\
- \ permit_redirects=True, redirect_max=5)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\34\\\\azure-core-1.29.4\\\
+ \\samples\\\\test_example_sync.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.rest import HttpRequest\n from\
+ \ azure.core.pipeline.policies import RedirectPolicy\n\n redirect_policy = RedirectPolicy()\n\
+ \n # Client allows redirects. Defaults to True.\n redirect_policy.allow = True\n\
+ \n # The maximum allowed redirects. The default value is 30\n redirect_policy.max_redirects\
+ \ = 10\n\n # Alternatively you can disable redirects entirely\n redirect_policy\
+ \ = RedirectPolicy.no_redirects()\n\n # It can also be overridden per operation.\n\
+ \ client: PipelineClient[HttpRequest, HttpResponse] = PipelineClient(base_url=url,\
+ \ policies=[redirect_policy])\n request = HttpRequest(\"GET\", url)\n pipeline_response\
+ \ = client._pipeline.run(request, permit_redirects=True, redirect_max=5)\n\n ````\n"
methods:
- uid: azure.core.pipeline.policies.RedirectPolicy.configure_redirects
name: configure_redirects
diff --git a/docs-ref-autogen/azure-core/azure.core.pipeline.policies.RequestIdPolicy.yml b/docs-ref-autogen/azure-core/azure.core.pipeline.policies.RequestIdPolicy.yml
index 12039e62744a..c6b7f3057d1c 100644
--- a/docs-ref-autogen/azure-core/azure.core.pipeline.policies.RequestIdPolicy.yml
+++ b/docs-ref-autogen/azure-core/azure.core.pipeline.policies.RequestIdPolicy.yml
@@ -34,11 +34,12 @@ constructor:
examples:
- "Configuring a request id policy.<!--[!code-python[Main](les\\test_example_sansio.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\35\\\\azure-core-1.29.4\\\\samples\\\\test_example_sansio.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
- \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.pipeline.policies\
- \ import HeadersPolicy\n\n request_id_policy = RequestIdPolicy()\n request_id_policy.set_request_id(\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\34\\\\azure-core-1.29.4\\\
+ \\samples\\\\test_example_sansio.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.pipeline.policies import HeadersPolicy\n\
+ \n request_id_policy = RequestIdPolicy()\n request_id_policy.set_request_id(\"\
azconfig-test\")\n\n # Or headers can be added per operation. These headers will\
\ supplement existing headers\n # or those defined in the config headers policy.\
\ They will also overwrite existing\n # identical headers.\n policies.append(request_id_policy)\n\
diff --git a/docs-ref-autogen/azure-core/azure.core.pipeline.policies.RetryPolicy.yml b/docs-ref-autogen/azure-core/azure.core.pipeline.policies.RetryPolicy.yml
index 6b0498b46ec8..b881c2efa85a 100644
--- a/docs-ref-autogen/azure-core/azure.core.pipeline.policies.RetryPolicy.yml
+++ b/docs-ref-autogen/azure-core/azure.core.pipeline.policies.RetryPolicy.yml
@@ -72,32 +72,33 @@ constructor:
examples:
- "Configuring a retry policy.<!--[!code-python[Main](les\\test_example_sync.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\35\\\\azure-core-1.29.4\\\\samples\\\\test_example_sync.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.pipeline.policies\
- \ import RetryPolicy\n\n retry_policy = RetryPolicy()\n\n # Total number of\
- \ retries to allow. Takes precedence over other counts.\n # Default value is 10.\n\
- \ retry_policy.total_retries = 5\n\n # How many connection-related errors to\
- \ retry on.\n # These are errors raised before the request is sent to the remote\
- \ server,\n # which we assume has not triggered the server to process the request.\
- \ Default value is 3\n retry_policy.connect_retries = 2\n\n # How many times\
- \ to retry on read errors.\n # These errors are raised after the request was sent\
- \ to the server, so the\n # request may have side-effects. Default value is 3.\n\
- \ retry_policy.read_retries = 4\n\n # How many times to retry on bad status\
- \ codes. Default value is 3.\n retry_policy.status_retries = 3\n\n # A backoff\
- \ factor to apply between attempts after the second try\n # (most errors are resolved\
- \ immediately by a second try without a delay).\n # Retry policy will sleep for:\n\
- \ # {backoff factor} * (2 ** ({number of total retries} - 1))\n # seconds.\
- \ If the backoff_factor is 0.1, then the retry will sleep\n # for [0.0s, 0.2s,\
- \ 0.4s, ...] between retries.\n # The default value is 0.8.\n retry_policy.backoff_factor\
- \ = 0.5\n\n # The maximum back off time. Default value is 120 seconds (2 minutes).\n\
- \ retry_policy.backoff_max = 120\n\n # Alternatively you can disable redirects\
- \ entirely\n retry_policy = RetryPolicy.no_retries()\n\n # All of these settings\
- \ can also be configured per operation.\n policies.append(retry_policy)\n client:\
- \ PipelineClient[HttpRequest, HttpResponse] = PipelineClient(base_url=url, policies=policies)\n\
- \ request = HttpRequest(\"GET\", url)\n pipeline_response = client._pipeline.run(\n\
- \ request,\n retry_total=10,\n retry_connect=1,\n retry_read=1,\n\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\34\\\\azure-core-1.29.4\\\
+ \\samples\\\\test_example_sync.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.pipeline.policies import RetryPolicy\n\
+ \n retry_policy = RetryPolicy()\n\n # Total number of retries to allow. Takes\
+ \ precedence over other counts.\n # Default value is 10.\n retry_policy.total_retries\
+ \ = 5\n\n # How many connection-related errors to retry on.\n # These are errors\
+ \ raised before the request is sent to the remote server,\n # which we assume\
+ \ has not triggered the server to process the request. Default value is 3\n retry_policy.connect_retries\
+ \ = 2\n\n # How many times to retry on read errors.\n # These errors are raised\
+ \ after the request was sent to the server, so the\n # request may have side-effects.\
+ \ Default value is 3.\n retry_policy.read_retries = 4\n\n # How many times to\
+ \ retry on bad status codes. Default value is 3.\n retry_policy.status_retries\
+ \ = 3\n\n # A backoff factor to apply between attempts after the second try\n\
+ \ # (most errors are resolved immediately by a second try without a delay).\n\
+ \ # Retry policy will sleep for:\n # {backoff factor} * (2 ** ({number of\
+ \ total retries} - 1))\n # seconds. If the backoff_factor is 0.1, then the retry\
+ \ will sleep\n # for [0.0s, 0.2s, 0.4s, ...] between retries.\n # The default\
+ \ value is 0.8.\n retry_policy.backoff_factor = 0.5\n\n # The maximum back off\
+ \ time. Default value is 120 seconds (2 minutes).\n retry_policy.backoff_max =\
+ \ 120\n\n # Alternatively you can disable redirects entirely\n retry_policy\
+ \ = RetryPolicy.no_retries()\n\n # All of these settings can also be configured\
+ \ per operation.\n policies.append(retry_policy)\n client: PipelineClient[HttpRequest,\
+ \ HttpResponse] = PipelineClient(base_url=url, policies=policies)\n request =\
+ \ HttpRequest(\"GET\", url)\n pipeline_response = client._pipeline.run(\n \
+ \ request,\n retry_total=10,\n retry_connect=1,\n retry_read=1,\n\
\ retry_status=5,\n retry_backoff_factor=0.5,\n retry_backoff_max=120,\n\
\ retry_on_methods=[\"GET\"],\n )\n\n ````\n"
methods:
diff --git a/docs-ref-autogen/azure-core/azure.core.pipeline.policies.UserAgentPolicy.yml b/docs-ref-autogen/azure-core/azure.core.pipeline.policies.UserAgentPolicy.yml
index 9455a22a573a..4b7c3b2f4ea8 100644
--- a/docs-ref-autogen/azure-core/azure.core.pipeline.policies.UserAgentPolicy.yml
+++ b/docs-ref-autogen/azure-core/azure.core.pipeline.policies.UserAgentPolicy.yml
@@ -35,12 +35,13 @@ constructor:
examples:
- "Configuring a user agent policy.<!--[!code-python[Main](les\\test_example_sansio.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\35\\\\azure-core-1.29.4\\\\samples\\\\test_example_sansio.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
- \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.pipeline.policies\
- \ import UserAgentPolicy\n\n user_agent_policy = UserAgentPolicy()\n\n # The\
- \ user-agent policy allows you to append a custom value to the header.\n user_agent_policy.add_user_agent(\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\34\\\\azure-core-1.29.4\\\
+ \\samples\\\\test_example_sansio.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.pipeline.policies import UserAgentPolicy\n\
+ \n user_agent_policy = UserAgentPolicy()\n\n # The user-agent policy allows\
+ \ you to append a custom value to the header.\n user_agent_policy.add_user_agent(\"\
CustomValue\")\n\n # You can also pass in a custom value per operation to append\
\ to the end of the user-agent.\n # This can be used together with the policy\
\ configuration to append multiple values.\n policies = [\n redirect_policy,\n\
diff --git a/docs-ref-autogen/azure-core/azure.core.pipeline.transport.AioHttpTransport.yml b/docs-ref-autogen/azure-core/azure.core.pipeline.transport.AioHttpTransport.yml
index 8048093a8e42..c6e3e1c7abcd 100644
--- a/docs-ref-autogen/azure-core/azure.core.pipeline.transport.AioHttpTransport.yml
+++ b/docs-ref-autogen/azure-core/azure.core.pipeline.transport.AioHttpTransport.yml
@@ -28,12 +28,13 @@ constructor:
examples:
- "Asynchronous transport with aiohttp.<!--[!code-python[Main](les\\test_example_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\35\\\\azure-core-1.29.4\\\\samples\\\\test_example_async.py\", \"xml:space\":\
- \ \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
- \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.pipeline.transport\
- \ import AioHttpTransport\n\n async with AsyncPipeline(AioHttpTransport(), policies=policies)\
- \ as pipeline:\n response = await pipeline.run(request)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\34\\\\azure-core-1.29.4\\\
+ \\samples\\\\test_example_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.pipeline.transport import AioHttpTransport\n\
+ \n async with AsyncPipeline(AioHttpTransport(), policies=policies) as pipeline:\n\
+ \ response = await pipeline.run(request)\n\n ````\n"
methods:
- uid: azure.core.pipeline.transport.AioHttpTransport.close
name: close
diff --git a/docs-ref-autogen/azure-core/azure.core.pipeline.transport.AsyncioRequestsTransport.yml b/docs-ref-autogen/azure-core/azure.core.pipeline.transport.AsyncioRequestsTransport.yml
index 9b25c0c60e2a..ec0d3750e0ec 100644
--- a/docs-ref-autogen/azure-core/azure.core.pipeline.transport.AsyncioRequestsTransport.yml
+++ b/docs-ref-autogen/azure-core/azure.core.pipeline.transport.AsyncioRequestsTransport.yml
@@ -14,13 +14,13 @@ constructor:
examples:
- "Asynchronous transport with asyncio.<!--[!code-python[Main](les\\test_example_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\35\\\\azure-core-1.29.4\\\\samples\\\\test_example_async.py\", \"xml:space\":\
- \ \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
- \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.pipeline.transport\
- \ import AsyncioRequestsTransport\n\n async with AsyncPipeline(AsyncioRequestsTransport(),\
- \ policies=policies) as pipeline:\n response = await pipeline.run(request)\n\
- \n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\34\\\\azure-core-1.29.4\\\
+ \\samples\\\\test_example_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.pipeline.transport import AsyncioRequestsTransport\n\
+ \n async with AsyncPipeline(AsyncioRequestsTransport(), policies=policies) as\
+ \ pipeline:\n response = await pipeline.run(request)\n\n ````\n"
methods:
- uid: azure.core.pipeline.transport.AsyncioRequestsTransport.close
name: close
diff --git a/docs-ref-autogen/azure-core/azure.core.pipeline.transport.RequestsTransport.yml b/docs-ref-autogen/azure-core/azure.core.pipeline.transport.RequestsTransport.yml
index 0b418b0395d8..345d343e16f8 100644
--- a/docs-ref-autogen/azure-core/azure.core.pipeline.transport.RequestsTransport.yml
+++ b/docs-ref-autogen/azure-core/azure.core.pipeline.transport.RequestsTransport.yml
@@ -39,12 +39,13 @@ constructor:
examples:
- "Synchronous transport with Requests.<!--[!code-python[Main](les\\test_example_sync.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\35\\\\azure-core-1.29.4\\\\samples\\\\test_example_sync.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.pipeline.transport\
- \ import RequestsTransport\n\n with Pipeline(transport=RequestsTransport(), policies=policies)\
- \ as pipeline:\n response = pipeline.run(request)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\34\\\\azure-core-1.29.4\\\
+ \\samples\\\\test_example_sync.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.pipeline.transport import RequestsTransport\n\
+ \n with Pipeline(transport=RequestsTransport(), policies=policies) as pipeline:\n\
+ \ response = pipeline.run(request)\n\n ````\n"
methods:
- uid: azure.core.pipeline.transport.RequestsTransport.close
name: close
diff --git a/docs-ref-autogen/azure-cosmos/azure.cosmos.ContainerProxy.yml b/docs-ref-autogen/azure-cosmos/azure.cosmos.ContainerProxy.yml
index 44959fec8730..ef7827eddd07 100644
--- a/docs-ref-autogen/azure-cosmos/azure.cosmos.ContainerProxy.yml
+++ b/docs-ref-autogen/azure-cosmos/azure.cosmos.ContainerProxy.yml
@@ -409,23 +409,25 @@ methods:
examples:
- "Get all products that have not been discontinued:<!--[!code-python[Main](les\\\
examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import json\n\
- \n for item in container.query_items(\n query='SELECT * FROM products\
- \ p WHERE p.productModel <> \"DISCONTINUED\"',\n enable_cross_partition_query=True,\n\
- \ ):\n print(json.dumps(item, indent=True))\n\n ````\n\nParameterized\
- \ query to get all products that have been discontinued:<!--[!code-python[Main](les\\\
- examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n discontinued_items\
- \ = container.query_items(\n query='SELECT * FROM products p WHERE p.productModel\
- \ = @model AND p.productName=\"Widget\"',\n parameters=[dict(name=\"@model\"\
- , value=\"DISCONTINUED\")],\n )\n for item in discontinued_items:\n \
- \ print(json.dumps(item, indent=True))\n\n ````\n"
+ : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n import json\n\n for item in\
+ \ container.query_items(\n query='SELECT * FROM products p WHERE p.productModel\
+ \ <> \"DISCONTINUED\"',\n enable_cross_partition_query=True,\n ):\n \
+ \ print(json.dumps(item, indent=True))\n\n ````\n\nParameterized query to\
+ \ get all products that have been discontinued:<!--[!code-python[Main](les\\examples.py\
+ \ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n discontinued_items = container.query_items(\n\
+ \ query='SELECT * FROM products p WHERE p.productModel = @model AND p.productName=\"\
+ Widget\"',\n parameters=[dict(name=\"@model\", value=\"DISCONTINUED\")],\n\
+ \ )\n for item in discontinued_items:\n print(json.dumps(item, indent=True))\n\
+ \n ````\n"
- uid: azure.cosmos.ContainerProxy.query_items_change_feed
name: query_items_change_feed
summary: Get a sorted list of items that were changed, in the order in which they
@@ -582,10 +584,11 @@ methods:
examples:
- "Get an item from the database and update one of its properties:<!--[!code-python[Main](les\\\
examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n item = container.read_item(\"\
+ : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n item = container.read_item(\"\
item2\", partition_key=\"Widget\")\n item[\"productModel\"] = \"DISCONTINUED\"\
\n updated_item = container.upsert_item(item)\n\n ````\n"
- uid: azure.cosmos.ContainerProxy.read_offer
diff --git a/docs-ref-autogen/azure-cosmos/azure.cosmos.CosmosClient.yml b/docs-ref-autogen/azure-cosmos/azure.cosmos.CosmosClient.yml
index c3b6c92bdb06..365d34ab4429 100644
--- a/docs-ref-autogen/azure-cosmos/azure.cosmos.CosmosClient.yml
+++ b/docs-ref-autogen/azure-cosmos/azure.cosmos.CosmosClient.yml
@@ -123,13 +123,13 @@ constructor:
examples:
- "Create a new instance of the Cosmos DB client:<!--[!code-python[Main](les\\examples.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.cosmos import exceptions,\
- \ CosmosClient, PartitionKey\n\n import os\n\n url = os.environ[\"ACCOUNT_URI\"\
- ]\n key = os.environ[\"ACCOUNT_KEY\"]\n client = CosmosClient(url, key)\n\n\
- \ ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\35\\\\azure-cosmos-4.5.1\\\
+ \\samples\\\\examples.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
+ : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
+ \n````python\n\n from azure.cosmos import exceptions, CosmosClient, PartitionKey\n\
+ \n import os\n\n url = os.environ[\"ACCOUNT_URI\"]\n key = os.environ[\"ACCOUNT_KEY\"\
+ ]\n client = CosmosClient(url, key)\n\n ````\n"
methods:
- uid: azure.cosmos.CosmosClient.create_database
name: create_database
@@ -178,12 +178,13 @@ methods:
examples:
- "Create a database in the Cosmos DB account:<!--[!code-python[Main](les\\examples.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n database_name\
- \ = \"testDatabase\"\n try:\n database = client.create_database(id=database_name)\n\
- \ except exceptions.CosmosResourceExistsError:\n database = client.get_database_client(database=database_name)\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n database_name = \"testDatabase\"\
+ \n try:\n database = client.create_database(id=database_name)\n except\
+ \ exceptions.CosmosResourceExistsError:\n database = client.get_database_client(database=database_name)\n\
\n ````\n"
- uid: azure.cosmos.CosmosClient.create_database_if_not_exists
name: create_database_if_not_exists
diff --git a/docs-ref-autogen/azure-cosmos/azure.cosmos.DatabaseProxy.yml b/docs-ref-autogen/azure-cosmos/azure.cosmos.DatabaseProxy.yml
index 6e106cc0183a..4f8faccf361a 100644
--- a/docs-ref-autogen/azure-cosmos/azure.cosmos.DatabaseProxy.yml
+++ b/docs-ref-autogen/azure-cosmos/azure.cosmos.DatabaseProxy.yml
@@ -120,25 +120,26 @@ methods:
examples:
- "Create a container with default settings:<!--[!code-python[Main](les\\examples.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n container_name\
- \ = \"products\"\n try:\n container = database.create_container(\n \
- \ id=container_name, partition_key=PartitionKey(path=\"/productName\")\n\
- \ )\n except exceptions.CosmosResourceExistsError:\n container =\
- \ database.get_container_client(container_name)\n\n ````\n\nCreate a container\
- \ with specific settings; in this case, a custom partition key:<!--[!code-python[Main](les\\\
- examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n customer_container_name\
- \ = \"customers\"\n try:\n customer_container = database.create_container(\n\
- \ id=customer_container_name,\n partition_key=PartitionKey(path=\"\
- /city\"),\n default_ttl=200,\n )\n except exceptions.CosmosResourceExistsError:\n\
- \ customer_container = database.get_container_client(customer_container_name)\n\
- \n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n container_name = \"products\"\
+ \n try:\n container = database.create_container(\n id=container_name,\
+ \ partition_key=PartitionKey(path=\"/productName\")\n )\n except exceptions.CosmosResourceExistsError:\n\
+ \ container = database.get_container_client(container_name)\n\n ````\n\
+ \nCreate a container with specific settings; in this case, a custom partition\
+ \ key:<!--[!code-python[Main](les\\examples.py )]-->\n\n<!-- literal_block {\"\
+ ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\35\\\\azure-cosmos-4.5.1\\\\\
+ samples\\\\examples.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
+ : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
+ \n````python\n\n customer_container_name = \"customers\"\n try:\n customer_container\
+ \ = database.create_container(\n id=customer_container_name,\n \
+ \ partition_key=PartitionKey(path=\"/city\"),\n default_ttl=200,\n\
+ \ )\n except exceptions.CosmosResourceExistsError:\n customer_container\
+ \ = database.get_container_client(customer_container_name)\n\n ````\n"
- uid: azure.cosmos.DatabaseProxy.create_container_if_not_exists
name: create_container_if_not_exists
summary: 'Create a container if it does not exist already.
@@ -252,10 +253,11 @@ methods:
examples:
- "Create a database user:<!--[!code-python[Main](les\\examples.py )]-->\n\n<!--\
\ literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [],\
- \ \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\\
- 36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n try:\n database.create_user(dict(id=\"\
+ \ \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\35\\\\azure-cosmos-4.5.1\\\
+ \\samples\\\\examples.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n try:\n database.create_user(dict(id=\"\
Walter Harp\"))\n except exceptions.CosmosResourceExistsError:\n print(\"\
A user with that ID already exists.\")\n except exceptions.CosmosHttpResponseError\
\ as failure:\n print(\"Failed to create user. Status code:{}\".format(failure.status_code))\n\
@@ -346,12 +348,12 @@ methods:
examples:
- "Get an existing container, handling a failure if encountered:<!--[!code-python[Main](les\\\
examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n database =\
- \ client.get_database_client(database_name)\n container = database.get_container_client(container_name)\n\
- \n ````\n"
+ : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n database = client.get_database_client(database_name)\n\
+ \ container = database.get_container_client(container_name)\n\n ````\n"
- uid: azure.cosmos.DatabaseProxy.get_throughput
name: get_throughput
summary: "Get the ThroughputProperties object for this database.\nIf no ThroughputProperties\
@@ -406,12 +408,13 @@ methods:
examples:
- "List all containers in the database:<!--[!code-python[Main](les\\examples.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n database =\
- \ client.get_database_client(database_name)\n for container in database.list_containers():\n\
- \ print(\"Container ID: {}\".format(container['id']))\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n database = client.get_database_client(database_name)\n\
+ \ for container in database.list_containers():\n print(\"Container ID:\
+ \ {}\".format(container['id']))\n\n ````\n"
- uid: azure.cosmos.DatabaseProxy.list_users
name: list_users
summary: List all the users in the container.
@@ -604,15 +607,16 @@ methods:
examples:
- "Reset the TTL property on a container, and display the updated properties:<!--[!code-python[Main](les\\\
examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # Set the\
- \ TTL on the container to 3600 seconds (one hour)\n database.replace_container(container,\
- \ partition_key=PartitionKey(path='/productName'), default_ttl=3600)\n\n # Display\
- \ the new TTL setting for the container\n container_props = database.get_container_client(container_name).read()\n\
- \ print(\"New container TTL: {}\".format(json.dumps(container_props['defaultTtl'])))\n\
- \n ````\n"
+ : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n # Set the TTL on the container\
+ \ to 3600 seconds (one hour)\n database.replace_container(container, partition_key=PartitionKey(path='/productName'),\
+ \ default_ttl=3600)\n\n # Display the new TTL setting for the container\n \
+ \ container_props = database.get_container_client(container_name).read()\n print(\"\
+ New container TTL: {}\".format(json.dumps(container_props['defaultTtl'])))\n\n\
+ \ ````\n"
- uid: azure.cosmos.DatabaseProxy.replace_throughput
name: replace_throughput
summary: Replace the database-level throughput.
diff --git a/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.ContainerProxy.yml b/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.ContainerProxy.yml
index 0b70868c4eae..874cc8e3eb12 100644
--- a/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.ContainerProxy.yml
+++ b/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.ContainerProxy.yml
@@ -443,24 +443,26 @@ methods:
examples:
- "Get all products that have not been discontinued:<!--[!code-python[Main](les\\\
examples_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"\
- names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\
- \\1\\\\s\\\\source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n import json\n\n async for item in container.query_items(\n\
- \ query='SELECT * FROM products p WHERE p.productModel <> \"\
- DISCONTINUED\"'\n ):\n print(json.dumps(item, indent=True))\n\
- \n ````\n\nParameterized query to get all products that have been discontinued:<!--[!code-python[Main](les\\\
+ names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples_async.py\", \"xml:space\": \"\
+ preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
+ linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import\
+ \ json\n\n async for item in container.query_items(\n \
+ \ query='SELECT * FROM products p WHERE p.productModel <> \"DISCONTINUED\"\
+ '\n ):\n print(json.dumps(item, indent=True))\n\n ````\n\
+ \nParameterized query to get all products that have been discontinued:<!--[!code-python[Main](les\\\
examples_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"\
- names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\
- \\1\\\\s\\\\source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n discontinued_items = container.query_items(\n query='SELECT\
- \ * FROM products p WHERE p.productModel = @model AND p.productName=\"Widget\"\
- ',\n parameters=[dict(name=\"@model\", value=\"DISCONTINUED\")],\n\
- \ )\n async for item in discontinued_items:\n \
- \ print(json.dumps(item, indent=True))\n\n ````\n"
+ names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples_async.py\", \"xml:space\": \"\
+ preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
+ linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n discontinued_items\
+ \ = container.query_items(\n query='SELECT * FROM products p WHERE\
+ \ p.productModel = @model AND p.productName=\"Widget\"',\n parameters=[dict(name=\"\
+ @model\", value=\"DISCONTINUED\")],\n )\n async for item in\
+ \ discontinued_items:\n print(json.dumps(item, indent=True))\n\n\
+ \ ````\n"
- uid: azure.cosmos.aio.ContainerProxy.query_items_change_feed
name: query_items_change_feed
summary: Get a sorted list of items that were changed, in the order in which they
@@ -627,13 +629,14 @@ methods:
examples:
- "Get an item from the database and update one of its properties:<!--[!code-python[Main](les\\\
examples_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"\
- names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\
- \\1\\\\s\\\\source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n item = await container.read_item(\"item2\", partition_key=\"Widget\"\
- )\n item[\"productModel\"] = \"DISCONTINUED\"\n updated_item\
- \ = await container.upsert_item(item)\n\n ````\n"
+ names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples_async.py\", \"xml:space\": \"\
+ preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
+ linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n item =\
+ \ await container.read_item(\"item2\", partition_key=\"Widget\")\n item[\"\
+ productModel\"] = \"DISCONTINUED\"\n updated_item = await container.upsert_item(item)\n\
+ \n ````\n"
- uid: azure.cosmos.aio.ContainerProxy.replace_item
name: replace_item
summary: 'Replaces the specified item if it exists in the container.
diff --git a/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.CosmosClient.yml b/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.CosmosClient.yml
index e1b4bf99fdf7..43cf295fb712 100644
--- a/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.CosmosClient.yml
+++ b/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.CosmosClient.yml
@@ -122,11 +122,12 @@ constructor:
examples:
- "Create a new instance of the Cosmos DB client:<!--[!code-python[Main](les\\examples_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n async with CosmosClient(url,\
- \ key) as client:\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\35\\\\azure-cosmos-4.5.1\\\
+ \\samples\\\\examples_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n async with CosmosClient(url, key) as client:\n\
+ \n ````\n"
methods:
- uid: azure.cosmos.aio.CosmosClient.close
name: close
@@ -181,10 +182,11 @@ methods:
examples:
- "Create a database in the Cosmos DB account:<!--[!code-python[Main](les\\examples_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples_async.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n database_name\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples_async.py\", \"xml:space\": \"\
+ preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
+ linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n database_name\
\ = \"testDatabase\"\n try:\n database = await client.create_database(id=database_name)\n\
\ except exceptions.CosmosResourceExistsError:\n database\
\ = client.get_database_client(database=database_name)\n\n ````\n"
diff --git a/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.DatabaseProxy.yml b/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.DatabaseProxy.yml
index 9a16b916ae71..26bf4d6e95e9 100644
--- a/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.DatabaseProxy.yml
+++ b/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.DatabaseProxy.yml
@@ -126,10 +126,11 @@ methods:
examples:
- "Create a container with default settings:<!--[!code-python[Main](les\\examples_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples_async.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n container_name\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples_async.py\", \"xml:space\": \"\
+ preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
+ linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n container_name\
\ = \"products\"\n try:\n container = await database.create_container(\n\
\ id=container_name, partition_key=PartitionKey(path=\"/productName\"\
)\n )\n except exceptions.CosmosResourceExistsError:\n\
@@ -137,8 +138,9 @@ methods:
\ ````\n\nCreate a container with specific settings; in this case, a custom\
\ partition key:<!--[!code-python[Main](les\\examples_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\36\\\\azure-cosmos-4.5.1\\\
- \\samples\\\\examples_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\35\\\\azure-cosmos-4.5.1\\\\\
+ samples\\\\examples_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
\ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
: false} -->\n\n````python\n\n customer_container_name = \"customers\"\
\n try:\n customer_container = await database.create_container(\n\
@@ -267,15 +269,16 @@ methods:
examples:
- "Create a database user:<!--[!code-python[Main](les\\examples_async.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n try:\n\
- \ await database.create_user(dict(id=\"Walter Harp\"))\n \
- \ print(\"Created user Walter Harp.\")\n except exceptions.CosmosResourceExistsError:\n\
- \ print(\"A user with that ID already exists.\")\n except\
- \ exceptions.CosmosHttpResponseError as failure:\n print(\"Failed\
- \ to create user. Status code:{}\".format(failure.status_code))\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\35\\\\azure-cosmos-4.5.1\\\
+ \\samples\\\\examples_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n try:\n await database.create_user(dict(id=\"\
+ Walter Harp\"))\n print(\"Created user Walter Harp.\")\n \
+ \ except exceptions.CosmosResourceExistsError:\n print(\"A user\
+ \ with that ID already exists.\")\n except exceptions.CosmosHttpResponseError\
+ \ as failure:\n print(\"Failed to create user. Status code:{}\"\
+ .format(failure.status_code))\n\n ````\n"
- uid: azure.cosmos.aio.DatabaseProxy.delete_container
name: delete_container
summary: Delete a container.
@@ -373,12 +376,13 @@ methods:
examples:
- "Get an existing container, handling a failure if encountered:<!--[!code-python[Main](les\\\
examples_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"\
- names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\
- \\1\\\\s\\\\source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n database = client.get_database_client(database_name)\n \
- \ container = database.get_container_client(container_name)\n\n ````\n"
+ names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples_async.py\", \"xml:space\": \"\
+ preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
+ linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n database\
+ \ = client.get_database_client(database_name)\n container = database.get_container_client(container_name)\n\
+ \n ````\n"
- uid: azure.cosmos.aio.DatabaseProxy.get_throughput
name: get_throughput
summary: 'Get the ThroughputProperties object for this database.
@@ -447,10 +451,11 @@ methods:
examples:
- "List all containers in the database:<!--[!code-python[Main](les\\examples_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples_async.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n database\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples_async.py\", \"xml:space\": \"\
+ preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
+ linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n database\
\ = client.get_database_client(database_name)\n async for container\
\ in database.list_containers():\n print(\"Container ID: {}\".format(container['id']))\n\
\n ````\n"
@@ -651,16 +656,17 @@ methods:
examples:
- "Reset the TTL property on a container, and display the updated properties:<!--[!code-python[Main](les\\\
examples_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"\
- names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\
- \\1\\\\s\\\\source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # Set the TTL on the container to 3600 seconds (one hour)\n \
- \ await database.replace_container(container, partition_key=PartitionKey(path='/productName'),\
- \ default_ttl=3600)\n\n # Display the new TTL setting for the container\n\
- \ container_props = await database.get_container_client(container_name).read()\n\
- \ print(\"New container TTL: {}\".format(json.dumps(container_props['defaultTtl'])))\n\
- \n ````\n"
+ names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples_async.py\", \"xml:space\": \"\
+ preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
+ linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # Set the\
+ \ TTL on the container to 3600 seconds (one hour)\n await database.replace_container(container,\
+ \ partition_key=PartitionKey(path='/productName'), default_ttl=3600)\n\n \
+ \ # Display the new TTL setting for the container\n container_props\
+ \ = await database.get_container_client(container_name).read()\n print(\"\
+ New container TTL: {}\".format(json.dumps(container_props['defaultTtl'])))\n\n\
+ \ ````\n"
- uid: azure.cosmos.aio.DatabaseProxy.replace_throughput
name: replace_throughput
summary: 'Replace the database-level throughput.
diff --git a/docs-ref-autogen/azure-cosmos/azure.cosmos.container.ContainerProxy.yml b/docs-ref-autogen/azure-cosmos/azure.cosmos.container.ContainerProxy.yml
index 8d621d6380c2..66113071147a 100644
--- a/docs-ref-autogen/azure-cosmos/azure.cosmos.container.ContainerProxy.yml
+++ b/docs-ref-autogen/azure-cosmos/azure.cosmos.container.ContainerProxy.yml
@@ -409,23 +409,25 @@ methods:
examples:
- "Get all products that have not been discontinued:<!--[!code-python[Main](les\\\
examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import json\n\
- \n for item in container.query_items(\n query='SELECT * FROM products\
- \ p WHERE p.productModel <> \"DISCONTINUED\"',\n enable_cross_partition_query=True,\n\
- \ ):\n print(json.dumps(item, indent=True))\n\n ````\n\nParameterized\
- \ query to get all products that have been discontinued:<!--[!code-python[Main](les\\\
- examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n discontinued_items\
- \ = container.query_items(\n query='SELECT * FROM products p WHERE p.productModel\
- \ = @model AND p.productName=\"Widget\"',\n parameters=[dict(name=\"@model\"\
- , value=\"DISCONTINUED\")],\n )\n for item in discontinued_items:\n \
- \ print(json.dumps(item, indent=True))\n\n ````\n"
+ : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n import json\n\n for item in\
+ \ container.query_items(\n query='SELECT * FROM products p WHERE p.productModel\
+ \ <> \"DISCONTINUED\"',\n enable_cross_partition_query=True,\n ):\n \
+ \ print(json.dumps(item, indent=True))\n\n ````\n\nParameterized query to\
+ \ get all products that have been discontinued:<!--[!code-python[Main](les\\examples.py\
+ \ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n discontinued_items = container.query_items(\n\
+ \ query='SELECT * FROM products p WHERE p.productModel = @model AND p.productName=\"\
+ Widget\"',\n parameters=[dict(name=\"@model\", value=\"DISCONTINUED\")],\n\
+ \ )\n for item in discontinued_items:\n print(json.dumps(item, indent=True))\n\
+ \n ````\n"
- uid: azure.cosmos.container.ContainerProxy.query_items_change_feed
name: query_items_change_feed
summary: Get a sorted list of items that were changed, in the order in which they
@@ -582,10 +584,11 @@ methods:
examples:
- "Get an item from the database and update one of its properties:<!--[!code-python[Main](les\\\
examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n item = container.read_item(\"\
+ : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n item = container.read_item(\"\
item2\", partition_key=\"Widget\")\n item[\"productModel\"] = \"DISCONTINUED\"\
\n updated_item = container.upsert_item(item)\n\n ````\n"
- uid: azure.cosmos.container.ContainerProxy.read_offer
diff --git a/docs-ref-autogen/azure-cosmos/azure.cosmos.cosmos_client.CosmosClient.yml b/docs-ref-autogen/azure-cosmos/azure.cosmos.cosmos_client.CosmosClient.yml
index ab24147a01c1..fb90516030ad 100644
--- a/docs-ref-autogen/azure-cosmos/azure.cosmos.cosmos_client.CosmosClient.yml
+++ b/docs-ref-autogen/azure-cosmos/azure.cosmos.cosmos_client.CosmosClient.yml
@@ -123,13 +123,13 @@ constructor:
examples:
- "Create a new instance of the Cosmos DB client:<!--[!code-python[Main](les\\examples.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.cosmos import exceptions,\
- \ CosmosClient, PartitionKey\n\n import os\n\n url = os.environ[\"ACCOUNT_URI\"\
- ]\n key = os.environ[\"ACCOUNT_KEY\"]\n client = CosmosClient(url, key)\n\n\
- \ ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\35\\\\azure-cosmos-4.5.1\\\
+ \\samples\\\\examples.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
+ : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
+ \n````python\n\n from azure.cosmos import exceptions, CosmosClient, PartitionKey\n\
+ \n import os\n\n url = os.environ[\"ACCOUNT_URI\"]\n key = os.environ[\"ACCOUNT_KEY\"\
+ ]\n client = CosmosClient(url, key)\n\n ````\n"
methods:
- uid: azure.cosmos.cosmos_client.CosmosClient.create_database
name: create_database
@@ -178,12 +178,13 @@ methods:
examples:
- "Create a database in the Cosmos DB account:<!--[!code-python[Main](les\\examples.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n database_name\
- \ = \"testDatabase\"\n try:\n database = client.create_database(id=database_name)\n\
- \ except exceptions.CosmosResourceExistsError:\n database = client.get_database_client(database=database_name)\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n database_name = \"testDatabase\"\
+ \n try:\n database = client.create_database(id=database_name)\n except\
+ \ exceptions.CosmosResourceExistsError:\n database = client.get_database_client(database=database_name)\n\
\n ````\n"
- uid: azure.cosmos.cosmos_client.CosmosClient.create_database_if_not_exists
name: create_database_if_not_exists
diff --git a/docs-ref-autogen/azure-cosmos/azure.cosmos.database.DatabaseProxy.yml b/docs-ref-autogen/azure-cosmos/azure.cosmos.database.DatabaseProxy.yml
index 002debb11070..a453659eabab 100644
--- a/docs-ref-autogen/azure-cosmos/azure.cosmos.database.DatabaseProxy.yml
+++ b/docs-ref-autogen/azure-cosmos/azure.cosmos.database.DatabaseProxy.yml
@@ -120,25 +120,26 @@ methods:
examples:
- "Create a container with default settings:<!--[!code-python[Main](les\\examples.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n container_name\
- \ = \"products\"\n try:\n container = database.create_container(\n \
- \ id=container_name, partition_key=PartitionKey(path=\"/productName\")\n\
- \ )\n except exceptions.CosmosResourceExistsError:\n container =\
- \ database.get_container_client(container_name)\n\n ````\n\nCreate a container\
- \ with specific settings; in this case, a custom partition key:<!--[!code-python[Main](les\\\
- examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n customer_container_name\
- \ = \"customers\"\n try:\n customer_container = database.create_container(\n\
- \ id=customer_container_name,\n partition_key=PartitionKey(path=\"\
- /city\"),\n default_ttl=200,\n )\n except exceptions.CosmosResourceExistsError:\n\
- \ customer_container = database.get_container_client(customer_container_name)\n\
- \n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n container_name = \"products\"\
+ \n try:\n container = database.create_container(\n id=container_name,\
+ \ partition_key=PartitionKey(path=\"/productName\")\n )\n except exceptions.CosmosResourceExistsError:\n\
+ \ container = database.get_container_client(container_name)\n\n ````\n\
+ \nCreate a container with specific settings; in this case, a custom partition\
+ \ key:<!--[!code-python[Main](les\\examples.py )]-->\n\n<!-- literal_block {\"\
+ ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\35\\\\azure-cosmos-4.5.1\\\\\
+ samples\\\\examples.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
+ : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
+ \n````python\n\n customer_container_name = \"customers\"\n try:\n customer_container\
+ \ = database.create_container(\n id=customer_container_name,\n \
+ \ partition_key=PartitionKey(path=\"/city\"),\n default_ttl=200,\n\
+ \ )\n except exceptions.CosmosResourceExistsError:\n customer_container\
+ \ = database.get_container_client(customer_container_name)\n\n ````\n"
- uid: azure.cosmos.database.DatabaseProxy.create_container_if_not_exists
name: create_container_if_not_exists
summary: 'Create a container if it does not exist already.
@@ -252,10 +253,11 @@ methods:
examples:
- "Create a database user:<!--[!code-python[Main](les\\examples.py )]-->\n\n<!--\
\ literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [],\
- \ \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\\
- 36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n try:\n database.create_user(dict(id=\"\
+ \ \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\35\\\\azure-cosmos-4.5.1\\\
+ \\samples\\\\examples.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n try:\n database.create_user(dict(id=\"\
Walter Harp\"))\n except exceptions.CosmosResourceExistsError:\n print(\"\
A user with that ID already exists.\")\n except exceptions.CosmosHttpResponseError\
\ as failure:\n print(\"Failed to create user. Status code:{}\".format(failure.status_code))\n\
@@ -346,12 +348,12 @@ methods:
examples:
- "Get an existing container, handling a failure if encountered:<!--[!code-python[Main](les\\\
examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n database =\
- \ client.get_database_client(database_name)\n container = database.get_container_client(container_name)\n\
- \n ````\n"
+ : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n database = client.get_database_client(database_name)\n\
+ \ container = database.get_container_client(container_name)\n\n ````\n"
- uid: azure.cosmos.database.DatabaseProxy.get_throughput
name: get_throughput
summary: "Get the ThroughputProperties object for this database.\nIf no ThroughputProperties\
@@ -406,12 +408,13 @@ methods:
examples:
- "List all containers in the database:<!--[!code-python[Main](les\\examples.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n database =\
- \ client.get_database_client(database_name)\n for container in database.list_containers():\n\
- \ print(\"Container ID: {}\".format(container['id']))\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n database = client.get_database_client(database_name)\n\
+ \ for container in database.list_containers():\n print(\"Container ID:\
+ \ {}\".format(container['id']))\n\n ````\n"
- uid: azure.cosmos.database.DatabaseProxy.list_users
name: list_users
summary: List all the users in the container.
@@ -605,15 +608,16 @@ methods:
examples:
- "Reset the TTL property on a container, and display the updated properties:<!--[!code-python[Main](les\\\
examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\source_code\\\\36\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # Set the\
- \ TTL on the container to 3600 seconds (one hour)\n database.replace_container(container,\
- \ partition_key=PartitionKey(path='/productName'), default_ttl=3600)\n\n # Display\
- \ the new TTL setting for the container\n container_props = database.get_container_client(container_name).read()\n\
- \ print(\"New container TTL: {}\".format(json.dumps(container_props['defaultTtl'])))\n\
- \n ````\n"
+ : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\35\\\\azure-cosmos-4.5.1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n # Set the TTL on the container\
+ \ to 3600 seconds (one hour)\n database.replace_container(container, partition_key=PartitionKey(path='/productName'),\
+ \ default_ttl=3600)\n\n # Display the new TTL setting for the container\n \
+ \ container_props = database.get_container_client(container_name).read()\n print(\"\
+ New container TTL: {}\".format(json.dumps(container_props['defaultTtl'])))\n\n\
+ \ ````\n"
- uid: azure.cosmos.database.DatabaseProxy.replace_throughput
name: replace_throughput
summary: Replace the database-level throughput.
diff --git a/docs-ref-autogen/azure-data-tables/azure.data.tables.TableClient.yml b/docs-ref-autogen/azure-data-tables/azure.data.tables.TableClient.yml
index 70f15a0e873a..00ce9436d376 100644
--- a/docs-ref-autogen/azure-data-tables/azure.data.tables.TableClient.yml
+++ b/docs-ref-autogen/azure-data-tables/azure.data.tables.TableClient.yml
@@ -92,8 +92,9 @@ methods:
examples:
- "Creating and adding an entity to a Table<!--[!code-python[Main](les\\sample_insert_delete_entities.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_insert_delete_entities.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 37\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_insert_delete_entities.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n try:\n resp = table_client.create_entity(entity=self.entity)\n \
@@ -113,9 +114,10 @@ methods:
examples:
- "Creating a table from the TableClient object<!--[!code-python[Main](les\\sample_create_delete_table.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_create_delete_table.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 37\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_create_delete_table.py\",\
+ \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n with TableClient.from_connection_string(\n conn_str=self.connection_string,\
\ table_name=self.table_name\n ) as table_client:\n try:\n table_item\
@@ -164,8 +166,9 @@ methods:
examples:
- "Deleting an entity of a Table<!--[!code-python[Main](les\\sample_insert_delete_entities.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_insert_delete_entities.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 37\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_insert_delete_entities.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n table_client.delete_entity(row_key=self.entity[\"RowKey\"], partition_key=self.entity[\"\
@@ -183,9 +186,10 @@ methods:
examples:
- "Deleting a table from the TableClient object<!--[!code-python[Main](les\\sample_create_delete_table.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_create_delete_table.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 37\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_create_delete_table.py\",\
+ \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n with TableClient.from_connection_string(\n conn_str=self.connection_string,\
\ table_name=self.table_name\n ) as table_client:\n table_client.delete_table()\n\
@@ -213,14 +217,14 @@ methods:
examples:
- "Authenticating a TableServiceClient from a connection_string<!--[!code-python[Main](les\\\
sample_create_client.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\
- \\sample_create_client.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
- language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.data.tables import TableClient\n\n\
- \ with TableClient.from_connection_string(\n conn_str=self.connection_string,\
- \ table_name=\"tableName\"\n ) as table_client:\n print(\"Table name:\
- \ {}\".format(table_client.table_name))\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\37\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_create_client.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.data.tables import TableClient\n\n with TableClient.from_connection_string(\n\
+ \ conn_str=self.connection_string, table_name=\"tableName\"\n ) as table_client:\n\
+ \ print(\"Table name: {}\".format(table_client.table_name))\n\n ````\n"
- uid: azure.data.tables.TableClient.from_table_url
name: from_table_url
summary: "A client to interact with a specific Table.\n\nAzureSasCredential (azure-core),\
@@ -265,8 +269,9 @@ methods:
examples:
- "Get a single entity from a table<!--[!code-python[Main](les\\sample_update_upsert_merge_entities.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_update_upsert_merge_entities.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 37\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_update_upsert_merge_entities.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Get Entity by partition and row key\n got_entity = table.get_entity(partition_key=my_entity[\"\
@@ -309,8 +314,9 @@ methods:
examples:
- "List all entities held within a table<!--[!code-python[Main](les\\sample_update_upsert_merge_entities.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_update_upsert_merge_entities.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 37\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_update_upsert_merge_entities.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Query the entities in the table\n entities = list(table.list_entities())\n\
@@ -350,14 +356,14 @@ methods:
examples:
- "Query entities held within a table<!--[!code-python[Main](les\\sample_query_table.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_query_table.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n with TableClient.from_connection_string(self.connection_string, self.table_name)\
- \ as table_client:\n try:\n print(\"Basic sample:\")\n \
- \ print(\"Entities with name: marker\")\n parameters = {\"name\"\
- : \"marker\"}\n name_filter = \"Name eq @name\"\n queried_entities\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 37\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_query_table.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n with TableClient.from_connection_string(self.connection_string,\
+ \ self.table_name) as table_client:\n try:\n print(\"Basic sample:\"\
+ )\n print(\"Entities with name: marker\")\n parameters = {\"\
+ name\": \"marker\"}\n name_filter = \"Name eq @name\"\n queried_entities\
\ = table_client.query_entities(\n query_filter=name_filter, select=[\"\
Brand\", \"Color\"], parameters=parameters\n )\n\n for entity_chosen\
\ in queried_entities:\n print(entity_chosen)\n\n print(\"\
@@ -432,16 +438,17 @@ methods:
examples:
- "Using transactions to send multiple requests at once<!--[!code-python[Main](les\\\
sample_batching.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
- \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\\
- _work\\\\1\\\\s\\\\source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\\\
- sample_batching.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
- : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
- \n````python\n\n from azure.data.tables import TableClient, TableTransactionError\n\
- \ from azure.core.exceptions import ResourceExistsError\n\n self.table_client\
- \ = TableClient.from_connection_string(\n conn_str=self.connection_string,\
- \ table_name=self.table_name\n )\n\n try:\n self.table_client.create_table()\n\
- \ print(\"Created table\")\n except ResourceExistsError:\n print(\"\
- Table already exists\")\n\n self.table_client.upsert_entity(entity2)\n self.table_client.upsert_entity(entity3)\n\
+ \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\37\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_batching.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.data.tables\
+ \ import TableClient, TableTransactionError\n from azure.core.exceptions import\
+ \ ResourceExistsError\n\n self.table_client = TableClient.from_connection_string(\n\
+ \ conn_str=self.connection_string, table_name=self.table_name\n )\n\n\
+ \ try:\n self.table_client.create_table()\n print(\"Created table\"\
+ )\n except ResourceExistsError:\n print(\"Table already exists\")\n\n\
+ \ self.table_client.upsert_entity(entity2)\n self.table_client.upsert_entity(entity3)\n\
\ self.table_client.upsert_entity(entity4)\n\n operations = [\n (\"\
upsert\", entity1),\n (\"delete\", entity2),\n (\"upsert\", entity3),\n\
\ (\"update\", entity4, {\"mode\": \"replace\"}),\n ]\n try:\n \
@@ -486,8 +493,9 @@ methods:
examples:
- "Updating an already exiting entity in a Table<!--[!code-python[Main](les\\sample_update_upsert_merge_entities.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_update_upsert_merge_entities.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 37\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_update_upsert_merge_entities.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Update the entity\n created[\"text\"] = \"NewMarker\"\n table.update_entity(mode=UpdateMode.REPLACE,\
@@ -524,8 +532,9 @@ methods:
examples:
- "Update/merge or insert an entity into a table<!--[!code-python[Main](les\\sample_update_upsert_merge_entities.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_update_upsert_merge_entities.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 37\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_update_upsert_merge_entities.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Try Replace and insert on fail\n insert_entity = table.upsert_entity(mode=UpdateMode.REPLACE,\
diff --git a/docs-ref-autogen/azure-data-tables/azure.data.tables.TableServiceClient.yml b/docs-ref-autogen/azure-data-tables/azure.data.tables.TableServiceClient.yml
index 863571d973c1..fc552e3921bb 100644
--- a/docs-ref-autogen/azure-data-tables/azure.data.tables.TableServiceClient.yml
+++ b/docs-ref-autogen/azure-data-tables/azure.data.tables.TableServiceClient.yml
@@ -89,32 +89,34 @@ variables:
examples:
- "Authenticating a TableServiceClient from a Shared Access Key<!--[!code-python[Main](les\\\
sample_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\":\
- \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\\\
- sample_authentication.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
- : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
- \n````python\n\n from azure.data.tables import TableServiceClient\n from azure.core.credentials\
- \ import AzureNamedKeyCredential, AzureSasCredential\n\n # Create a SAS token\
- \ to use for authentication of a client\n from azure.data.tables import generate_account_sas,\
- \ ResourceTypes, AccountSasPermissions\n\n print(\"Account name: {}\".format(self.account_name))\n\
- \ credential = AzureNamedKeyCredential(self.account_name, self.access_key) #\
- \ type: ignore[arg-type]\n sas_token = generate_account_sas(\n credential,\n\
- \ resource_types=ResourceTypes(service=True),\n permission=AccountSasPermissions(read=True),\n\
- \ expiry=datetime.utcnow() + timedelta(hours=1),\n )\n\n with TableServiceClient(\n\
- \ endpoint=self.endpoint, credential=AzureSasCredential(sas_token)\n ) as\
- \ token_auth_table_service:\n properties = token_auth_table_service.get_service_properties()\n\
- \ print(\"Shared Access Signature: {}\".format(properties))\n\n ````\n\n\
- Authenticating a TableServiceClient from a Shared Account Key<!--[!code-python[Main](les\\\
- sample_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\":\
- \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\\\
- sample_authentication.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
- : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
- \n````python\n\n from azure.data.tables import TableServiceClient\n from azure.core.credentials\
- \ import AzureNamedKeyCredential\n\n credential = AzureNamedKeyCredential(self.account_name,\
- \ self.access_key) # type: ignore[arg-type]\n with TableServiceClient(endpoint=self.endpoint,\
- \ credential=credential) as table_service:\n properties = table_service.get_service_properties()\n\
- \ print(\"Shared Key: {}\".format(properties))\n\n ````\n"
+ \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\37\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_authentication.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
+ \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.data.tables\
+ \ import TableServiceClient\n from azure.core.credentials import AzureNamedKeyCredential,\
+ \ AzureSasCredential\n\n # Create a SAS token to use for authentication of a client\n\
+ \ from azure.data.tables import generate_account_sas, ResourceTypes, AccountSasPermissions\n\
+ \n print(\"Account name: {}\".format(self.account_name))\n credential = AzureNamedKeyCredential(self.account_name,\
+ \ self.access_key) # type: ignore[arg-type]\n sas_token = generate_account_sas(\n\
+ \ credential,\n resource_types=ResourceTypes(service=True),\n \
+ \ permission=AccountSasPermissions(read=True),\n expiry=datetime.utcnow()\
+ \ + timedelta(hours=1),\n )\n\n with TableServiceClient(\n endpoint=self.endpoint,\
+ \ credential=AzureSasCredential(sas_token)\n ) as token_auth_table_service:\n\
+ \ properties = token_auth_table_service.get_service_properties()\n print(\"\
+ Shared Access Signature: {}\".format(properties))\n\n ````\n\nAuthenticating a\
+ \ TableServiceClient from a Shared Account Key<!--[!code-python[Main](les\\sample_authentication.py\
+ \ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\37\\\\azure-data-tables-12.4.4\\\
+ \\samples\\\\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.data.tables import TableServiceClient\n\
+ \ from azure.core.credentials import AzureNamedKeyCredential\n\n credential\
+ \ = AzureNamedKeyCredential(self.account_name, self.access_key) # type: ignore[arg-type]\n\
+ \ with TableServiceClient(endpoint=self.endpoint, credential=credential) as table_service:\n\
+ \ properties = table_service.get_service_properties()\n print(\"Shared\
+ \ Key: {}\".format(properties))\n\n ````\n"
methods:
- uid: azure.data.tables.TableServiceClient.close
name: close
@@ -141,12 +143,13 @@ methods:
examples:
- "Creating a table from the TableServiceClient object<!--[!code-python[Main](les\\\
sample_create_delete_table.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\
- \\sample_create_delete_table.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n with TableServiceClient.from_connection_string(self.connection_string)\
- \ as table_service_client:\n try:\n table_client = table_service_client.create_table(table_name=self.table_name)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\37\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_create_delete_table.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n with TableServiceClient.from_connection_string(self.connection_string) as\
+ \ table_service_client:\n try:\n table_client = table_service_client.create_table(table_name=self.table_name)\n\
\ print(\"Created table {}!\".format(table_client.table_name))\n \
\ except ResourceExistsError:\n print(\"Table already exists\")\n\
\n ````\n"
@@ -173,12 +176,13 @@ methods:
examples:
- "Creating a table if it doesn't exist, from the TableServiceClient object<!--[!code-python[Main](les\\\
sample_create_delete_table.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\
- \\sample_create_delete_table.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n with TableServiceClient.from_connection_string(self.connection_string)\
- \ as table_service_client:\n table_client = table_service_client.create_table_if_not_exists(table_name=self.table_name)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\37\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_create_delete_table.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n with TableServiceClient.from_connection_string(self.connection_string) as\
+ \ table_service_client:\n table_client = table_service_client.create_table_if_not_exists(table_name=self.table_name)\n\
\ print(\"Table name: {}\".format(table_client.table_name))\n\n ````\n"
- uid: azure.data.tables.TableServiceClient.delete_table
name: delete_table
@@ -199,12 +203,13 @@ methods:
examples:
- "Deleting a table from the TableServiceClient object<!--[!code-python[Main](les\\\
sample_create_delete_table.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\
- \\sample_create_delete_table.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n with TableServiceClient.from_connection_string(self.connection_string)\
- \ as table_service_client:\n table_service_client.delete_table(table_name=self.table_name)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\37\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_create_delete_table.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n with TableServiceClient.from_connection_string(self.connection_string) as\
+ \ table_service_client:\n table_service_client.delete_table(table_name=self.table_name)\n\
\ print(\"Deleted table {}!\".format(self.table_name))\n\n ````\n"
- uid: azure.data.tables.TableServiceClient.from_connection_string
name: from_connection_string
@@ -223,12 +228,12 @@ methods:
examples:
- "Authenticating a TableServiceClient from a connection_string<!--[!code-python[Main](les\\\
sample_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\
- \\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
- language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.data.tables import TableServiceClient\n\
- \n with TableServiceClient.from_connection_string(conn_str=self.connection_string)\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\37\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_authentication.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.data.tables import TableServiceClient\n\n with TableServiceClient.from_connection_string(conn_str=self.connection_string)\
\ as table_service:\n properties = table_service.get_service_properties()\n\
\ print(\"Connection String: {}\".format(properties))\n\n ````\n"
- uid: azure.data.tables.TableServiceClient.get_service_properties
@@ -292,12 +297,13 @@ methods:
examples:
- "Listing all tables in a storage account<!--[!code-python[Main](les\\sample_query_tables.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_query_tables.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # List all the tables in the service\n list_tables = table_service.list_tables()\n\
- \ print(\"Listing tables:\")\n for table in list_tables:\n print(\"\\\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 37\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_query_tables.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # List all\
+ \ the tables in the service\n list_tables = table_service.list_tables()\n \
+ \ print(\"Listing tables:\")\n for table in list_tables:\n print(\"\\\
t{}\".format(table.name))\n\n ````\n"
- uid: azure.data.tables.TableServiceClient.query_tables
name: query_tables
@@ -326,11 +332,12 @@ methods:
examples:
- "Querying tables in a storage account<!--[!code-python[Main](les\\sample_query_tables.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_query_tables.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n table_name = \"mytable1\"\n name_filter = \"TableName eq '{}'\".format(table_name)\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 37\\\\azure-data-tables-12.4.4\\\\samples\\\\sample_query_tables.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n table_name\
+ \ = \"mytable1\"\n name_filter = \"TableName eq '{}'\".format(table_name)\n\
\ queried_tables = table_service.query_tables(name_filter)\n\n print(\"Queried_tables\"\
)\n for table in queried_tables:\n print(\"\\t{}\".format(table.name))\n\
\n ````\n"
diff --git a/docs-ref-autogen/azure-data-tables/azure.data.tables.aio.TableClient.yml b/docs-ref-autogen/azure-data-tables/azure.data.tables.aio.TableClient.yml
index 0069b1445a54..eb17777482c5 100644
--- a/docs-ref-autogen/azure-data-tables/azure.data.tables.aio.TableClient.yml
+++ b/docs-ref-autogen/azure-data-tables/azure.data.tables.aio.TableClient.yml
@@ -88,16 +88,16 @@ methods:
examples:
- "Adding an entity to a Table<!--[!code-python[Main](les\\async_samples\\sample_insert_delete_entities_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\\async_samples\\\\\
- sample_insert_delete_entities_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n async with table_client:\n try:\n\
- \ await table_client.create_table()\n except HttpResponseError:\n\
- \ print(\"Table already exists\")\n\n try:\n resp =\
- \ await table_client.create_entity(entity=self.entity)\n print(resp)\n\
- \ except ResourceExistsError:\n print(\"Entity already exists\"\
- )\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 37\\\\azure-data-tables-12.4.4\\\\samples\\\\async_samples\\\\sample_insert_delete_entities_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n async with table_client:\n try:\n await table_client.create_table()\n\
+ \ except HttpResponseError:\n print(\"Table already exists\")\n\
+ \n try:\n resp = await table_client.create_entity(entity=self.entity)\n\
+ \ print(resp)\n except ResourceExistsError:\n print(\"\
+ Entity already exists\")\n\n ````\n"
- uid: azure.data.tables.aio.TableClient.create_table
name: create_table
summary: Creates a new table under the given account.
@@ -151,16 +151,16 @@ methods:
examples:
- "Adding an entity to a Table<!--[!code-python[Main](les\\async_samples\\sample_insert_delete_entities_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\\async_samples\\\\\
- sample_insert_delete_entities_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n async with table_client:\n try:\n\
- \ resp = await table_client.create_entity(entity=self.entity)\n \
- \ except ResourceExistsError:\n print(\"Entity already exists!\")\n\
- \n await table_client.delete_entity(row_key=self.entity[\"RowKey\"], partition_key=self.entity[\"\
- PartitionKey\"]) # type: ignore[call-overload]\n print(\"Successfully deleted!\"\
- )\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 37\\\\azure-data-tables-12.4.4\\\\samples\\\\async_samples\\\\sample_insert_delete_entities_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n async with table_client:\n try:\n resp = await table_client.create_entity(entity=self.entity)\n\
+ \ except ResourceExistsError:\n print(\"Entity already exists!\"\
+ )\n\n await table_client.delete_entity(row_key=self.entity[\"RowKey\"],\
+ \ partition_key=self.entity[\"PartitionKey\"]) # type: ignore[call-overload]\n\
+ \ print(\"Successfully deleted!\")\n\n ````\n"
- uid: azure.data.tables.aio.TableClient.delete_table
name: delete_table
summary: 'Deletes the table under the current account. No error will be raised if
@@ -175,13 +175,14 @@ methods:
- "Deleting a table from the TableClient object.<!--[!code-python[Main](les\\async_samples\\\
sample_create_delete_table_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\38\\\\azure-data-tables-12.4.4\\\
- \\samples\\\\async_samples\\\\sample_create_delete_table_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n async with\
- \ TableClient.from_connection_string(\n conn_str=self.connection_string,\
- \ table_name=self.table_name\n ) as table_client:\n await table_client.delete_table()\n\
- \ print(\"Deleted table {}!\".format(table_client.table_name))\n\n ````\n"
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\37\\\\azure-data-tables-12.4.4\\\\samples\\\\async_samples\\\
+ \\sample_create_delete_table_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n async with TableClient.from_connection_string(\n\
+ \ conn_str=self.connection_string, table_name=self.table_name\n ) as table_client:\n\
+ \ await table_client.delete_table()\n print(\"Deleted table {}!\"\
+ .format(table_client.table_name))\n\n ````\n"
- uid: azure.data.tables.aio.TableClient.from_connection_string
name: from_connection_string
summary: Create TableClient from a Connection string.
@@ -206,13 +207,14 @@ methods:
- "Creating the TableClient from a connection string.<!--[!code-python[Main](les\\\
async_samples\\sample_create_client_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\38\\\\azure-data-tables-12.4.4\\\
- \\samples\\\\async_samples\\\\sample_create_client_async.py\", \"xml:space\":\
- \ \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.data.tables.aio\
- \ import TableClient\n\n async with TableClient.from_connection_string(\n \
- \ conn_str=self.connection_string, table_name=\"tableName\"\n ) as table_client:\n\
- \ print(\"Table name: {}\".format(table_client.table_name))\n\n ````\n"
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\37\\\\azure-data-tables-12.4.4\\\\samples\\\\async_samples\\\
+ \\sample_create_client_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.data.tables.aio import TableClient\n\
+ \n async with TableClient.from_connection_string(\n conn_str=self.connection_string,\
+ \ table_name=\"tableName\"\n ) as table_client:\n print(\"Table name:\
+ \ {}\".format(table_client.table_name))\n\n ````\n"
- uid: azure.data.tables.aio.TableClient.from_table_url
name: from_table_url
summary: A client to interact with a specific Table.
@@ -267,14 +269,14 @@ methods:
- "Getting an entity from PartitionKey and RowKey<!--[!code-python[Main](les\\async_samples\\\
sample_update_upsert_merge_entities_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\38\\\\azure-data-tables-12.4.4\\\
- \\samples\\\\async_samples\\\\sample_update_upsert_merge_entities_async.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # Get Entity by partition and row key\n got_entity = await table.get_entity(\n\
- \ partition_key=my_entity[\"PartitionKey\"], row_key=my_entity[\"RowKey\"\
- ] # type: ignore[arg-type]\n )\n print(\"Received entity: {}\".format(got_entity))\n\
- \n ````\n"
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\37\\\\azure-data-tables-12.4.4\\\\samples\\\\async_samples\\\
+ \\sample_update_upsert_merge_entities_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n # Get Entity by partition and\
+ \ row key\n got_entity = await table.get_entity(\n partition_key=my_entity[\"\
+ PartitionKey\"], row_key=my_entity[\"RowKey\"] # type: ignore[arg-type]\n )\n\
+ \ print(\"Received entity: {}\".format(got_entity))\n\n ````\n"
- uid: azure.data.tables.aio.TableClient.get_table_access_policy
name: get_table_access_policy
summary: 'Retrieves details about any stored access policies specified on the table
@@ -314,12 +316,13 @@ methods:
- "Querying entities from a TableClient<!--[!code-python[Main](les\\async_samples\\\
sample_update_upsert_merge_entities_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\38\\\\azure-data-tables-12.4.4\\\
- \\samples\\\\async_samples\\\\sample_update_upsert_merge_entities_async.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # Query the entities in the table\n i = 0\n async for entity in table.list_entities():\n\
- \ print(\"Entity #{}: {}\".format(i, entity))\n i += 1\n\n ````\n"
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\37\\\\azure-data-tables-12.4.4\\\\samples\\\\async_samples\\\
+ \\sample_update_upsert_merge_entities_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n # Query the entities in the\
+ \ table\n i = 0\n async for entity in table.list_entities():\n print(\"\
+ Entity #{}: {}\".format(i, entity))\n i += 1\n\n ````\n"
- uid: azure.data.tables.aio.TableClient.query_entities
name: query_entities
summary: Lists entities in a table.
@@ -354,11 +357,12 @@ methods:
examples:
- "Querying entities from a TableClient<!--[!code-python[Main](les\\async_samples\\\
sample_query_table_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\
- \\async_samples\\\\sample_query_table_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n async with TableClient.from_connection_string(self.connection_string,\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\37\\\\azure-data-tables-12.4.4\\\\samples\\\\async_samples\\\
+ \\sample_query_table_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n async with TableClient.from_connection_string(self.connection_string,\
\ self.table_name) as table_client:\n try:\n print(\"Basic sample:\"\
)\n print(\"Entities with name: marker\")\n parameters = {\"\
name\": \"marker\"}\n name_filter = \"Name eq @name\"\n queried_entities\
@@ -439,12 +443,13 @@ methods:
- "Using transactions to send multiple requests at once<!--[!code-python[Main](les\\\
async_samples\\sample_batching_async.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\38\\\\azure-data-tables-12.4.4\\\
- \\samples\\\\async_samples\\\\sample_batching_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.data.tables.aio import\
- \ TableClient\n from azure.data.tables import TableTransactionError\n from\
- \ azure.core.exceptions import ResourceExistsError\n\n self.table_client = TableClient.from_connection_string(\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\37\\\\azure-data-tables-12.4.4\\\\samples\\\\async_samples\\\
+ \\sample_batching_async.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.data.tables.aio import TableClient\n\
+ \ from azure.data.tables import TableTransactionError\n from azure.core.exceptions\
+ \ import ResourceExistsError\n\n self.table_client = TableClient.from_connection_string(\n\
\ conn_str=self.connection_string, table_name=self.table_name\n )\n\n\
\ try:\n await self.table_client.create_table()\n print(\"Created\
\ table\")\n except ResourceExistsError:\n print(\"Table already exists\"\
@@ -493,11 +498,12 @@ methods:
- "Querying entities from a TableClient<!--[!code-python[Main](les\\async_samples\\\
sample_update_upsert_merge_entities_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\38\\\\azure-data-tables-12.4.4\\\
- \\samples\\\\async_samples\\\\sample_update_upsert_merge_entities_async.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # Update the entity\n created[\"text\"] = \"NewMarker\"\n await table.update_entity(mode=UpdateMode.REPLACE,\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\37\\\\azure-data-tables-12.4.4\\\\samples\\\\async_samples\\\
+ \\sample_update_upsert_merge_entities_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n # Update the entity\n created[\"\
+ text\"] = \"NewMarker\"\n await table.update_entity(mode=UpdateMode.REPLACE,\
\ entity=created)\n\n # Get the replaced entity\n replaced = await table.get_entity(partition_key=created[\"\
PartitionKey\"], row_key=created[\"RowKey\"])\n print(\"Replaced entity: {}\"\
.format(replaced))\n\n # Merge the entity\n replaced[\"color\"] = \"Blue\"\
@@ -532,11 +538,12 @@ methods:
- "Update/Merge or Insert an entity into a table<!--[!code-python[Main](les\\async_samples\\\
sample_update_upsert_merge_entities_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\38\\\\azure-data-tables-12.4.4\\\
- \\samples\\\\async_samples\\\\sample_update_upsert_merge_entities_async.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # Try Replace and insert on fail\n insert_entity = await table.upsert_entity(mode=UpdateMode.REPLACE,\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\37\\\\azure-data-tables-12.4.4\\\\samples\\\\async_samples\\\
+ \\sample_update_upsert_merge_entities_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n # Try Replace and insert on\
+ \ fail\n insert_entity = await table.upsert_entity(mode=UpdateMode.REPLACE,\
\ entity=entity1)\n print(\"Inserted entity: {}\".format(insert_entity))\n\n\
\ created[\"text\"] = \"NewMarker\"\n merged_entity = await table.upsert_entity(mode=UpdateMode.MERGE,\
\ entity=entity)\n print(\"Merged entity: {}\".format(merged_entity))\n\n \
diff --git a/docs-ref-autogen/azure-data-tables/azure.data.tables.aio.TableServiceClient.yml b/docs-ref-autogen/azure-data-tables/azure.data.tables.aio.TableServiceClient.yml
index 987956475e16..c2219bc28603 100644
--- a/docs-ref-autogen/azure-data-tables/azure.data.tables.aio.TableServiceClient.yml
+++ b/docs-ref-autogen/azure-data-tables/azure.data.tables.aio.TableServiceClient.yml
@@ -92,24 +92,26 @@ examples:
- "Creating the tableServiceClient with an account url and credential.<!--[!code-python[Main](les\\\
async_samples\\sample_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\38\\\\azure-data-tables-12.4.4\\\
- \\samples\\\\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.data.tables.aio\
- \ import TableServiceClient\n\n async with TableServiceClient.from_connection_string(conn_str=self.connection_string)\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\37\\\\azure-data-tables-12.4.4\\\\samples\\\\async_samples\\\
+ \\sample_authentication_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.data.tables.aio import TableServiceClient\n\
+ \n async with TableServiceClient.from_connection_string(conn_str=self.connection_string)\
\ as table_service:\n properties = await table_service.get_service_properties()\n\
\ print(\"Shared Key: {}\".format(properties))\n\n ````\n\nCreating the\
\ tableServiceClient with Shared Access Signature.<!--[!code-python[Main](les\\\
async_samples\\sample_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\38\\\\azure-data-tables-12.4.4\\\
- \\samples\\\\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.data.tables.aio\
- \ import TableServiceClient\n from azure.core.credentials import AzureNamedKeyCredential,\
- \ AzureSasCredential\n\n # Create a SAS token to use for authentication of a client\n\
- \ from azure.data.tables import generate_account_sas, ResourceTypes, AccountSasPermissions\n\
- \n print(\"Account name: {}\".format(self.account_name))\n credential = AzureNamedKeyCredential(self.account_name,\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\37\\\\azure-data-tables-12.4.4\\\\samples\\\\async_samples\\\
+ \\sample_authentication_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.data.tables.aio import TableServiceClient\n\
+ \ from azure.core.credentials import AzureNamedKeyCredential, AzureSasCredential\n\
+ \n # Create a SAS token to use for authentication of a client\n from azure.data.tables\
+ \ import generate_account_sas, ResourceTypes, AccountSasPermissions\n\n print(\"\
+ Account name: {}\".format(self.account_name))\n credential = AzureNamedKeyCredential(self.account_name,\
\ self.access_key) # type: ignore[arg-type]\n sas_token = generate_account_sas(\n\
\ credential,\n resource_types=ResourceTypes(service=True),\n \
\ permission=AccountSasPermissions(read=True),\n expiry=datetime.utcnow()\
@@ -144,12 +146,12 @@ methods:
- "Creating a table from TableServiceClient.<!--[!code-python[Main](les\\async_samples\\\
sample_create_delete_table_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\38\\\\azure-data-tables-12.4.4\\\
- \\samples\\\\async_samples\\\\sample_create_delete_table_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n async with\
- \ TableServiceClient.from_connection_string(self.connection_string) as table_service_client:\n\
- \ try:\n table_client = await table_service_client.create_table(table_name=self.table_name)\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\37\\\\azure-data-tables-12.4.4\\\\samples\\\\async_samples\\\
+ \\sample_create_delete_table_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n async with TableServiceClient.from_connection_string(self.connection_string)\
+ \ as table_service_client:\n try:\n table_client = await table_service_client.create_table(table_name=self.table_name)\n\
\ print(\"Created table {}!\".format(table_client.table_name))\n \
\ except ResourceExistsError:\n print(\"Table already exists\")\n\
\n ````\n"
@@ -175,12 +177,12 @@ methods:
- "Creating a table if it does not already exist<!--[!code-python[Main](les\\async_samples\\\
sample_create_delete_table_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\38\\\\azure-data-tables-12.4.4\\\
- \\samples\\\\async_samples\\\\sample_create_delete_table_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n async with\
- \ TableServiceClient.from_connection_string(self.connection_string) as table_service_client:\n\
- \ table_client = await table_service_client.create_table_if_not_exists(table_name=self.table_name)\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\37\\\\azure-data-tables-12.4.4\\\\samples\\\\async_samples\\\
+ \\sample_create_delete_table_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n async with TableServiceClient.from_connection_string(self.connection_string)\
+ \ as table_service_client:\n table_client = await table_service_client.create_table_if_not_exists(table_name=self.table_name)\n\
\ print(\"Table name: {}\".format(table_client.table_name))\n\n ````\n"
- uid: azure.data.tables.aio.TableServiceClient.delete_table
name: delete_table
@@ -201,11 +203,12 @@ methods:
examples:
- "Deleting a table<!--[!code-python[Main](les\\async_samples\\sample_create_delete_table_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\\async_samples\\\\\
- sample_create_delete_table_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n async with TableServiceClient.from_connection_string(self.connection_string)\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 37\\\\azure-data-tables-12.4.4\\\\samples\\\\async_samples\\\\sample_create_delete_table_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n async with TableServiceClient.from_connection_string(self.connection_string)\
\ as table_service_client:\n await table_service_client.delete_table(table_name=self.table_name)\n\
\ print(\"Deleted table {}!\".format(self.table_name))\n\n ````\n"
- uid: azure.data.tables.aio.TableServiceClient.from_connection_string
@@ -226,7 +229,8 @@ methods:
- "Creating the tableServiceClient from a connection string<!--[!code-python[Main](les\\\
async_samples\\sample_authentication_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\38\\\\azure-data-tables-12.4.4\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\37\\\\azure-data-tables-12.4.4\\\
\\samples\\\\async_samples\\\\sample_authentication_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.data.tables.aio\
@@ -299,13 +303,14 @@ methods:
examples:
- "Listing all tables in an account<!--[!code-python[Main](les\\async_samples\\\
sample_query_tables_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\38\\\\azure-data-tables-12.4.4\\\\samples\\\
- \\async_samples\\\\sample_query_tables_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n # List all the tables in the\
- \ service\n print(\"Listing tables:\")\n async for table in table_service.list_tables():\n\
- \ print(\"\\t{}\".format(table.name))\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\37\\\\azure-data-tables-12.4.4\\\\samples\\\\async_samples\\\
+ \\sample_query_tables_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n # List all the tables in the service\n print(\"\
+ Listing tables:\")\n async for table in table_service.list_tables():\n \
+ \ print(\"\\t{}\".format(table.name))\n\n ````\n"
- uid: azure.data.tables.aio.TableServiceClient.query_tables
name: query_tables
summary: Queries tables under the given account.
@@ -334,14 +339,14 @@ methods:
- "Querying tables in an account given specific parameters<!--[!code-python[Main](les\\\
async_samples\\sample_query_tables_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\38\\\\azure-data-tables-12.4.4\\\
- \\samples\\\\async_samples\\\\sample_query_tables_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # Query for \"\
- table1\" in the tables created\n table_name = \"mytableasync1\"\n name_filter\
- \ = \"TableName eq '{}'\".format(table_name)\n print(\"Queried_tables\")\n \
- \ async for table in table_service.query_tables(name_filter):\n print(\"\
- \\t{}\".format(table.name))\n\n ````\n"
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\37\\\\azure-data-tables-12.4.4\\\\samples\\\\async_samples\\\
+ \\sample_query_tables_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n # Query for \"table1\" in the tables created\n\
+ \ table_name = \"mytableasync1\"\n name_filter = \"TableName eq '{}'\".format(table_name)\n\
+ \ print(\"Queried_tables\")\n async for table in table_service.query_tables(name_filter):\n\
+ \ print(\"\\t{}\".format(table.name))\n\n ````\n"
- uid: azure.data.tables.aio.TableServiceClient.set_service_properties
name: set_service_properties
summary: "Sets properties for an account's Table service endpoint,\n including\
diff --git a/docs-ref-autogen/azure-datalake-store/azure.datalake.store.lib.DatalakeRESTInterface.yml b/docs-ref-autogen/azure-datalake-store/azure.datalake.store.lib.DatalakeRESTInterface.yml
index ca91d3500ec4..170f7cd1bf48 100644
--- a/docs-ref-autogen/azure-datalake-store/azure.datalake.store.lib.DatalakeRESTInterface.yml
+++ b/docs-ref-autogen/azure-datalake-store/azure.datalake.store.lib.DatalakeRESTInterface.yml
@@ -125,16 +125,16 @@ attributes:
name: session
- uid: azure.datalake.store.lib.DatalakeRESTInterface.ends
name: ends
- signature: 'ends = {''APPEND'': (''post'', set(), {''offset'', ''leaseid'', ''syncFlag'',
- ''filesessionid'', ''append''}), ''CHECKACCESS'': (''get'', set(), {''fsaction''}),
+ signature: 'ends = {''APPEND'': (''post'', set(), {''syncFlag'', ''filesessionid'',
+ ''leaseid'', ''append'', ''offset''}), ''CHECKACCESS'': (''get'', set(), {''fsaction''}),
''CONCAT'': (''post'', {''sources''}, {''sources''}), ''CREATE'': (''put'', set(),
- {''overwrite'', ''leaseid'', ''write'', ''syncFlag'', ''filesessionid''}), ''DELETE'':
+ {''overwrite'', ''syncFlag'', ''write'', ''filesessionid'', ''leaseid''}), ''DELETE'':
(''delete'', set(), {''recursive''}), ''GETCONTENTSUMMARY'': (''get'', set(),
set()), ''GETFILESTATUS'': (''get'', set(), set()), ''LISTSTATUS'': (''get'',
- set(), {''listSize'', ''listAfter''}), ''MKDIRS'': (''put'', set(), set()), ''MODIFYACLENTRIES'':
+ set(), {''listAfter'', ''listSize''}), ''MKDIRS'': (''put'', set(), set()), ''MODIFYACLENTRIES'':
(''put'', {''aclSpec''}, {''aclSpec''}), ''MSCONCAT'': (''post'', set(), {''deleteSourceDirectory''}),
- ''MSGETACLSTATUS'': (''get'', set(), set()), ''OPEN'': (''get'', set(), {''length'',
- ''read'', ''offset'', ''filesessionid''}), ''REMOVEACL'': (''put'', set(), set()),
+ ''MSGETACLSTATUS'': (''get'', set(), set()), ''OPEN'': (''get'', set(), {''offset'',
+ ''length'', ''filesessionid'', ''read''}), ''REMOVEACL'': (''put'', set(), set()),
''REMOVEACLENTRIES'': (''put'', {''aclSpec''}, {''aclSpec''}), ''REMOVEDEFAULTACL'':
(''put'', set(), set()), ''RENAME'': (''put'', {''destination''}, {''destination''}),
''SETACL'': (''put'', {''aclSpec''}, {''aclSpec''}), ''SETEXPIRY'': (''put'',
diff --git a/docs-ref-autogen/azure-eventhub-checkpointstoreblob-aio/azure.eventhub.extensions.yml b/docs-ref-autogen/azure-eventhub-checkpointstoreblob-aio/azure.eventhub.extensions.yml
new file mode 100644
index 000000000000..23566bd8e03e
--- /dev/null
+++ b/docs-ref-autogen/azure-eventhub-checkpointstoreblob-aio/azure.eventhub.extensions.yml
@@ -0,0 +1,7 @@
+### YamlMime:PythonPackage
+uid: azure.eventhub.extensions
+name: extensions
+fullName: azure.eventhub.extensions
+type: import
+packages:
+- azure.eventhub.extensions.checkpointstoreblobaio
diff --git a/docs-ref-autogen/azure-eventhub-checkpointstoreblob-aio/index.yml b/docs-ref-autogen/azure-eventhub-checkpointstoreblob-aio/index.yml
index 63ee837e3679..90c5a5f9f1d0 100644
--- a/docs-ref-autogen/azure-eventhub-checkpointstoreblob-aio/index.yml
+++ b/docs-ref-autogen/azure-eventhub-checkpointstoreblob-aio/index.yml
@@ -4,4 +4,4 @@ name: azure-eventhub-checkpointstoreblob-aio
fullName: azure-eventhub-checkpointstoreblob-aio
type: distribution
packages:
-- azure.eventhub.extensions.checkpointstoreblobaio
+- azure.eventhub.extensions
diff --git a/docs-ref-autogen/azure-eventhub-checkpointstoreblob/azure.eventhub.extensions.yml b/docs-ref-autogen/azure-eventhub-checkpointstoreblob/azure.eventhub.extensions.yml
new file mode 100644
index 000000000000..c084eb5f4815
--- /dev/null
+++ b/docs-ref-autogen/azure-eventhub-checkpointstoreblob/azure.eventhub.extensions.yml
@@ -0,0 +1,7 @@
+### YamlMime:PythonPackage
+uid: azure.eventhub.extensions
+name: extensions
+fullName: azure.eventhub.extensions
+type: import
+packages:
+- azure.eventhub.extensions.checkpointstoreblob
diff --git a/docs-ref-autogen/azure-eventhub-checkpointstoreblob/index.yml b/docs-ref-autogen/azure-eventhub-checkpointstoreblob/index.yml
index 44061f62f1df..7549149d7fa1 100644
--- a/docs-ref-autogen/azure-eventhub-checkpointstoreblob/index.yml
+++ b/docs-ref-autogen/azure-eventhub-checkpointstoreblob/index.yml
@@ -4,4 +4,4 @@ name: azure-eventhub-checkpointstoreblob
fullName: azure-eventhub-checkpointstoreblob
type: distribution
packages:
-- azure.eventhub.extensions.checkpointstoreblob
+- azure.eventhub.extensions
diff --git a/docs-ref-autogen/azure-eventhub/azure.eventhub.EventData.yml b/docs-ref-autogen/azure-eventhub/azure.eventhub.EventData.yml
index 9e8104629e1e..f085a396cd2f 100644
--- a/docs-ref-autogen/azure-eventhub/azure.eventhub.EventData.yml
+++ b/docs-ref-autogen/azure-eventhub/azure.eventhub.EventData.yml
@@ -19,11 +19,12 @@ constructor:
examples:
- "Create instances of EventData<!--[!code-python[Main](les\\sync_samples\\sample_code_eventhub.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 42\\\\azure-eventhub-5.11.4\\\\samples\\\\sync_samples\\\\sample_code_eventhub.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.eventhub\
- \ import EventData\n\n event_data = EventData(\"String data\")\n event_data\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\41\\\\azure-eventhub-5.11.4\\\
+ \\samples\\\\sync_samples\\\\sample_code_eventhub.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.eventhub import\
+ \ EventData\n\n event_data = EventData(\"String data\")\n event_data\
\ = EventData(b\"Bytes data\")\n\n\n ````\n"
methods:
- uid: azure.eventhub.EventData.body_as_json
diff --git a/docs-ref-autogen/azure-eventhub/azure.eventhub.EventHubConsumerClient.yml b/docs-ref-autogen/azure-eventhub/azure.eventhub.EventHubConsumerClient.yml
index 723e35e2818c..ccab3b3fab02 100644
--- a/docs-ref-autogen/azure-eventhub/azure.eventhub.EventHubConsumerClient.yml
+++ b/docs-ref-autogen/azure-eventhub/azure.eventhub.EventHubConsumerClient.yml
@@ -285,14 +285,14 @@ examples:
- "Create a new instance of the EventHubConsumerClient.<!--[!code-python[Main](les\\\
sync_samples\\sample_code_eventhub.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.11.4\\\\samples\\\
- \\sync_samples\\\\sample_code_eventhub.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n import os\n from azure.eventhub import\
- \ EventHubConsumerClient, EventHubSharedKeyCredential\n\n fully_qualified_namespace\
- \ = os.environ['EVENT_HUB_HOSTNAME']\n eventhub_name = os.environ['EVENT_HUB_NAME']\n\
- \ shared_access_policy = os.environ['EVENT_HUB_SAS_POLICY']\n shared_access_key\
- \ = os.environ['EVENT_HUB_SAS_KEY']\n\n credential = EventHubSharedKeyCredential(shared_access_policy,\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\41\\\\azure-eventhub-5.11.4\\\\samples\\\\sync_samples\\\
+ \\sample_code_eventhub.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
+ : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
+ \n````python\n\n import os\n from azure.eventhub import EventHubConsumerClient,\
+ \ EventHubSharedKeyCredential\n\n fully_qualified_namespace = os.environ['EVENT_HUB_HOSTNAME']\n\
+ \ eventhub_name = os.environ['EVENT_HUB_NAME']\n shared_access_policy = os.environ['EVENT_HUB_SAS_POLICY']\n\
+ \ shared_access_key = os.environ['EVENT_HUB_SAS_KEY']\n\n credential = EventHubSharedKeyCredential(shared_access_policy,\
\ shared_access_key)\n consumer = EventHubConsumerClient(\n fully_qualified_namespace=fully_qualified_namespace,\n\
\ eventhub_name=eventhub_name,\n consumer_group='$Default',\n \
\ credential=credential)\n\n ````\n"
@@ -308,8 +308,9 @@ methods:
examples:
- "Close down the client.<!--[!code-python[Main](les\\sync_samples\\sample_code_eventhub.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\42\\\\azure-eventhub-5.11.4\\\\samples\\\\sync_samples\\\\sample_code_eventhub.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 41\\\\azure-eventhub-5.11.4\\\\samples\\\\sync_samples\\\\sample_code_eventhub.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n import os\n import threading\n\n event_hub_connection_str = os.environ['EVENT_HUB_CONN_STR']\n\
@@ -546,12 +547,13 @@ methods:
- "Create a new instance of the EventHubConsumerClient from connection string.<!--[!code-python[Main](les\\\
sync_samples\\sample_code_eventhub.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.11.4\\\\\
- samples\\\\sync_samples\\\\sample_code_eventhub.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.eventhub\
- \ import EventHubConsumerClient\n event_hub_connection_str = os.environ['EVENT_HUB_CONN_STR']\n\
- \ eventhub_name = os.environ['EVENT_HUB_NAME']\n consumer = EventHubConsumerClient.from_connection_string(\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\41\\\\azure-eventhub-5.11.4\\\\samples\\\\sync_samples\\\
+ \\sample_code_eventhub.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.eventhub import EventHubConsumerClient\n\
+ \ event_hub_connection_str = os.environ['EVENT_HUB_CONN_STR']\n eventhub_name\
+ \ = os.environ['EVENT_HUB_NAME']\n consumer = EventHubConsumerClient.from_connection_string(\n\
\ conn_str=event_hub_connection_str,\n consumer_group='$Default',\n\
\ eventhub_name=eventhub_name # EventHub name should be specified if it\
\ doesn't show up in connection string.\n )\n\n ````\n"
@@ -763,11 +765,12 @@ methods:
examples:
- "Receive events from the EventHub.<!--[!code-python[Main](les\\sync_samples\\\
sample_code_eventhub.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.11.4\\\\samples\\\\\
- sync_samples\\\\sample_code_eventhub.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n logger = logging.getLogger(\"azure.eventhub\"\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\41\\\\azure-eventhub-5.11.4\\\\samples\\\\sync_samples\\\
+ \\sample_code_eventhub.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n logger = logging.getLogger(\"azure.eventhub\"\
)\n\n def on_event(partition_context, event):\n # Put your code\
\ here.\n # If the operation is i/o intensive, multi-thread will have\
\ better performance.\n logger.info(\"Received event from partition:\
@@ -956,11 +959,12 @@ methods:
examples:
- "Receive events in batches from the EventHub.<!--[!code-python[Main](les\\sync_samples\\\
sample_code_eventhub.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.11.4\\\\samples\\\\\
- sync_samples\\\\sample_code_eventhub.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n logger = logging.getLogger(\"azure.eventhub\"\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\41\\\\azure-eventhub-5.11.4\\\\samples\\\\sync_samples\\\
+ \\sample_code_eventhub.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n logger = logging.getLogger(\"azure.eventhub\"\
)\n\n def on_event_batch(partition_context, event_batch):\n #\
\ Put your code here.\n # If the operation is i/o intensive, multi-thread\
\ will have better performance.\n logger.info(\"Received events from\
diff --git a/docs-ref-autogen/azure-eventhub/azure.eventhub.EventHubProducerClient.yml b/docs-ref-autogen/azure-eventhub/azure.eventhub.EventHubProducerClient.yml
index cbf5ef077e2e..3b9a4862741e 100644
--- a/docs-ref-autogen/azure-eventhub/azure.eventhub.EventHubProducerClient.yml
+++ b/docs-ref-autogen/azure-eventhub/azure.eventhub.EventHubProducerClient.yml
@@ -236,14 +236,14 @@ examples:
- "Create a new instance of the EventHubProducerClient.<!--[!code-python[Main](les\\\
sync_samples\\sample_code_eventhub.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.11.4\\\\samples\\\
- \\sync_samples\\\\sample_code_eventhub.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n import os\n from azure.eventhub import\
- \ EventHubProducerClient, EventHubSharedKeyCredential\n\n fully_qualified_namespace\
- \ = os.environ['EVENT_HUB_HOSTNAME']\n eventhub_name = os.environ['EVENT_HUB_NAME']\n\
- \ shared_access_policy = os.environ['EVENT_HUB_SAS_POLICY']\n shared_access_key\
- \ = os.environ['EVENT_HUB_SAS_KEY']\n\n credential = EventHubSharedKeyCredential(shared_access_policy,\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\41\\\\azure-eventhub-5.11.4\\\\samples\\\\sync_samples\\\
+ \\sample_code_eventhub.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
+ : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
+ \n````python\n\n import os\n from azure.eventhub import EventHubProducerClient,\
+ \ EventHubSharedKeyCredential\n\n fully_qualified_namespace = os.environ['EVENT_HUB_HOSTNAME']\n\
+ \ eventhub_name = os.environ['EVENT_HUB_NAME']\n shared_access_policy = os.environ['EVENT_HUB_SAS_POLICY']\n\
+ \ shared_access_key = os.environ['EVENT_HUB_SAS_KEY']\n\n credential = EventHubSharedKeyCredential(shared_access_policy,\
\ shared_access_key)\n producer = EventHubProducerClient(\n fully_qualified_namespace=fully_qualified_namespace,\n\
\ eventhub_name=eventhub_name, # EventHub name should be specified if it\
\ doesn't show up in connection string.\n credential=credential\n )\n\n\
@@ -279,8 +279,9 @@ methods:
examples:
- "Close down the client.<!--[!code-python[Main](les\\sync_samples\\sample_code_eventhub.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\42\\\\azure-eventhub-5.11.4\\\\samples\\\\sync_samples\\\\sample_code_eventhub.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 41\\\\azure-eventhub-5.11.4\\\\samples\\\\sync_samples\\\\sample_code_eventhub.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n import os\n from azure.eventhub import EventHubProducerClient, EventData\n\
@@ -347,10 +348,11 @@ methods:
- "Create EventDataBatch object within limited size<!--[!code-python[Main](les\\\
sync_samples\\sample_code_eventhub.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.11.4\\\\\
- samples\\\\sync_samples\\\\sample_code_eventhub.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n event_data_batch = producer.create_batch()\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\41\\\\azure-eventhub-5.11.4\\\\samples\\\\sync_samples\\\
+ \\sample_code_eventhub.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n event_data_batch = producer.create_batch()\n\
\ while True:\n try:\n event_data_batch.add(EventData('Message\
\ inside EventBatchData'))\n except ValueError:\n # The\
\ EventDataBatch object reaches its max_size.\n # You can send the\
@@ -583,12 +585,13 @@ methods:
- "Create a new instance of the EventHubProducerClient from connection string.<!--[!code-python[Main](les\\\
sync_samples\\sample_code_eventhub.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.11.4\\\\\
- samples\\\\sync_samples\\\\sample_code_eventhub.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.eventhub\
- \ import EventHubProducerClient\n event_hub_connection_str = os.environ['EVENT_HUB_CONN_STR']\n\
- \ eventhub_name = os.environ['EVENT_HUB_NAME']\n producer = EventHubProducerClient.from_connection_string(\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\41\\\\azure-eventhub-5.11.4\\\\samples\\\\sync_samples\\\
+ \\sample_code_eventhub.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.eventhub import EventHubProducerClient\n\
+ \ event_hub_connection_str = os.environ['EVENT_HUB_CONN_STR']\n eventhub_name\
+ \ = os.environ['EVENT_HUB_NAME']\n producer = EventHubProducerClient.from_connection_string(\n\
\ conn_str=event_hub_connection_str,\n eventhub_name=eventhub_name\
\ # EventHub name should be specified if it doesn't show up in connection string.\n\
\ )\n\n ````\n"
@@ -758,8 +761,9 @@ methods:
examples:
- "Sends event data<!--[!code-python[Main](les\\sync_samples\\sample_code_eventhub.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\42\\\\azure-eventhub-5.11.4\\\\samples\\\\sync_samples\\\\sample_code_eventhub.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 41\\\\azure-eventhub-5.11.4\\\\samples\\\\sync_samples\\\\sample_code_eventhub.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n with producer:\n event_data_batch = producer.create_batch()\n\
diff --git a/docs-ref-autogen/azure-eventhub/azure.eventhub.aio.EventHubConsumerClient.yml b/docs-ref-autogen/azure-eventhub/azure.eventhub.aio.EventHubConsumerClient.yml
index a64f4ba3d9ce..603b451bb49d 100644
--- a/docs-ref-autogen/azure-eventhub/azure.eventhub.aio.EventHubConsumerClient.yml
+++ b/docs-ref-autogen/azure-eventhub/azure.eventhub.aio.EventHubConsumerClient.yml
@@ -285,14 +285,14 @@ examples:
- "Create a new instance of the EventHubConsumerClient.<!--[!code-python[Main](les\\\
async_samples\\sample_code_eventhub_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.11.4\\\\samples\\\
- \\async_samples\\\\sample_code_eventhub_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.eventhub.aio\
- \ import EventHubConsumerClient, EventHubSharedKeyCredential\n\n fully_qualified_namespace\
- \ = os.environ['EVENT_HUB_HOSTNAME']\n eventhub_name = os.environ['EVENT_HUB_NAME']\n\
- \ shared_access_policy = os.environ['EVENT_HUB_SAS_POLICY']\n shared_access_key\
- \ = os.environ['EVENT_HUB_SAS_KEY']\n\n consumer = EventHubConsumerClient(fully_qualified_namespace=fully_qualified_namespace,\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\41\\\\azure-eventhub-5.11.4\\\\samples\\\\async_samples\\\
+ \\sample_code_eventhub_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.eventhub.aio import EventHubConsumerClient,\
+ \ EventHubSharedKeyCredential\n\n fully_qualified_namespace = os.environ['EVENT_HUB_HOSTNAME']\n\
+ \ eventhub_name = os.environ['EVENT_HUB_NAME']\n shared_access_policy = os.environ['EVENT_HUB_SAS_POLICY']\n\
+ \ shared_access_key = os.environ['EVENT_HUB_SAS_KEY']\n\n consumer = EventHubConsumerClient(fully_qualified_namespace=fully_qualified_namespace,\n\
\ consumer_group='$Default',\n \
\ eventhub_name=eventhub_name,\n \
\ credential=EventHubSharedKeyCredential(shared_access_policy, shared_access_key))\n\
@@ -309,8 +309,9 @@ methods:
examples:
- "Close down the client.<!--[!code-python[Main](les\\async_samples\\sample_code_eventhub_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\42\\\\azure-eventhub-5.11.4\\\\samples\\\\async_samples\\\\sample_code_eventhub_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 41\\\\azure-eventhub-5.11.4\\\\samples\\\\async_samples\\\\sample_code_eventhub_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n import os\n\n event_hub_connection_str = os.environ['EVENT_HUB_CONN_STR']\n\
@@ -550,16 +551,16 @@ methods:
- "Create a new instance of the EventHubConsumerClient from connection string.<!--[!code-python[Main](les\\\
async_samples\\sample_code_eventhub_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.11.4\\\\\
- samples\\\\async_samples\\\\sample_code_eventhub_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from\
- \ azure.eventhub.aio import EventHubConsumerClient\n event_hub_connection_str\
- \ = os.environ['EVENT_HUB_CONN_STR']\n eventhub_name = os.environ['EVENT_HUB_NAME']\n\
- \ consumer = EventHubConsumerClient.from_connection_string(\n conn_str=event_hub_connection_str,\n\
- \ consumer_group='$Default',\n eventhub_name=eventhub_name # EventHub\
- \ name should be specified if it doesn't show up in connection string.\n )\n\
- \n ````\n"
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\41\\\\azure-eventhub-5.11.4\\\\samples\\\\async_samples\\\
+ \\sample_code_eventhub_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.eventhub.aio import\
+ \ EventHubConsumerClient\n event_hub_connection_str = os.environ['EVENT_HUB_CONN_STR']\n\
+ \ eventhub_name = os.environ['EVENT_HUB_NAME']\n consumer = EventHubConsumerClient.from_connection_string(\n\
+ \ conn_str=event_hub_connection_str,\n consumer_group='$Default',\n\
+ \ eventhub_name=eventhub_name # EventHub name should be specified if it\
+ \ doesn't show up in connection string.\n )\n\n ````\n"
- uid: azure.eventhub.aio.EventHubConsumerClient.get_eventhub_properties
name: get_eventhub_properties
summary: "Get properties of the Event Hub.\n\nKeys in the returned dictionary include:\n\
@@ -773,18 +774,19 @@ methods:
examples:
- "Receive events from the EventHub.<!--[!code-python[Main](les\\async_samples\\\
sample_code_eventhub_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.11.4\\\\samples\\\\\
- async_samples\\\\sample_code_eventhub_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n logger = logging.getLogger(\"\
- azure.eventhub\")\n\n async def on_event(partition_context, event):\n \
- \ # Put your code here.\n # If the operation is i/o intensive,\
- \ async will have better performance.\n logger.info(\"Received event\
- \ from partition: {}\".format(partition_context.partition_id))\n\n async\
- \ with consumer:\n await consumer.receive(\n on_event=on_event,\n\
- \ starting_position=\"-1\", # \"-1\" is from the beginning of the\
- \ partition.\n )\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\41\\\\azure-eventhub-5.11.4\\\\samples\\\\async_samples\\\
+ \\sample_code_eventhub_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n logger = logging.getLogger(\"azure.eventhub\"\
+ )\n\n async def on_event(partition_context, event):\n # Put your\
+ \ code here.\n # If the operation is i/o intensive, async will have\
+ \ better performance.\n logger.info(\"Received event from partition:\
+ \ {}\".format(partition_context.partition_id))\n\n async with consumer:\n\
+ \ await consumer.receive(\n on_event=on_event,\n \
+ \ starting_position=\"-1\", # \"-1\" is from the beginning of the partition.\n\
+ \ )\n\n ````\n"
- uid: azure.eventhub.aio.EventHubConsumerClient.receive_batch
name: receive_batch
summary: Receive events from partition(s) in batches, with optional load-balancing
@@ -977,15 +979,16 @@ methods:
examples:
- "Receive events in batches from the EventHub.<!--[!code-python[Main](les\\async_samples\\\
sample_code_eventhub_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.11.4\\\\samples\\\\\
- async_samples\\\\sample_code_eventhub_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n logger = logging.getLogger(\"\
- azure.eventhub\")\n\n async def on_event_batch(partition_context, event_batch):\n\
- \ # Put your code here.\n # If the operation is i/o intensive,\
- \ async will have better performance.\n logger.info(\n \
- \ \"{} events received from partition: {}\".format(len(event_batch), partition_context.partition_id)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\41\\\\azure-eventhub-5.11.4\\\\samples\\\\async_samples\\\
+ \\sample_code_eventhub_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n logger = logging.getLogger(\"azure.eventhub\"\
+ )\n\n async def on_event_batch(partition_context, event_batch):\n \
+ \ # Put your code here.\n # If the operation is i/o intensive, async\
+ \ will have better performance.\n logger.info(\n \"{}\
+ \ events received from partition: {}\".format(len(event_batch), partition_context.partition_id)\n\
\ )\n\n async with consumer:\n await consumer.receive_batch(\n\
\ on_event_batch=on_event_batch,\n starting_position=\"\
-1\", # \"-1\" is from the beginning of the partition.\n )\n\n ````\n"
diff --git a/docs-ref-autogen/azure-eventhub/azure.eventhub.aio.EventHubProducerClient.yml b/docs-ref-autogen/azure-eventhub/azure.eventhub.aio.EventHubProducerClient.yml
index 075a185f0fd5..a2d47dc3d472 100644
--- a/docs-ref-autogen/azure-eventhub/azure.eventhub.aio.EventHubProducerClient.yml
+++ b/docs-ref-autogen/azure-eventhub/azure.eventhub.aio.EventHubProducerClient.yml
@@ -228,14 +228,14 @@ examples:
- "Create a new instance of the EventHubProducerClient.<!--[!code-python[Main](les\\\
async_samples\\sample_code_eventhub_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.11.4\\\\samples\\\
- \\async_samples\\\\sample_code_eventhub_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.eventhub.aio\
- \ import EventHubProducerClient, EventHubSharedKeyCredential\n\n fully_qualified_namespace\
- \ = os.environ['EVENT_HUB_HOSTNAME']\n eventhub_name = os.environ['EVENT_HUB_NAME']\n\
- \ shared_access_policy = os.environ['EVENT_HUB_SAS_POLICY']\n shared_access_key\
- \ = os.environ['EVENT_HUB_SAS_KEY']\n\n producer = EventHubProducerClient(fully_qualified_namespace=fully_qualified_namespace,\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\41\\\\azure-eventhub-5.11.4\\\\samples\\\\async_samples\\\
+ \\sample_code_eventhub_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.eventhub.aio import EventHubProducerClient,\
+ \ EventHubSharedKeyCredential\n\n fully_qualified_namespace = os.environ['EVENT_HUB_HOSTNAME']\n\
+ \ eventhub_name = os.environ['EVENT_HUB_NAME']\n shared_access_policy = os.environ['EVENT_HUB_SAS_POLICY']\n\
+ \ shared_access_key = os.environ['EVENT_HUB_SAS_KEY']\n\n producer = EventHubProducerClient(fully_qualified_namespace=fully_qualified_namespace,\n\
\ eventhub_name=eventhub_name,\n \
\ credential=EventHubSharedKeyCredential(shared_access_policy,\
\ shared_access_key))\n\n ````\n"
@@ -270,8 +270,9 @@ methods:
examples:
- "Close down the handler.<!--[!code-python[Main](les\\async_samples\\sample_code_eventhub_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\42\\\\azure-eventhub-5.11.4\\\\samples\\\\async_samples\\\\sample_code_eventhub_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 41\\\\azure-eventhub-5.11.4\\\\samples\\\\async_samples\\\\sample_code_eventhub_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n import os\n from azure.eventhub.aio import EventHubProducerClient\n from\
@@ -342,16 +343,16 @@ methods:
- "Create EventDataBatch object within limited size<!--[!code-python[Main](les\\\
async_samples\\sample_code_eventhub_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.11.4\\\\\
- samples\\\\async_samples\\\\sample_code_eventhub_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.eventhub\
- \ import EventData\n event_data_batch = await producer.create_batch()\n\
- \ while True:\n try:\n event_data_batch.add(EventData('Message\
- \ inside EventBatchData'))\n except ValueError:\n # The\
- \ EventDataBatch object reaches its max_size.\n # You can send the\
- \ full EventDataBatch object and create a new one here.\n break\n\
- \n ````\n"
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\41\\\\azure-eventhub-5.11.4\\\\samples\\\\async_samples\\\
+ \\sample_code_eventhub_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.eventhub import EventData\n \
+ \ event_data_batch = await producer.create_batch()\n while True:\n \
+ \ try:\n event_data_batch.add(EventData('Message inside\
+ \ EventBatchData'))\n except ValueError:\n # The EventDataBatch\
+ \ object reaches its max_size.\n # You can send the full EventDataBatch\
+ \ object and create a new one here.\n break\n\n ````\n"
- uid: azure.eventhub.aio.EventHubProducerClient.flush
name: flush
summary: 'Buffered mode only.
@@ -566,15 +567,16 @@ methods:
- "Create a new instance of the EventHubProducerClient from connection string.<!--[!code-python[Main](les\\\
async_samples\\sample_code_eventhub_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.11.4\\\\\
- samples\\\\async_samples\\\\sample_code_eventhub_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from\
- \ azure.eventhub.aio import EventHubProducerClient\n event_hub_connection_str\
- \ = os.environ['EVENT_HUB_CONN_STR']\n eventhub_name = os.environ['EVENT_HUB_NAME']\n\
- \ producer = EventHubProducerClient.from_connection_string(\n conn_str=event_hub_connection_str,\n\
- \ eventhub_name=eventhub_name # EventHub name should be specified if it\
- \ doesn't show up in connection string.\n )\n\n ````\n"
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\41\\\\azure-eventhub-5.11.4\\\\samples\\\\async_samples\\\
+ \\sample_code_eventhub_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.eventhub.aio import\
+ \ EventHubProducerClient\n event_hub_connection_str = os.environ['EVENT_HUB_CONN_STR']\n\
+ \ eventhub_name = os.environ['EVENT_HUB_NAME']\n producer = EventHubProducerClient.from_connection_string(\n\
+ \ conn_str=event_hub_connection_str,\n eventhub_name=eventhub_name\
+ \ # EventHub name should be specified if it doesn't show up in connection string.\n\
+ \ )\n\n ````\n"
- uid: azure.eventhub.aio.EventHubProducerClient.get_buffered_event_count
name: get_buffered_event_count
summary: "The number of events that are buffered and waiting to be published for\
@@ -740,8 +742,9 @@ methods:
examples:
- "Asynchronously sends event data<!--[!code-python[Main](les\\async_samples\\sample_code_eventhub_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\42\\\\azure-eventhub-5.11.4\\\\samples\\\\async_samples\\\\sample_code_eventhub_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 41\\\\azure-eventhub-5.11.4\\\\samples\\\\async_samples\\\\sample_code_eventhub_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n async with producer:\n event_data_batch = await producer.create_batch()\n\
diff --git a/docs-ref-autogen/azure-eventhub/azure.eventhub.extensions.yml b/docs-ref-autogen/azure-eventhub/azure.eventhub.extensions.yml
new file mode 100644
index 000000000000..cd57f6efd135
--- /dev/null
+++ b/docs-ref-autogen/azure-eventhub/azure.eventhub.extensions.yml
@@ -0,0 +1,5 @@
+### YamlMime:PythonPackage
+uid: azure.eventhub.extensions
+name: extensions
+fullName: azure.eventhub.extensions
+type: import
diff --git a/docs-ref-autogen/azure-eventhub/azure.eventhub.yml b/docs-ref-autogen/azure-eventhub/azure.eventhub.yml
index f47fa24e535c..70b760336901 100644
--- a/docs-ref-autogen/azure-eventhub/azure.eventhub.yml
+++ b/docs-ref-autogen/azure-eventhub/azure.eventhub.yml
@@ -30,6 +30,7 @@ classes:
packages:
- azure.eventhub.aio
- azure.eventhub.amqp
+- azure.eventhub.extensions
modules:
- azure.eventhub.exceptions
enums:
diff --git a/docs-ref-autogen/azure-identity/azure.identity.AuthorizationCodeCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.AuthorizationCodeCredential.yml
index 29f6fea30382..4b072737b836 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.AuthorizationCodeCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.AuthorizationCodeCredential.yml
@@ -64,13 +64,14 @@ constructor:
examples:
- "Create an AuthorizationCodeCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import AuthorizationCodeCredential\n\n credential = AuthorizationCodeCredential(\n\
- \ tenant_id=\"<tenant_id>\",\n client_id=\"<client_id>\",\n authorization_code=\"\
- <auth_code>\",\n redirect_uri=\"<redirect_uri>\",\n )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import AuthorizationCodeCredential\n\
+ \n credential = AuthorizationCodeCredential(\n tenant_id=\"<tenant_id>\"\
+ ,\n client_id=\"<client_id>\",\n authorization_code=\"<auth_code>\"\
+ ,\n redirect_uri=\"<redirect_uri>\",\n )\n\n ````\n"
methods:
- uid: azure.identity.AuthorizationCodeCredential.close
name: close
diff --git a/docs-ref-autogen/azure-identity/azure.identity.AzureCliCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.AzureCliCredential.yml
index e9e17e4f4c7c..dc9b9084ae04 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.AzureCliCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.AzureCliCredential.yml
@@ -35,11 +35,12 @@ constructor:
examples:
- "Create an AzureCliCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import AzureCliCredential\n\n credential = AzureCliCredential()\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import AzureCliCredential\n\
+ \n credential = AzureCliCredential()\n\n ````\n"
methods:
- uid: azure.identity.AzureCliCredential.close
name: close
diff --git a/docs-ref-autogen/azure-identity/azure.identity.AzureDeveloperCliCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.AzureDeveloperCliCredential.yml
index 79249505740c..0593955a05b8 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.AzureDeveloperCliCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.AzureDeveloperCliCredential.yml
@@ -51,12 +51,12 @@ constructor:
examples:
- "Create an AzureDeveloperCliCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import AzureDeveloperCliCredential\n\n credential = AzureDeveloperCliCredential()\n\
- \n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import AzureDeveloperCliCredential\n\
+ \n credential = AzureDeveloperCliCredential()\n\n ````\n"
methods:
- uid: azure.identity.AzureDeveloperCliCredential.close
name: close
diff --git a/docs-ref-autogen/azure-identity/azure.identity.AzurePowerShellCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.AzurePowerShellCredential.yml
index 7dcd7f43465b..b65190bc1837 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.AzurePowerShellCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.AzurePowerShellCredential.yml
@@ -35,12 +35,12 @@ constructor:
examples:
- "Create an AzurePowerShellCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import AzurePowerShellCredential\n\n credential = AzurePowerShellCredential()\n\
- \n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import AzurePowerShellCredential\n\
+ \n credential = AzurePowerShellCredential()\n\n ````\n"
methods:
- uid: azure.identity.AzurePowerShellCredential.close
name: close
diff --git a/docs-ref-autogen/azure-identity/azure.identity.CertificateCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.CertificateCredential.yml
index b0f6974e06c9..eb2626521959 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.CertificateCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.CertificateCredential.yml
@@ -108,17 +108,17 @@ constructor:
examples:
- "Create a CertificateCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import CertificateCredential\n\n credential = CertificateCredential(\n \
- \ tenant_id=\"<tenant_id>\",\n client_id=\"<client_id>\",\n certificate_path=\"\
- <path to PEM/PKCS12 certificate>\",\n password=\"<certificate password if\
- \ necessary>\",\n )\n\n # Certificate/private key byte data can also be passed\
- \ directly\n credential = CertificateCredential(\n tenant_id=\"<tenant_id>\"\
- ,\n client_id=\"<client_id>\",\n certificate_data=b\"<cert data>\",\n\
- \ )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import CertificateCredential\n\
+ \n credential = CertificateCredential(\n tenant_id=\"<tenant_id>\",\n \
+ \ client_id=\"<client_id>\",\n certificate_path=\"<path to PEM/PKCS12\
+ \ certificate>\",\n password=\"<certificate password if necessary>\",\n \
+ \ )\n\n # Certificate/private key byte data can also be passed directly\n credential\
+ \ = CertificateCredential(\n tenant_id=\"<tenant_id>\",\n client_id=\"\
+ <client_id>\",\n certificate_data=b\"<cert data>\",\n )\n\n ````\n"
methods:
- uid: azure.identity.CertificateCredential.close
name: close
diff --git a/docs-ref-autogen/azure-identity/azure.identity.ChainedTokenCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.ChainedTokenCredential.yml
index 612227bd0d8e..eb7f2f69c480 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.ChainedTokenCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.ChainedTokenCredential.yml
@@ -23,14 +23,15 @@ constructor:
examples:
- "Create a ChainedTokenCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import ChainedTokenCredential, EnvironmentCredential, AzureCliCredential\n\n \
- \ credential_chain = (\n # Try EnvironmentCredential first\n EnvironmentCredential(),\n\
- \ # Fallback to Azure CLI if EnvironmentCredential fails\n AzureCliCredential(),\n\
- \ )\n credential = ChainedTokenCredential(*credential_chain)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import ChainedTokenCredential,\
+ \ EnvironmentCredential, AzureCliCredential\n\n credential_chain = (\n #\
+ \ Try EnvironmentCredential first\n EnvironmentCredential(),\n # Fallback\
+ \ to Azure CLI if EnvironmentCredential fails\n AzureCliCredential(),\n \
+ \ )\n credential = ChainedTokenCredential(*credential_chain)\n\n ````\n"
methods:
- uid: azure.identity.ChainedTokenCredential.close
name: close
diff --git a/docs-ref-autogen/azure-identity/azure.identity.ClientAssertionCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.ClientAssertionCredential.yml
index eff838a94ac2..ad26be244563 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.ClientAssertionCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.ClientAssertionCredential.yml
@@ -54,14 +54,14 @@ constructor:
examples:
- "Create a ClientAssertionCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import ClientAssertionCredential\n\n def get_assertion():\n return \"\
- <client-assertion>\"\n\n credential = ClientAssertionCredential(\n tenant_id=\"\
- <tenant_id>\",\n client_id=\"<client_id>\",\n func=get_assertion,\n\
- \ )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import ClientAssertionCredential\n\
+ \n def get_assertion():\n return \"<client-assertion>\"\n\n credential\
+ \ = ClientAssertionCredential(\n tenant_id=\"<tenant_id>\",\n client_id=\"\
+ <client_id>\",\n func=get_assertion,\n )\n\n ````\n"
methods:
- uid: azure.identity.ClientAssertionCredential.close
name: close
diff --git a/docs-ref-autogen/azure-identity/azure.identity.ClientSecretCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.ClientSecretCredential.yml
index 5ca4395da4c2..1f852b49e1d3 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.ClientSecretCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.ClientSecretCredential.yml
@@ -74,13 +74,14 @@ constructor:
examples:
- "Create a ClientSecretCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import ClientSecretCredential\n\n credential = ClientSecretCredential(\n \
- \ tenant_id=\"<tenant_id>\",\n client_id=\"<client_id>\",\n client_secret=\"\
- <client_secret>\",\n )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import ClientSecretCredential\n\
+ \n credential = ClientSecretCredential(\n tenant_id=\"<tenant_id>\",\n \
+ \ client_id=\"<client_id>\",\n client_secret=\"<client_secret>\",\n \
+ \ )\n\n ````\n"
methods:
- uid: azure.identity.ClientSecretCredential.close
name: close
diff --git a/docs-ref-autogen/azure-identity/azure.identity.DefaultAzureCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.DefaultAzureCredential.yml
index 759353791249..ca926c4b6dfa 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.DefaultAzureCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.DefaultAzureCredential.yml
@@ -154,12 +154,12 @@ constructor:
examples:
- "Create a DefaultAzureCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import DefaultAzureCredential\n\n credential = DefaultAzureCredential()\n\n\
- \ ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import DefaultAzureCredential\n\
+ \n credential = DefaultAzureCredential()\n\n ````\n"
methods:
- uid: azure.identity.DefaultAzureCredential.close
name: close
diff --git a/docs-ref-autogen/azure-identity/azure.identity.DeviceCodeCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.DeviceCodeCredential.yml
index d0cbdff234c9..77486d165fbe 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.DeviceCodeCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.DeviceCodeCredential.yml
@@ -112,11 +112,12 @@ constructor:
examples:
- "Create a DeviceCodeCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import DeviceCodeCredential\n\n credential = DeviceCodeCredential()\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import DeviceCodeCredential\n\
+ \n credential = DeviceCodeCredential()\n\n ````\n"
methods:
- uid: azure.identity.DeviceCodeCredential.authenticate
name: authenticate
diff --git a/docs-ref-autogen/azure-identity/azure.identity.EnvironmentCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.EnvironmentCredential.yml
index a21a749884a0..209c9df4fb69 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.EnvironmentCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.EnvironmentCredential.yml
@@ -35,12 +35,12 @@ constructor:
examples:
- "Create an EnvironmentCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import EnvironmentCredential\n\n credential = EnvironmentCredential()\n\n \
- \ ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import EnvironmentCredential\n\
+ \n credential = EnvironmentCredential()\n\n ````\n"
methods:
- uid: azure.identity.EnvironmentCredential.close
name: close
diff --git a/docs-ref-autogen/azure-identity/azure.identity.InteractiveBrowserCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.InteractiveBrowserCredential.yml
index cf6a0c5d64c6..ac521827e726 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.InteractiveBrowserCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.InteractiveBrowserCredential.yml
@@ -106,12 +106,13 @@ constructor:
examples:
- "Create an InteractiveBrowserCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import InteractiveBrowserCredential\n\n credential = InteractiveBrowserCredential(\n\
- \ client_id=\"<client_id>\",\n )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import InteractiveBrowserCredential\n\
+ \n credential = InteractiveBrowserCredential(\n client_id=\"<client_id>\"\
+ ,\n )\n\n ````\n"
methods:
- uid: azure.identity.InteractiveBrowserCredential.authenticate
name: authenticate
diff --git a/docs-ref-autogen/azure-identity/azure.identity.ManagedIdentityCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.ManagedIdentityCredential.yml
index 953b73ea5b08..06dad905bc6f 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.ManagedIdentityCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.ManagedIdentityCredential.yml
@@ -39,13 +39,14 @@ constructor:
examples:
- "Create a ManagedIdentityCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import ManagedIdentityCredential\n\n credential = ManagedIdentityCredential()\n\
- \n # Can also specify a client ID of a user-assigned managed identity\n credential\
- \ = ManagedIdentityCredential(\n client_id=\"<client_id>\",\n )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import ManagedIdentityCredential\n\
+ \n credential = ManagedIdentityCredential()\n\n # Can also specify a client\
+ \ ID of a user-assigned managed identity\n credential = ManagedIdentityCredential(\n\
+ \ client_id=\"<client_id>\",\n )\n\n ````\n"
methods:
- uid: azure.identity.ManagedIdentityCredential.close
name: close
diff --git a/docs-ref-autogen/azure-identity/azure.identity.OnBehalfOfCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.OnBehalfOfCredential.yml
index e42fd4939f69..67fe21fa5320 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.OnBehalfOfCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.OnBehalfOfCredential.yml
@@ -108,13 +108,14 @@ constructor:
examples:
- "Create an OnBehalfOfCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import OnBehalfOfCredential\n\n credential = OnBehalfOfCredential(\n tenant_id=\"\
- <tenant_id>\",\n client_id=\"<client_id>\",\n client_secret=\"<client_secret>\"\
- ,\n user_assertion=\"<access_token>\",\n )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import OnBehalfOfCredential\n\
+ \n credential = OnBehalfOfCredential(\n tenant_id=\"<tenant_id>\",\n \
+ \ client_id=\"<client_id>\",\n client_secret=\"<client_secret>\",\n \
+ \ user_assertion=\"<access_token>\",\n )\n\n ````\n"
methods:
- uid: azure.identity.OnBehalfOfCredential.close
name: close
diff --git a/docs-ref-autogen/azure-identity/azure.identity.TokenCachePersistenceOptions.yml b/docs-ref-autogen/azure-identity/azure.identity.TokenCachePersistenceOptions.yml
index 277f48ba6786..0aac877274ec 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.TokenCachePersistenceOptions.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.TokenCachePersistenceOptions.yml
@@ -65,11 +65,12 @@ constructor:
examples:
- "Configuring a credential for persistent caching<!--[!code-python[Main](s\\test_persistent_cache.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\tests\\\\test_persistent_cache.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
- \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n cache_options\
- \ = TokenCachePersistenceOptions()\n credential = InteractiveBrowserCredential(cache_persistence_options=cache_options)\n\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\tests\\\\test_persistent_cache.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n cache_options = TokenCachePersistenceOptions()\n\
+ \ credential = InteractiveBrowserCredential(cache_persistence_options=cache_options)\n\
\n # specify a cache name to isolate the cache from other applications\n TokenCachePersistenceOptions(name=\"\
my_application\")\n\n # configure the cache to fall back to unencrypted storage\
\ when encryption isn't available\n TokenCachePersistenceOptions(allow_unencrypted_storage=True)\n\
diff --git a/docs-ref-autogen/azure-identity/azure.identity.UsernamePasswordCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.UsernamePasswordCredential.yml
index 011d7e011bd9..c09629831730 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.UsernamePasswordCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.UsernamePasswordCredential.yml
@@ -105,13 +105,14 @@ constructor:
examples:
- "Create a UsernamePasswordCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import UsernamePasswordCredential\n\n credential = UsernamePasswordCredential(\n\
- \ client_id=\"<client_id>\",\n username=\"<username>\",\n password=\"\
- <password>\",\n )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import UsernamePasswordCredential\n\
+ \n credential = UsernamePasswordCredential(\n client_id=\"<client_id>\"\
+ ,\n username=\"<username>\",\n password=\"<password>\",\n )\n\n \
+ \ ````\n"
methods:
- uid: azure.identity.UsernamePasswordCredential.authenticate
name: authenticate
diff --git a/docs-ref-autogen/azure-identity/azure.identity.WorkloadIdentityCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.WorkloadIdentityCredential.yml
index 2c389b86e1fb..2f37c4f2f112 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.WorkloadIdentityCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.WorkloadIdentityCredential.yml
@@ -66,16 +66,16 @@ constructor:
examples:
- "Create a WorkloadIdentityCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import WorkloadIdentityCredential\n\n credential = WorkloadIdentityCredential(\n\
- \ tenant_id=\"<tenant_id>\",\n client_id=\"<client_id>\",\n token_file_path=\"\
- <token_file_path>\",\n )\n\n # Parameters can be omitted if the following environment\
- \ variables are set:\n # - AZURE_TENANT_ID\n # - AZURE_CLIENT_ID\n # \
- \ - AZURE_FEDERATED_TOKEN_FILE\n credential = WorkloadIdentityCredential()\n\n\
- \ ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import WorkloadIdentityCredential\n\
+ \n credential = WorkloadIdentityCredential(\n tenant_id=\"<tenant_id>\"\
+ ,\n client_id=\"<client_id>\",\n token_file_path=\"<token_file_path>\"\
+ ,\n )\n\n # Parameters can be omitted if the following environment variables\
+ \ are set:\n # - AZURE_TENANT_ID\n # - AZURE_CLIENT_ID\n # - AZURE_FEDERATED_TOKEN_FILE\n\
+ \ credential = WorkloadIdentityCredential()\n\n ````\n"
methods:
- uid: azure.identity.WorkloadIdentityCredential.close
name: close
diff --git a/docs-ref-autogen/azure-identity/azure.identity.aio.AuthorizationCodeCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.aio.AuthorizationCodeCredential.yml
index 65e154269e8a..c5ab299fb3b8 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.aio.AuthorizationCodeCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.aio.AuthorizationCodeCredential.yml
@@ -65,11 +65,12 @@ constructor:
examples:
- "Create an AuthorizationCodeCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import AuthorizationCodeCredential\n\n credential = AuthorizationCodeCredential(\n\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ AuthorizationCodeCredential\n\n credential = AuthorizationCodeCredential(\n\
\ tenant_id=\"<tenant_id>\",\n client_id=\"<client_id>\",\n authorization_code=\"\
<auth_code>\",\n redirect_uri=\"<redirect_uri>\",\n )\n\n ````\n"
methods:
diff --git a/docs-ref-autogen/azure-identity/azure.identity.aio.AzureCliCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.aio.AzureCliCredential.yml
index 97413c367370..f8f58ff58c3a 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.aio.AzureCliCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.aio.AzureCliCredential.yml
@@ -35,11 +35,12 @@ constructor:
examples:
- "Create an AzureCliCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import AzureCliCredential\n\n credential = AzureCliCredential()\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ AzureCliCredential\n\n credential = AzureCliCredential()\n\n ````\n"
methods:
- uid: azure.identity.aio.AzureCliCredential.close
name: close
diff --git a/docs-ref-autogen/azure-identity/azure.identity.aio.AzureDeveloperCliCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.aio.AzureDeveloperCliCredential.yml
index 8b3c0d449b3e..e000e77551b9 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.aio.AzureDeveloperCliCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.aio.AzureDeveloperCliCredential.yml
@@ -51,11 +51,12 @@ constructor:
examples:
- "Create an AzureDeveloperCliCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import AzureDeveloperCliCredential\n\n credential = AzureDeveloperCliCredential()\n\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ AzureDeveloperCliCredential\n\n credential = AzureDeveloperCliCredential()\n\
\n ````\n"
methods:
- uid: azure.identity.aio.AzureDeveloperCliCredential.close
diff --git a/docs-ref-autogen/azure-identity/azure.identity.aio.AzurePowerShellCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.aio.AzurePowerShellCredential.yml
index 2b7c0cea5962..b59b5b036a84 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.aio.AzurePowerShellCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.aio.AzurePowerShellCredential.yml
@@ -35,12 +35,13 @@ constructor:
examples:
- "Create an AzurePowerShellCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import AzurePowerShellCredential\n\n credential = AzurePowerShellCredential()\n\
- \n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ AzurePowerShellCredential\n\n credential = AzurePowerShellCredential()\n\n \
+ \ ````\n"
methods:
- uid: azure.identity.aio.AzurePowerShellCredential.close
name: close
diff --git a/docs-ref-autogen/azure-identity/azure.identity.aio.CertificateCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.aio.CertificateCredential.yml
index 032caa88bf03..facdaccbaed9 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.aio.CertificateCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.aio.CertificateCredential.yml
@@ -77,17 +77,18 @@ constructor:
examples:
- "Create a CertificateCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import CertificateCredential\n\n credential = CertificateCredential(\n \
- \ tenant_id=\"<tenant_id>\",\n client_id=\"<client_id>\",\n certificate_path=\"\
- <path to PEM/PKCS12 certificate>\",\n password=\"<certificate password if\
- \ necessary>\",\n )\n\n # Certificate/private key byte data can also be passed\
- \ directly\n credential = CertificateCredential(\n tenant_id=\"<tenant_id>\"\
- ,\n client_id=\"<client_id>\",\n certificate_data=b\"<cert data>\",\n\
- \ )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ CertificateCredential\n\n credential = CertificateCredential(\n tenant_id=\"\
+ <tenant_id>\",\n client_id=\"<client_id>\",\n certificate_path=\"<path\
+ \ to PEM/PKCS12 certificate>\",\n password=\"<certificate password if necessary>\"\
+ ,\n )\n\n # Certificate/private key byte data can also be passed directly\n\
+ \ credential = CertificateCredential(\n tenant_id=\"<tenant_id>\",\n \
+ \ client_id=\"<client_id>\",\n certificate_data=b\"<cert data>\",\n )\n\
+ \n ````\n"
methods:
- uid: azure.identity.aio.CertificateCredential.close
name: close
diff --git a/docs-ref-autogen/azure-identity/azure.identity.aio.ChainedTokenCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.aio.ChainedTokenCredential.yml
index 04e62080102c..3997dc3cc236 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.aio.ChainedTokenCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.aio.ChainedTokenCredential.yml
@@ -23,12 +23,13 @@ constructor:
examples:
- "Create a ChainedTokenCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import ChainedTokenCredential, EnvironmentCredential, AzureCliCredential\n\n \
- \ credential_chain = (\n # Try EnvironmentCredential first\n EnvironmentCredential(),\n\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ ChainedTokenCredential, EnvironmentCredential, AzureCliCredential\n\n credential_chain\
+ \ = (\n # Try EnvironmentCredential first\n EnvironmentCredential(),\n\
\ # Fallback to Azure CLI if EnvironmentCredential fails\n AzureCliCredential(),\n\
\ )\n credential = ChainedTokenCredential(*credential_chain)\n\n ````\n"
methods:
diff --git a/docs-ref-autogen/azure-identity/azure.identity.aio.ClientAssertionCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.aio.ClientAssertionCredential.yml
index 9c7524d20b92..2c7307bb0295 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.aio.ClientAssertionCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.aio.ClientAssertionCredential.yml
@@ -55,14 +55,14 @@ constructor:
examples:
- "Create a ClientAssertionCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import ClientAssertionCredential\n\n def get_assertion():\n return \"\
- <client-assertion>\"\n\n credential = ClientAssertionCredential(\n tenant_id=\"\
- <tenant_id>\",\n client_id=\"<client_id>\",\n func=get_assertion,\n\
- \ )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ ClientAssertionCredential\n\n def get_assertion():\n return \"<client-assertion>\"\
+ \n\n credential = ClientAssertionCredential(\n tenant_id=\"<tenant_id>\"\
+ ,\n client_id=\"<client_id>\",\n func=get_assertion,\n )\n\n ````\n"
methods:
- uid: azure.identity.aio.ClientAssertionCredential.close
name: close
diff --git a/docs-ref-autogen/azure-identity/azure.identity.aio.ClientSecretCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.aio.ClientSecretCredential.yml
index 636b80c37aff..6b37e37c0e56 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.aio.ClientSecretCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.aio.ClientSecretCredential.yml
@@ -54,13 +54,14 @@ constructor:
examples:
- "Create a ClientSecretCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import ClientSecretCredential\n\n credential = ClientSecretCredential(\n \
- \ tenant_id=\"<tenant_id>\",\n client_id=\"<client_id>\",\n client_secret=\"\
- <client_secret>\",\n )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ ClientSecretCredential\n\n credential = ClientSecretCredential(\n tenant_id=\"\
+ <tenant_id>\",\n client_id=\"<client_id>\",\n client_secret=\"<client_secret>\"\
+ ,\n )\n\n ````\n"
methods:
- uid: azure.identity.aio.ClientSecretCredential.close
name: close
diff --git a/docs-ref-autogen/azure-identity/azure.identity.aio.DefaultAzureCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.aio.DefaultAzureCredential.yml
index 477c285f9728..ada7fc60b505 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.aio.DefaultAzureCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.aio.DefaultAzureCredential.yml
@@ -133,12 +133,12 @@ constructor:
examples:
- "Create a DefaultAzureCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import DefaultAzureCredential\n\n credential = DefaultAzureCredential()\n\n\
- \ ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ DefaultAzureCredential\n\n credential = DefaultAzureCredential()\n\n ````\n"
methods:
- uid: azure.identity.aio.DefaultAzureCredential.close
name: close
diff --git a/docs-ref-autogen/azure-identity/azure.identity.aio.EnvironmentCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.aio.EnvironmentCredential.yml
index 166d717f1608..03a61bb3bd89 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.aio.EnvironmentCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.aio.EnvironmentCredential.yml
@@ -27,12 +27,12 @@ constructor:
examples:
- "Create an EnvironmentCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import EnvironmentCredential\n\n credential = EnvironmentCredential()\n\n \
- \ ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ EnvironmentCredential\n\n credential = EnvironmentCredential()\n\n ````\n"
methods:
- uid: azure.identity.aio.EnvironmentCredential.close
name: close
diff --git a/docs-ref-autogen/azure-identity/azure.identity.aio.ManagedIdentityCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.aio.ManagedIdentityCredential.yml
index 97274a97dd76..5a438b5bc953 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.aio.ManagedIdentityCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.aio.ManagedIdentityCredential.yml
@@ -39,12 +39,13 @@ constructor:
examples:
- "Create a ManagedIdentityCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import ManagedIdentityCredential\n\n credential = ManagedIdentityCredential()\n\
- \n # Can also specify a client ID of a user-assigned managed identity\n credential\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ ManagedIdentityCredential\n\n credential = ManagedIdentityCredential()\n\n \
+ \ # Can also specify a client ID of a user-assigned managed identity\n credential\
\ = ManagedIdentityCredential(\n client_id=\"<client_id>\",\n )\n\n ````\n"
methods:
- uid: azure.identity.aio.ManagedIdentityCredential.close
diff --git a/docs-ref-autogen/azure-identity/azure.identity.aio.OnBehalfOfCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.aio.OnBehalfOfCredential.yml
index 7affd8b3c5ab..65c47b8e8337 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.aio.OnBehalfOfCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.aio.OnBehalfOfCredential.yml
@@ -89,11 +89,12 @@ constructor:
examples:
- "Create an OnBehalfOfCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import OnBehalfOfCredential\n\n credential = OnBehalfOfCredential(\n tenant_id=\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ OnBehalfOfCredential\n\n credential = OnBehalfOfCredential(\n tenant_id=\"\
<tenant_id>\",\n client_id=\"<client_id>\",\n client_secret=\"<client_secret>\"\
,\n user_assertion=\"<access_token>\",\n )\n\n ````\n"
methods:
diff --git a/docs-ref-autogen/azure-identity/azure.identity.aio.WorkloadIdentityCredential.yml b/docs-ref-autogen/azure-identity/azure.identity.aio.WorkloadIdentityCredential.yml
index 7bf94121f9e6..a83bfa1f01a9 100644
--- a/docs-ref-autogen/azure-identity/azure.identity.aio.WorkloadIdentityCredential.yml
+++ b/docs-ref-autogen/azure-identity/azure.identity.aio.WorkloadIdentityCredential.yml
@@ -66,12 +66,13 @@ constructor:
examples:
- "Create a WorkloadIdentityCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 46\\\\azure-identity-1.14.0\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import WorkloadIdentityCredential\n\n credential = WorkloadIdentityCredential(\n\
- \ tenant_id=\"<tenant_id>\",\n client_id=\"<client_id>\",\n token_file_path=\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.14.0\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ WorkloadIdentityCredential\n\n credential = WorkloadIdentityCredential(\n \
+ \ tenant_id=\"<tenant_id>\",\n client_id=\"<client_id>\",\n token_file_path=\"\
<token_file_path>\",\n )\n\n # Parameters can be omitted if the following environment\
\ variables are set:\n # - AZURE_TENANT_ID\n # - AZURE_CLIENT_ID\n # \
\ - AZURE_FEDERATED_TOKEN_FILE\n credential = WorkloadIdentityCredential()\n\n\
diff --git a/docs-ref-autogen/azure-mgmt-compute/azure.mgmt.compute.ComputeManagementClient.yml b/docs-ref-autogen/azure-mgmt-compute/azure.mgmt.compute.ComputeManagementClient.yml
index f776c7888d95..367eeeb50d94 100644
--- a/docs-ref-autogen/azure-mgmt-compute/azure.mgmt.compute.ComputeManagementClient.yml
+++ b/docs-ref-autogen/azure-mgmt-compute/azure.mgmt.compute.ComputeManagementClient.yml
@@ -66,33 +66,45 @@ methods:
signature: close()
- uid: azure.mgmt.compute.ComputeManagementClient.models
name: models
- summary: "Module depends on the API version:\n\n* 2015-06-15: <xref:azure.mgmt.compute.v2015_06_15.models>\
- \ \n\n* 2016-03-30: <xref:azure.mgmt.compute.v2016_03_30.models> \n\n* 2016-04-30-preview:\
- \ <xref:azure.mgmt.compute.v2016_04_30_preview.models> \n\n* 2017-03-30: <xref:azure.mgmt.compute.v2017_03_30.models>\
- \ \n\n* 2017-09-01: <xref:azure.mgmt.compute.v2017_09_01.models> \n\n* 2017-12-01:\
- \ <xref:azure.mgmt.compute.v2017_12_01.models> \n\n* 2018-04-01: <xref:azure.mgmt.compute.v2018_04_01.models>\
- \ \n\n* 2018-06-01: <xref:azure.mgmt.compute.v2018_06_01.models> \n\n* 2018-09-30:\
- \ <xref:azure.mgmt.compute.v2018_09_30.models> \n\n* 2018-10-01: <xref:azure.mgmt.compute.v2018_10_01.models>\
- \ \n\n* 2019-03-01: <xref:azure.mgmt.compute.v2019_03_01.models> \n\n* 2019-04-01:\
- \ <xref:azure.mgmt.compute.v2019_04_01.models> \n\n* 2019-07-01: <xref:azure.mgmt.compute.v2019_07_01.models>\
- \ \n\n* 2019-11-01: <xref:azure.mgmt.compute.v2019_11_01.models> \n\n* 2019-12-01:\
- \ <xref:azure.mgmt.compute.v2019_12_01.models> \n\n* 2020-05-01: <xref:azure.mgmt.compute.v2020_05_01.models>\
- \ \n\n* 2020-06-01: <xref:azure.mgmt.compute.v2020_06_01.models> \n\n* 2020-06-30:\
- \ <xref:azure.mgmt.compute.v2020_06_30.models> \n\n* 2020-09-30: <xref:azure.mgmt.compute.v2020_09_30.models>\
- \ \n\n* 2020-10-01-preview: <xref:azure.mgmt.compute.v2020_10_01_preview.models>\
- \ \n\n* 2020-12-01: <xref:azure.mgmt.compute.v2020_12_01.models> \n\n* 2021-03-01:\
- \ <xref:azure.mgmt.compute.v2021_03_01.models> \n\n* 2021-04-01: <xref:azure.mgmt.compute.v2021_04_01.models>\
- \ \n\n* 2021-07-01: <xref:azure.mgmt.compute.v2021_07_01.models> \n\n* 2021-08-01:\
- \ <xref:azure.mgmt.compute.v2021_08_01.models> \n\n* 2021-10-01: <xref:azure.mgmt.compute.v2021_10_01.models>\
- \ \n\n* 2021-11-01: <xref:azure.mgmt.compute.v2021_11_01.models> \n\n* 2021-12-01:\
- \ <xref:azure.mgmt.compute.v2021_12_01.models> \n\n* 2022-01-03: <xref:azure.mgmt.compute.v2022_01_03.models>\
- \ \n\n* 2022-03-01: <xref:azure.mgmt.compute.v2022_03_01.models> \n\n* 2022-03-02:\
- \ <xref:azure.mgmt.compute.v2022_03_02.models> \n\n* 2022-03-03: <xref:azure.mgmt.compute.v2022_03_03.models>\
- \ \n\n* 2022-04-04: <xref:azure.mgmt.compute.v2022_04_04.models> \n\n* 2022-07-02:\
- \ <xref:azure.mgmt.compute.v2022_07_02.models> \n\n* 2022-08-01: <xref:azure.mgmt.compute.v2022_08_01.models>\
- \ \n\n* 2022-09-04: <xref:azure.mgmt.compute.v2022_09_04.models> \n\n* 2022-11-01:\
- \ <xref:azure.mgmt.compute.v2022_11_01.models> \n\n* 2023-01-02: <xref:azure.mgmt.compute.v2023_01_02.models>\
- \ \n\n* 2023-03-01: <xref:azure.mgmt.compute.v2023_03_01.models>"
+ summary: "Module depends on the API version:\n\n* 2015-06-15: <xref:azure.mgmt.compute.v2015_06_15.models#module-azure.mgmt.compute.v2015_06_15.models>\
+ \ \n\n* 2016-03-30: <xref:azure.mgmt.compute.v2016_03_30.models#module-azure.mgmt.compute.v2016_03_30.models>\
+ \ \n\n* 2016-04-30-preview: <xref:azure.mgmt.compute.v2016_04_30_preview.models#module-azure.mgmt.compute.v2016_04_30_preview.models>\
+ \ \n\n* 2017-03-30: <xref:azure.mgmt.compute.v2017_03_30.models#module-azure.mgmt.compute.v2017_03_30.models>\
+ \ \n\n* 2017-09-01: <xref:azure.mgmt.compute.v2017_09_01.models#module-azure.mgmt.compute.v2017_09_01.models>\
+ \ \n\n* 2017-12-01: <xref:azure.mgmt.compute.v2017_12_01.models#module-azure.mgmt.compute.v2017_12_01.models>\
+ \ \n\n* 2018-04-01: <xref:azure.mgmt.compute.v2018_04_01.models#module-azure.mgmt.compute.v2018_04_01.models>\
+ \ \n\n* 2018-06-01: <xref:azure.mgmt.compute.v2018_06_01.models#module-azure.mgmt.compute.v2018_06_01.models>\
+ \ \n\n* 2018-09-30: <xref:azure.mgmt.compute.v2018_09_30.models#module-azure.mgmt.compute.v2018_09_30.models>\
+ \ \n\n* 2018-10-01: <xref:azure.mgmt.compute.v2018_10_01.models#module-azure.mgmt.compute.v2018_10_01.models>\
+ \ \n\n* 2019-03-01: <xref:azure.mgmt.compute.v2019_03_01.models#module-azure.mgmt.compute.v2019_03_01.models>\
+ \ \n\n* 2019-04-01: <xref:azure.mgmt.compute.v2019_04_01.models#module-azure.mgmt.compute.v2019_04_01.models>\
+ \ \n\n* 2019-07-01: <xref:azure.mgmt.compute.v2019_07_01.models#module-azure.mgmt.compute.v2019_07_01.models>\
+ \ \n\n* 2019-11-01: <xref:azure.mgmt.compute.v2019_11_01.models#module-azure.mgmt.compute.v2019_11_01.models>\
+ \ \n\n* 2019-12-01: <xref:azure.mgmt.compute.v2019_12_01.models#module-azure.mgmt.compute.v2019_12_01.models>\
+ \ \n\n* 2020-05-01: <xref:azure.mgmt.compute.v2020_05_01.models#module-azure.mgmt.compute.v2020_05_01.models>\
+ \ \n\n* 2020-06-01: <xref:azure.mgmt.compute.v2020_06_01.models#module-azure.mgmt.compute.v2020_06_01.models>\
+ \ \n\n* 2020-06-30: <xref:azure.mgmt.compute.v2020_06_30.models#module-azure.mgmt.compute.v2020_06_30.models>\
+ \ \n\n* 2020-09-30: <xref:azure.mgmt.compute.v2020_09_30.models#module-azure.mgmt.compute.v2020_09_30.models>\
+ \ \n\n* 2020-10-01-preview: <xref:azure.mgmt.compute.v2020_10_01_preview.models#module-azure.mgmt.compute.v2020_10_01_preview.models>\
+ \ \n\n* 2020-12-01: <xref:azure.mgmt.compute.v2020_12_01.models#module-azure.mgmt.compute.v2020_12_01.models>\
+ \ \n\n* 2021-03-01: <xref:azure.mgmt.compute.v2021_03_01.models#module-azure.mgmt.compute.v2021_03_01.models>\
+ \ \n\n* 2021-04-01: <xref:azure.mgmt.compute.v2021_04_01.models#module-azure.mgmt.compute.v2021_04_01.models>\
+ \ \n\n* 2021-07-01: <xref:azure.mgmt.compute.v2021_07_01.models#module-azure.mgmt.compute.v2021_07_01.models>\
+ \ \n\n* 2021-08-01: <xref:azure.mgmt.compute.v2021_08_01.models#module-azure.mgmt.compute.v2021_08_01.models>\
+ \ \n\n* 2021-10-01: <xref:azure.mgmt.compute.v2021_10_01.models#module-azure.mgmt.compute.v2021_10_01.models>\
+ \ \n\n* 2021-11-01: <xref:azure.mgmt.compute.v2021_11_01.models#module-azure.mgmt.compute.v2021_11_01.models>\
+ \ \n\n* 2021-12-01: <xref:azure.mgmt.compute.v2021_12_01.models#module-azure.mgmt.compute.v2021_12_01.models>\
+ \ \n\n* 2022-01-03: <xref:azure.mgmt.compute.v2022_01_03.models#module-azure.mgmt.compute.v2022_01_03.models>\
+ \ \n\n* 2022-03-01: <xref:azure.mgmt.compute.v2022_03_01.models#module-azure.mgmt.compute.v2022_03_01.models>\
+ \ \n\n* 2022-03-02: <xref:azure.mgmt.compute.v2022_03_02.models#module-azure.mgmt.compute.v2022_03_02.models>\
+ \ \n\n* 2022-03-03: <xref:azure.mgmt.compute.v2022_03_03.models#module-azure.mgmt.compute.v2022_03_03.models>\
+ \ \n\n* 2022-04-04: <xref:azure.mgmt.compute.v2022_04_04.models#module-azure.mgmt.compute.v2022_04_04.models>\
+ \ \n\n* 2022-07-02: <xref:azure.mgmt.compute.v2022_07_02.models#module-azure.mgmt.compute.v2022_07_02.models>\
+ \ \n\n* 2022-08-01: <xref:azure.mgmt.compute.v2022_08_01.models#module-azure.mgmt.compute.v2022_08_01.models>\
+ \ \n\n* 2022-09-04: <xref:azure.mgmt.compute.v2022_09_04.models#module-azure.mgmt.compute.v2022_09_04.models>\
+ \ \n\n* 2022-11-01: <xref:azure.mgmt.compute.v2022_11_01.models#module-azure.mgmt.compute.v2022_11_01.models>\
+ \ \n\n* 2023-01-02: <xref:azure.mgmt.compute.v2023_01_02.models#module-azure.mgmt.compute.v2023_01_02.models>\
+ \ \n\n* 2023-03-01: <xref:azure.mgmt.compute.v2023_03_01.models#module-azure.mgmt.compute.v2023_03_01.models>"
signature: models(api_version='2023-03-01')
parameters:
- name: api_version
diff --git a/docs-ref-autogen/azure-mgmt-compute/azure.mgmt.compute.aio.ComputeManagementClient.yml b/docs-ref-autogen/azure-mgmt-compute/azure.mgmt.compute.aio.ComputeManagementClient.yml
index ab0bc00bf83f..199d900676f2 100644
--- a/docs-ref-autogen/azure-mgmt-compute/azure.mgmt.compute.aio.ComputeManagementClient.yml
+++ b/docs-ref-autogen/azure-mgmt-compute/azure.mgmt.compute.aio.ComputeManagementClient.yml
@@ -66,33 +66,45 @@ methods:
signature: async close()
- uid: azure.mgmt.compute.aio.ComputeManagementClient.models
name: models
- summary: "Module depends on the API version:\n\n* 2015-06-15: <xref:azure.mgmt.compute.v2015_06_15.models>\
- \ \n\n* 2016-03-30: <xref:azure.mgmt.compute.v2016_03_30.models> \n\n* 2016-04-30-preview:\
- \ <xref:azure.mgmt.compute.v2016_04_30_preview.models> \n\n* 2017-03-30: <xref:azure.mgmt.compute.v2017_03_30.models>\
- \ \n\n* 2017-09-01: <xref:azure.mgmt.compute.v2017_09_01.models> \n\n* 2017-12-01:\
- \ <xref:azure.mgmt.compute.v2017_12_01.models> \n\n* 2018-04-01: <xref:azure.mgmt.compute.v2018_04_01.models>\
- \ \n\n* 2018-06-01: <xref:azure.mgmt.compute.v2018_06_01.models> \n\n* 2018-09-30:\
- \ <xref:azure.mgmt.compute.v2018_09_30.models> \n\n* 2018-10-01: <xref:azure.mgmt.compute.v2018_10_01.models>\
- \ \n\n* 2019-03-01: <xref:azure.mgmt.compute.v2019_03_01.models> \n\n* 2019-04-01:\
- \ <xref:azure.mgmt.compute.v2019_04_01.models> \n\n* 2019-07-01: <xref:azure.mgmt.compute.v2019_07_01.models>\
- \ \n\n* 2019-11-01: <xref:azure.mgmt.compute.v2019_11_01.models> \n\n* 2019-12-01:\
- \ <xref:azure.mgmt.compute.v2019_12_01.models> \n\n* 2020-05-01: <xref:azure.mgmt.compute.v2020_05_01.models>\
- \ \n\n* 2020-06-01: <xref:azure.mgmt.compute.v2020_06_01.models> \n\n* 2020-06-30:\
- \ <xref:azure.mgmt.compute.v2020_06_30.models> \n\n* 2020-09-30: <xref:azure.mgmt.compute.v2020_09_30.models>\
- \ \n\n* 2020-10-01-preview: <xref:azure.mgmt.compute.v2020_10_01_preview.models>\
- \ \n\n* 2020-12-01: <xref:azure.mgmt.compute.v2020_12_01.models> \n\n* 2021-03-01:\
- \ <xref:azure.mgmt.compute.v2021_03_01.models> \n\n* 2021-04-01: <xref:azure.mgmt.compute.v2021_04_01.models>\
- \ \n\n* 2021-07-01: <xref:azure.mgmt.compute.v2021_07_01.models> \n\n* 2021-08-01:\
- \ <xref:azure.mgmt.compute.v2021_08_01.models> \n\n* 2021-10-01: <xref:azure.mgmt.compute.v2021_10_01.models>\
- \ \n\n* 2021-11-01: <xref:azure.mgmt.compute.v2021_11_01.models> \n\n* 2021-12-01:\
- \ <xref:azure.mgmt.compute.v2021_12_01.models> \n\n* 2022-01-03: <xref:azure.mgmt.compute.v2022_01_03.models>\
- \ \n\n* 2022-03-01: <xref:azure.mgmt.compute.v2022_03_01.models> \n\n* 2022-03-02:\
- \ <xref:azure.mgmt.compute.v2022_03_02.models> \n\n* 2022-03-03: <xref:azure.mgmt.compute.v2022_03_03.models>\
- \ \n\n* 2022-04-04: <xref:azure.mgmt.compute.v2022_04_04.models> \n\n* 2022-07-02:\
- \ <xref:azure.mgmt.compute.v2022_07_02.models> \n\n* 2022-08-01: <xref:azure.mgmt.compute.v2022_08_01.models>\
- \ \n\n* 2022-09-04: <xref:azure.mgmt.compute.v2022_09_04.models> \n\n* 2022-11-01:\
- \ <xref:azure.mgmt.compute.v2022_11_01.models> \n\n* 2023-01-02: <xref:azure.mgmt.compute.v2023_01_02.models>\
- \ \n\n* 2023-03-01: <xref:azure.mgmt.compute.v2023_03_01.models>"
+ summary: "Module depends on the API version:\n\n* 2015-06-15: <xref:azure.mgmt.compute.v2015_06_15.models#module-azure.mgmt.compute.v2015_06_15.models>\
+ \ \n\n* 2016-03-30: <xref:azure.mgmt.compute.v2016_03_30.models#module-azure.mgmt.compute.v2016_03_30.models>\
+ \ \n\n* 2016-04-30-preview: <xref:azure.mgmt.compute.v2016_04_30_preview.models#module-azure.mgmt.compute.v2016_04_30_preview.models>\
+ \ \n\n* 2017-03-30: <xref:azure.mgmt.compute.v2017_03_30.models#module-azure.mgmt.compute.v2017_03_30.models>\
+ \ \n\n* 2017-09-01: <xref:azure.mgmt.compute.v2017_09_01.models#module-azure.mgmt.compute.v2017_09_01.models>\
+ \ \n\n* 2017-12-01: <xref:azure.mgmt.compute.v2017_12_01.models#module-azure.mgmt.compute.v2017_12_01.models>\
+ \ \n\n* 2018-04-01: <xref:azure.mgmt.compute.v2018_04_01.models#module-azure.mgmt.compute.v2018_04_01.models>\
+ \ \n\n* 2018-06-01: <xref:azure.mgmt.compute.v2018_06_01.models#module-azure.mgmt.compute.v2018_06_01.models>\
+ \ \n\n* 2018-09-30: <xref:azure.mgmt.compute.v2018_09_30.models#module-azure.mgmt.compute.v2018_09_30.models>\
+ \ \n\n* 2018-10-01: <xref:azure.mgmt.compute.v2018_10_01.models#module-azure.mgmt.compute.v2018_10_01.models>\
+ \ \n\n* 2019-03-01: <xref:azure.mgmt.compute.v2019_03_01.models#module-azure.mgmt.compute.v2019_03_01.models>\
+ \ \n\n* 2019-04-01: <xref:azure.mgmt.compute.v2019_04_01.models#module-azure.mgmt.compute.v2019_04_01.models>\
+ \ \n\n* 2019-07-01: <xref:azure.mgmt.compute.v2019_07_01.models#module-azure.mgmt.compute.v2019_07_01.models>\
+ \ \n\n* 2019-11-01: <xref:azure.mgmt.compute.v2019_11_01.models#module-azure.mgmt.compute.v2019_11_01.models>\
+ \ \n\n* 2019-12-01: <xref:azure.mgmt.compute.v2019_12_01.models#module-azure.mgmt.compute.v2019_12_01.models>\
+ \ \n\n* 2020-05-01: <xref:azure.mgmt.compute.v2020_05_01.models#module-azure.mgmt.compute.v2020_05_01.models>\
+ \ \n\n* 2020-06-01: <xref:azure.mgmt.compute.v2020_06_01.models#module-azure.mgmt.compute.v2020_06_01.models>\
+ \ \n\n* 2020-06-30: <xref:azure.mgmt.compute.v2020_06_30.models#module-azure.mgmt.compute.v2020_06_30.models>\
+ \ \n\n* 2020-09-30: <xref:azure.mgmt.compute.v2020_09_30.models#module-azure.mgmt.compute.v2020_09_30.models>\
+ \ \n\n* 2020-10-01-preview: <xref:azure.mgmt.compute.v2020_10_01_preview.models#module-azure.mgmt.compute.v2020_10_01_preview.models>\
+ \ \n\n* 2020-12-01: <xref:azure.mgmt.compute.v2020_12_01.models#module-azure.mgmt.compute.v2020_12_01.models>\
+ \ \n\n* 2021-03-01: <xref:azure.mgmt.compute.v2021_03_01.models#module-azure.mgmt.compute.v2021_03_01.models>\
+ \ \n\n* 2021-04-01: <xref:azure.mgmt.compute.v2021_04_01.models#module-azure.mgmt.compute.v2021_04_01.models>\
+ \ \n\n* 2021-07-01: <xref:azure.mgmt.compute.v2021_07_01.models#module-azure.mgmt.compute.v2021_07_01.models>\
+ \ \n\n* 2021-08-01: <xref:azure.mgmt.compute.v2021_08_01.models#module-azure.mgmt.compute.v2021_08_01.models>\
+ \ \n\n* 2021-10-01: <xref:azure.mgmt.compute.v2021_10_01.models#module-azure.mgmt.compute.v2021_10_01.models>\
+ \ \n\n* 2021-11-01: <xref:azure.mgmt.compute.v2021_11_01.models#module-azure.mgmt.compute.v2021_11_01.models>\
+ \ \n\n* 2021-12-01: <xref:azure.mgmt.compute.v2021_12_01.models#module-azure.mgmt.compute.v2021_12_01.models>\
+ \ \n\n* 2022-01-03: <xref:azure.mgmt.compute.v2022_01_03.models#module-azure.mgmt.compute.v2022_01_03.models>\
+ \ \n\n* 2022-03-01: <xref:azure.mgmt.compute.v2022_03_01.models#module-azure.mgmt.compute.v2022_03_01.models>\
+ \ \n\n* 2022-03-02: <xref:azure.mgmt.compute.v2022_03_02.models#module-azure.mgmt.compute.v2022_03_02.models>\
+ \ \n\n* 2022-03-03: <xref:azure.mgmt.compute.v2022_03_03.models#module-azure.mgmt.compute.v2022_03_03.models>\
+ \ \n\n* 2022-04-04: <xref:azure.mgmt.compute.v2022_04_04.models#module-azure.mgmt.compute.v2022_04_04.models>\
+ \ \n\n* 2022-07-02: <xref:azure.mgmt.compute.v2022_07_02.models#module-azure.mgmt.compute.v2022_07_02.models>\
+ \ \n\n* 2022-08-01: <xref:azure.mgmt.compute.v2022_08_01.models#module-azure.mgmt.compute.v2022_08_01.models>\
+ \ \n\n* 2022-09-04: <xref:azure.mgmt.compute.v2022_09_04.models#module-azure.mgmt.compute.v2022_09_04.models>\
+ \ \n\n* 2022-11-01: <xref:azure.mgmt.compute.v2022_11_01.models#module-azure.mgmt.compute.v2022_11_01.models>\
+ \ \n\n* 2023-01-02: <xref:azure.mgmt.compute.v2023_01_02.models#module-azure.mgmt.compute.v2023_01_02.models>\
+ \ \n\n* 2023-03-01: <xref:azure.mgmt.compute.v2023_03_01.models#module-azure.mgmt.compute.v2023_03_01.models>"
signature: models(api_version='2023-03-01')
parameters:
- name: api_version
diff --git a/docs-ref-autogen/azure-mgmt-compute/azure.mgmt.compute.yml b/docs-ref-autogen/azure-mgmt-compute/azure.mgmt.compute.yml
index 8fedf52a8df2..9dc69b6a299d 100644
--- a/docs-ref-autogen/azure-mgmt-compute/azure.mgmt.compute.yml
+++ b/docs-ref-autogen/azure-mgmt-compute/azure.mgmt.compute.yml
@@ -5,8 +5,6 @@ fullName: azure.mgmt.compute
type: import
classes:
- azure.mgmt.compute.ComputeManagementClient
-modules:
-- azure.mgmt.compute.models
packages:
- azure.mgmt.compute.aio
- azure.mgmt.compute.v2015_06_15
@@ -48,3 +46,5 @@ packages:
- azure.mgmt.compute.v2022_11_01
- azure.mgmt.compute.v2023_01_02
- azure.mgmt.compute.v2023_03_01
+modules:
+- azure.mgmt.compute.models
diff --git a/docs-ref-autogen/azure-mgmt-containerregistry/azure.mgmt.containerregistry.ContainerRegistryManagementClient.yml b/docs-ref-autogen/azure-mgmt-containerregistry/azure.mgmt.containerregistry.ContainerRegistryManagementClient.yml
index 03898cf3c9db..f672480e35d7 100644
--- a/docs-ref-autogen/azure-mgmt-containerregistry/azure.mgmt.containerregistry.ContainerRegistryManagementClient.yml
+++ b/docs-ref-autogen/azure-mgmt-containerregistry/azure.mgmt.containerregistry.ContainerRegistryManagementClient.yml
@@ -64,23 +64,23 @@ methods:
signature: close()
- uid: azure.mgmt.containerregistry.ContainerRegistryManagementClient.models
name: models
- summary: "Module depends on the API version:\n\n* 2017-03-01: <xref:azure.mgmt.containerregistry.v2017_03_01.models>\
- \ \n\n* 2017-10-01: <xref:azure.mgmt.containerregistry.v2017_10_01.models> \n\n\
- * 2018-02-01-preview: <xref:azure.mgmt.containerregistry.v2018_02_01_preview.models>\
- \ \n\n* 2018-09-01: <xref:azure.mgmt.containerregistry.v2018_09_01.models> \n\n\
- * 2019-04-01: <xref:azure.mgmt.containerregistry.v2019_04_01.models> \n\n* 2019-05-01:\
- \ <xref:azure.mgmt.containerregistry.v2019_05_01.models> \n\n* 2019-05-01-preview:\
- \ <xref:azure.mgmt.containerregistry.v2019_05_01_preview.models> \n\n* 2019-06-01-preview:\
- \ <xref:azure.mgmt.containerregistry.v2019_06_01_preview.models> \n\n* 2019-12-01-preview:\
- \ <xref:azure.mgmt.containerregistry.v2019_12_01_preview.models> \n\n* 2020-11-01-preview:\
- \ <xref:azure.mgmt.containerregistry.v2020_11_01_preview.models> \n\n* 2021-06-01-preview:\
- \ <xref:azure.mgmt.containerregistry.v2021_06_01_preview.models> \n\n* 2021-08-01-preview:\
- \ <xref:azure.mgmt.containerregistry.v2021_08_01_preview.models> \n\n* 2021-09-01:\
- \ <xref:azure.mgmt.containerregistry.v2021_09_01.models> \n\n* 2021-12-01-preview:\
- \ <xref:azure.mgmt.containerregistry.v2021_12_01_preview.models> \n\n* 2022-02-01-preview:\
- \ <xref:azure.mgmt.containerregistry.v2022_02_01_preview.models> \n\n* 2022-12-01:\
- \ <xref:azure.mgmt.containerregistry.v2022_12_01.models> \n\n* 2023-01-01-preview:\
- \ <xref:azure.mgmt.containerregistry.v2023_01_01_preview.models>"
+ summary: "Module depends on the API version:\n\n* 2017-03-01: <xref:azure.mgmt.containerregistry.v2017_03_01.models#module-azure.mgmt.containerregistry.v2017_03_01.models>\
+ \ \n\n* 2017-10-01: <xref:azure.mgmt.containerregistry.v2017_10_01.models#module-azure.mgmt.containerregistry.v2017_10_01.models>\
+ \ \n\n* 2018-02-01-preview: <xref:azure.mgmt.containerregistry.v2018_02_01_preview.models#module-azure.mgmt.containerregistry.v2018_02_01_preview.models>\
+ \ \n\n* 2018-09-01: <xref:azure.mgmt.containerregistry.v2018_09_01.models#module-azure.mgmt.containerregistry.v2018_09_01.models>\
+ \ \n\n* 2019-04-01: <xref:azure.mgmt.containerregistry.v2019_04_01.models#module-azure.mgmt.containerregistry.v2019_04_01.models>\
+ \ \n\n* 2019-05-01: <xref:azure.mgmt.containerregistry.v2019_05_01.models#module-azure.mgmt.containerregistry.v2019_05_01.models>\
+ \ \n\n* 2019-05-01-preview: <xref:azure.mgmt.containerregistry.v2019_05_01_preview.models#module-azure.mgmt.containerregistry.v2019_05_01_preview.models>\
+ \ \n\n* 2019-06-01-preview: <xref:azure.mgmt.containerregistry.v2019_06_01_preview.models#module-azure.mgmt.containerregistry.v2019_06_01_preview.models>\
+ \ \n\n* 2019-12-01-preview: <xref:azure.mgmt.containerregistry.v2019_12_01_preview.models#module-azure.mgmt.containerregistry.v2019_12_01_preview.models>\
+ \ \n\n* 2020-11-01-preview: <xref:azure.mgmt.containerregistry.v2020_11_01_preview.models#module-azure.mgmt.containerregistry.v2020_11_01_preview.models>\
+ \ \n\n* 2021-06-01-preview: <xref:azure.mgmt.containerregistry.v2021_06_01_preview.models#module-azure.mgmt.containerregistry.v2021_06_01_preview.models>\
+ \ \n\n* 2021-08-01-preview: <xref:azure.mgmt.containerregistry.v2021_08_01_preview.models#module-azure.mgmt.containerregistry.v2021_08_01_preview.models>\
+ \ \n\n* 2021-09-01: <xref:azure.mgmt.containerregistry.v2021_09_01.models#module-azure.mgmt.containerregistry.v2021_09_01.models>\
+ \ \n\n* 2021-12-01-preview: <xref:azure.mgmt.containerregistry.v2021_12_01_preview.models#module-azure.mgmt.containerregistry.v2021_12_01_preview.models>\
+ \ \n\n* 2022-02-01-preview: <xref:azure.mgmt.containerregistry.v2022_02_01_preview.models#module-azure.mgmt.containerregistry.v2022_02_01_preview.models>\
+ \ \n\n* 2022-12-01: <xref:azure.mgmt.containerregistry.v2022_12_01.models#module-azure.mgmt.containerregistry.v2022_12_01.models>\
+ \ \n\n* 2023-01-01-preview: <xref:azure.mgmt.containerregistry.v2023_01_01_preview.models#module-azure.mgmt.containerregistry.v2023_01_01_preview.models>"
signature: models(api_version='2022-12-01')
parameters:
- name: api_version
diff --git a/docs-ref-autogen/azure-mgmt-containerregistry/azure.mgmt.containerregistry.aio.ContainerRegistryManagementClient.yml b/docs-ref-autogen/azure-mgmt-containerregistry/azure.mgmt.containerregistry.aio.ContainerRegistryManagementClient.yml
index 80392143c407..892f345bd038 100644
--- a/docs-ref-autogen/azure-mgmt-containerregistry/azure.mgmt.containerregistry.aio.ContainerRegistryManagementClient.yml
+++ b/docs-ref-autogen/azure-mgmt-containerregistry/azure.mgmt.containerregistry.aio.ContainerRegistryManagementClient.yml
@@ -64,23 +64,23 @@ methods:
signature: async close()
- uid: azure.mgmt.containerregistry.aio.ContainerRegistryManagementClient.models
name: models
- summary: "Module depends on the API version:\n\n* 2017-03-01: <xref:azure.mgmt.containerregistry.v2017_03_01.models>\
- \ \n\n* 2017-10-01: <xref:azure.mgmt.containerregistry.v2017_10_01.models> \n\n\
- * 2018-02-01-preview: <xref:azure.mgmt.containerregistry.v2018_02_01_preview.models>\
- \ \n\n* 2018-09-01: <xref:azure.mgmt.containerregistry.v2018_09_01.models> \n\n\
- * 2019-04-01: <xref:azure.mgmt.containerregistry.v2019_04_01.models> \n\n* 2019-05-01:\
- \ <xref:azure.mgmt.containerregistry.v2019_05_01.models> \n\n* 2019-05-01-preview:\
- \ <xref:azure.mgmt.containerregistry.v2019_05_01_preview.models> \n\n* 2019-06-01-preview:\
- \ <xref:azure.mgmt.containerregistry.v2019_06_01_preview.models> \n\n* 2019-12-01-preview:\
- \ <xref:azure.mgmt.containerregistry.v2019_12_01_preview.models> \n\n* 2020-11-01-preview:\
- \ <xref:azure.mgmt.containerregistry.v2020_11_01_preview.models> \n\n* 2021-06-01-preview:\
- \ <xref:azure.mgmt.containerregistry.v2021_06_01_preview.models> \n\n* 2021-08-01-preview:\
- \ <xref:azure.mgmt.containerregistry.v2021_08_01_preview.models> \n\n* 2021-09-01:\
- \ <xref:azure.mgmt.containerregistry.v2021_09_01.models> \n\n* 2021-12-01-preview:\
- \ <xref:azure.mgmt.containerregistry.v2021_12_01_preview.models> \n\n* 2022-02-01-preview:\
- \ <xref:azure.mgmt.containerregistry.v2022_02_01_preview.models> \n\n* 2022-12-01:\
- \ <xref:azure.mgmt.containerregistry.v2022_12_01.models> \n\n* 2023-01-01-preview:\
- \ <xref:azure.mgmt.containerregistry.v2023_01_01_preview.models>"
+ summary: "Module depends on the API version:\n\n* 2017-03-01: <xref:azure.mgmt.containerregistry.v2017_03_01.models#module-azure.mgmt.containerregistry.v2017_03_01.models>\
+ \ \n\n* 2017-10-01: <xref:azure.mgmt.containerregistry.v2017_10_01.models#module-azure.mgmt.containerregistry.v2017_10_01.models>\
+ \ \n\n* 2018-02-01-preview: <xref:azure.mgmt.containerregistry.v2018_02_01_preview.models#module-azure.mgmt.containerregistry.v2018_02_01_preview.models>\
+ \ \n\n* 2018-09-01: <xref:azure.mgmt.containerregistry.v2018_09_01.models#module-azure.mgmt.containerregistry.v2018_09_01.models>\
+ \ \n\n* 2019-04-01: <xref:azure.mgmt.containerregistry.v2019_04_01.models#module-azure.mgmt.containerregistry.v2019_04_01.models>\
+ \ \n\n* 2019-05-01: <xref:azure.mgmt.containerregistry.v2019_05_01.models#module-azure.mgmt.containerregistry.v2019_05_01.models>\
+ \ \n\n* 2019-05-01-preview: <xref:azure.mgmt.containerregistry.v2019_05_01_preview.models#module-azure.mgmt.containerregistry.v2019_05_01_preview.models>\
+ \ \n\n* 2019-06-01-preview: <xref:azure.mgmt.containerregistry.v2019_06_01_preview.models#module-azure.mgmt.containerregistry.v2019_06_01_preview.models>\
+ \ \n\n* 2019-12-01-preview: <xref:azure.mgmt.containerregistry.v2019_12_01_preview.models#module-azure.mgmt.containerregistry.v2019_12_01_preview.models>\
+ \ \n\n* 2020-11-01-preview: <xref:azure.mgmt.containerregistry.v2020_11_01_preview.models#module-azure.mgmt.containerregistry.v2020_11_01_preview.models>\
+ \ \n\n* 2021-06-01-preview: <xref:azure.mgmt.containerregistry.v2021_06_01_preview.models#module-azure.mgmt.containerregistry.v2021_06_01_preview.models>\
+ \ \n\n* 2021-08-01-preview: <xref:azure.mgmt.containerregistry.v2021_08_01_preview.models#module-azure.mgmt.containerregistry.v2021_08_01_preview.models>\
+ \ \n\n* 2021-09-01: <xref:azure.mgmt.containerregistry.v2021_09_01.models#module-azure.mgmt.containerregistry.v2021_09_01.models>\
+ \ \n\n* 2021-12-01-preview: <xref:azure.mgmt.containerregistry.v2021_12_01_preview.models#module-azure.mgmt.containerregistry.v2021_12_01_preview.models>\
+ \ \n\n* 2022-02-01-preview: <xref:azure.mgmt.containerregistry.v2022_02_01_preview.models#module-azure.mgmt.containerregistry.v2022_02_01_preview.models>\
+ \ \n\n* 2022-12-01: <xref:azure.mgmt.containerregistry.v2022_12_01.models#module-azure.mgmt.containerregistry.v2022_12_01.models>\
+ \ \n\n* 2023-01-01-preview: <xref:azure.mgmt.containerregistry.v2023_01_01_preview.models#module-azure.mgmt.containerregistry.v2023_01_01_preview.models>"
signature: models(api_version='2022-12-01')
parameters:
- name: api_version
diff --git a/docs-ref-autogen/azure-mgmt-containerregistry/azure.mgmt.containerregistry.yml b/docs-ref-autogen/azure-mgmt-containerregistry/azure.mgmt.containerregistry.yml
index 4c1a828fc762..e872f07eb9f7 100644
--- a/docs-ref-autogen/azure-mgmt-containerregistry/azure.mgmt.containerregistry.yml
+++ b/docs-ref-autogen/azure-mgmt-containerregistry/azure.mgmt.containerregistry.yml
@@ -5,8 +5,6 @@ fullName: azure.mgmt.containerregistry
type: import
classes:
- azure.mgmt.containerregistry.ContainerRegistryManagementClient
-modules:
-- azure.mgmt.containerregistry.models
packages:
- azure.mgmt.containerregistry.aio
- azure.mgmt.containerregistry.v2017_03_01
@@ -26,3 +24,5 @@ packages:
- azure.mgmt.containerregistry.v2022_02_01_preview
- azure.mgmt.containerregistry.v2022_12_01
- azure.mgmt.containerregistry.v2023_01_01_preview
+modules:
+- azure.mgmt.containerregistry.models
diff --git a/docs-ref-autogen/azure-mgmt-containerservice/azure.mgmt.containerservice.ContainerServiceClient.yml b/docs-ref-autogen/azure-mgmt-containerservice/azure.mgmt.containerservice.ContainerServiceClient.yml
index 020d2ad791f5..a032b32f9ae3 100644
--- a/docs-ref-autogen/azure-mgmt-containerservice/azure.mgmt.containerservice.ContainerServiceClient.yml
+++ b/docs-ref-autogen/azure-mgmt-containerservice/azure.mgmt.containerservice.ContainerServiceClient.yml
@@ -64,64 +64,69 @@ methods:
signature: close()
- uid: azure.mgmt.containerservice.ContainerServiceClient.models
name: models
- summary: "Module depends on the API version:\n\n* 2017-07-01: <xref:azure.mgmt.containerservice.v2017_07_01.models>\
- \ \n\n* 2018-03-31: <xref:azure.mgmt.containerservice.v2018_03_31.models> \n\n\
- * 2018-08-01-preview: <xref:azure.mgmt.containerservice.v2018_08_01_preview.models>\
- \ \n\n* 2018-09-30-preview: <xref:azure.mgmt.containerservice.v2018_09_30_preview.models>\
- \ \n\n* 2019-02-01: <xref:azure.mgmt.containerservice.v2019_02_01.models> \n\n\
- * 2019-04-01: <xref:azure.mgmt.containerservice.v2019_04_01.models> \n\n* 2019-04-30:\
- \ <xref:azure.mgmt.containerservice.v2019_04_30.models> \n\n* 2019-06-01: <xref:azure.mgmt.containerservice.v2019_06_01.models>\
- \ \n\n* 2019-08-01: <xref:azure.mgmt.containerservice.v2019_08_01.models> \n\n\
- * 2019-09-30-preview: <xref:azure.mgmt.containerservice.v2019_09_30_preview.models>\
- \ \n\n* 2019-10-01: <xref:azure.mgmt.containerservice.v2019_10_01.models> \n\n\
- * 2019-10-27-preview: <xref:azure.mgmt.containerservice.v2019_10_27_preview.models>\
- \ \n\n* 2019-11-01: <xref:azure.mgmt.containerservice.v2019_11_01.models> \n\n\
- * 2020-01-01: <xref:azure.mgmt.containerservice.v2020_01_01.models> \n\n* 2020-02-01:\
- \ <xref:azure.mgmt.containerservice.v2020_02_01.models> \n\n* 2020-03-01: <xref:azure.mgmt.containerservice.v2020_03_01.models>\
- \ \n\n* 2020-04-01: <xref:azure.mgmt.containerservice.v2020_04_01.models> \n\n\
- * 2020-06-01: <xref:azure.mgmt.containerservice.v2020_06_01.models> \n\n* 2020-07-01:\
- \ <xref:azure.mgmt.containerservice.v2020_07_01.models> \n\n* 2020-09-01: <xref:azure.mgmt.containerservice.v2020_09_01.models>\
- \ \n\n* 2020-11-01: <xref:azure.mgmt.containerservice.v2020_11_01.models> \n\n\
- * 2020-12-01: <xref:azure.mgmt.containerservice.v2020_12_01.models> \n\n* 2021-02-01:\
- \ <xref:azure.mgmt.containerservice.v2021_02_01.models> \n\n* 2021-03-01: <xref:azure.mgmt.containerservice.v2021_03_01.models>\
- \ \n\n* 2021-05-01: <xref:azure.mgmt.containerservice.v2021_05_01.models> \n\n\
- * 2021-07-01: <xref:azure.mgmt.containerservice.v2021_07_01.models> \n\n* 2021-08-01:\
- \ <xref:azure.mgmt.containerservice.v2021_08_01.models> \n\n* 2021-09-01: <xref:azure.mgmt.containerservice.v2021_09_01.models>\
- \ \n\n* 2021-10-01: <xref:azure.mgmt.containerservice.v2021_10_01.models> \n\n\
- * 2021-11-01-preview: <xref:azure.mgmt.containerservice.v2021_11_01_preview.models>\
- \ \n\n* 2022-01-01: <xref:azure.mgmt.containerservice.v2022_01_01.models> \n\n\
- * 2022-01-02-preview: <xref:azure.mgmt.containerservice.v2022_01_02_preview.models>\
- \ \n\n* 2022-02-01: <xref:azure.mgmt.containerservice.v2022_02_01.models> \n\n\
- * 2022-02-02-preview: <xref:azure.mgmt.containerservice.v2022_02_02_preview.models>\
- \ \n\n* 2022-03-01: <xref:azure.mgmt.containerservice.v2022_03_01.models> \n\n\
- * 2022-03-02-preview: <xref:azure.mgmt.containerservice.v2022_03_02_preview.models>\
- \ \n\n* 2022-04-01: <xref:azure.mgmt.containerservice.v2022_04_01.models> \n\n\
- * 2022-04-02-preview: <xref:azure.mgmt.containerservice.v2022_04_02_preview.models>\
- \ \n\n* 2022-05-02-preview: <xref:azure.mgmt.containerservice.v2022_05_02_preview.models>\
- \ \n\n* 2022-06-01: <xref:azure.mgmt.containerservice.v2022_06_01.models> \n\n\
- * 2022-06-02-preview: <xref:azure.mgmt.containerservice.v2022_06_02_preview.models>\
- \ \n\n* 2022-07-01: <xref:azure.mgmt.containerservice.v2022_07_01.models> \n\n\
- * 2022-07-02-preview: <xref:azure.mgmt.containerservice.v2022_07_02_preview.models>\
- \ \n\n* 2022-08-02-preview: <xref:azure.mgmt.containerservice.v2022_08_02_preview.models>\
- \ \n\n* 2022-08-03-preview: <xref:azure.mgmt.containerservice.v2022_08_03_preview.models>\
- \ \n\n* 2022-09-01: <xref:azure.mgmt.containerservice.v2022_09_01.models> \n\n\
- * 2022-09-02-preview: <xref:azure.mgmt.containerservice.v2022_09_02_preview.models>\
- \ \n\n* 2022-10-02-preview: <xref:azure.mgmt.containerservice.v2022_10_02_preview.models>\
- \ \n\n* 2022-11-01: <xref:azure.mgmt.containerservice.v2022_11_01.models> \n\n\
- * 2022-11-02-preview: <xref:azure.mgmt.containerservice.v2022_11_02_preview.models>\
- \ \n\n* 2023-01-01: <xref:azure.mgmt.containerservice.v2023_01_01.models> \n\n\
- * 2023-01-02-preview: <xref:azure.mgmt.containerservice.v2023_01_02_preview.models>\
- \ \n\n* 2023-02-01: <xref:azure.mgmt.containerservice.v2023_02_01.models> \n\n\
- * 2023-02-02-preview: <xref:azure.mgmt.containerservice.v2023_02_02_preview.models>\
- \ \n\n* 2023-03-01: <xref:azure.mgmt.containerservice.v2023_03_01.models> \n\n\
- * 2023-03-02-preview: <xref:azure.mgmt.containerservice.v2023_03_02_preview.models>\
- \ \n\n* 2023-04-01: <xref:azure.mgmt.containerservice.v2023_04_01.models> \n\n\
- * 2023-04-02-preview: <xref:azure.mgmt.containerservice.v2023_04_02_preview.models>\
- \ \n\n* 2023-05-01: <xref:azure.mgmt.containerservice.v2023_05_01.models> \n\n\
- * 2023-05-02-preview: <xref:azure.mgmt.containerservice.v2023_05_02_preview.models>\
- \ \n\n* 2023-06-01: <xref:azure.mgmt.containerservice.v2023_06_01.models> \n\n\
- * 2023-06-02-preview: <xref:azure.mgmt.containerservice.v2023_06_02_preview.models>\
- \ \n\n* 2023-07-01: <xref:azure.mgmt.containerservice.v2023_07_01.models>"
+ summary: "Module depends on the API version:\n\n* 2017-07-01: <xref:azure.mgmt.containerservice.v2017_07_01.models#module-azure.mgmt.containerservice.v2017_07_01.models>\
+ \ \n\n* 2018-03-31: <xref:azure.mgmt.containerservice.v2018_03_31.models#module-azure.mgmt.containerservice.v2018_03_31.models>\
+ \ \n\n* 2018-08-01-preview: <xref:azure.mgmt.containerservice.v2018_08_01_preview.models#module-azure.mgmt.containerservice.v2018_08_01_preview.models>\
+ \ \n\n* 2018-09-30-preview: <xref:azure.mgmt.containerservice.v2018_09_30_preview.models#module-azure.mgmt.containerservice.v2018_09_30_preview.models>\
+ \ \n\n* 2019-02-01: <xref:azure.mgmt.containerservice.v2019_02_01.models#module-azure.mgmt.containerservice.v2019_02_01.models>\
+ \ \n\n* 2019-04-01: <xref:azure.mgmt.containerservice.v2019_04_01.models#module-azure.mgmt.containerservice.v2019_04_01.models>\
+ \ \n\n* 2019-04-30: <xref:azure.mgmt.containerservice.v2019_04_30.models#module-azure.mgmt.containerservice.v2019_04_30.models>\
+ \ \n\n* 2019-06-01: <xref:azure.mgmt.containerservice.v2019_06_01.models#module-azure.mgmt.containerservice.v2019_06_01.models>\
+ \ \n\n* 2019-08-01: <xref:azure.mgmt.containerservice.v2019_08_01.models#module-azure.mgmt.containerservice.v2019_08_01.models>\
+ \ \n\n* 2019-09-30-preview: <xref:azure.mgmt.containerservice.v2019_09_30_preview.models#module-azure.mgmt.containerservice.v2019_09_30_preview.models>\
+ \ \n\n* 2019-10-01: <xref:azure.mgmt.containerservice.v2019_10_01.models#module-azure.mgmt.containerservice.v2019_10_01.models>\
+ \ \n\n* 2019-10-27-preview: <xref:azure.mgmt.containerservice.v2019_10_27_preview.models#module-azure.mgmt.containerservice.v2019_10_27_preview.models>\
+ \ \n\n* 2019-11-01: <xref:azure.mgmt.containerservice.v2019_11_01.models#module-azure.mgmt.containerservice.v2019_11_01.models>\
+ \ \n\n* 2020-01-01: <xref:azure.mgmt.containerservice.v2020_01_01.models#module-azure.mgmt.containerservice.v2020_01_01.models>\
+ \ \n\n* 2020-02-01: <xref:azure.mgmt.containerservice.v2020_02_01.models#module-azure.mgmt.containerservice.v2020_02_01.models>\
+ \ \n\n* 2020-03-01: <xref:azure.mgmt.containerservice.v2020_03_01.models#module-azure.mgmt.containerservice.v2020_03_01.models>\
+ \ \n\n* 2020-04-01: <xref:azure.mgmt.containerservice.v2020_04_01.models#module-azure.mgmt.containerservice.v2020_04_01.models>\
+ \ \n\n* 2020-06-01: <xref:azure.mgmt.containerservice.v2020_06_01.models#module-azure.mgmt.containerservice.v2020_06_01.models>\
+ \ \n\n* 2020-07-01: <xref:azure.mgmt.containerservice.v2020_07_01.models#module-azure.mgmt.containerservice.v2020_07_01.models>\
+ \ \n\n* 2020-09-01: <xref:azure.mgmt.containerservice.v2020_09_01.models#module-azure.mgmt.containerservice.v2020_09_01.models>\
+ \ \n\n* 2020-11-01: <xref:azure.mgmt.containerservice.v2020_11_01.models#module-azure.mgmt.containerservice.v2020_11_01.models>\
+ \ \n\n* 2020-12-01: <xref:azure.mgmt.containerservice.v2020_12_01.models#module-azure.mgmt.containerservice.v2020_12_01.models>\
+ \ \n\n* 2021-02-01: <xref:azure.mgmt.containerservice.v2021_02_01.models#module-azure.mgmt.containerservice.v2021_02_01.models>\
+ \ \n\n* 2021-03-01: <xref:azure.mgmt.containerservice.v2021_03_01.models#module-azure.mgmt.containerservice.v2021_03_01.models>\
+ \ \n\n* 2021-05-01: <xref:azure.mgmt.containerservice.v2021_05_01.models#module-azure.mgmt.containerservice.v2021_05_01.models>\
+ \ \n\n* 2021-07-01: <xref:azure.mgmt.containerservice.v2021_07_01.models#module-azure.mgmt.containerservice.v2021_07_01.models>\
+ \ \n\n* 2021-08-01: <xref:azure.mgmt.containerservice.v2021_08_01.models#module-azure.mgmt.containerservice.v2021_08_01.models>\
+ \ \n\n* 2021-09-01: <xref:azure.mgmt.containerservice.v2021_09_01.models#module-azure.mgmt.containerservice.v2021_09_01.models>\
+ \ \n\n* 2021-10-01: <xref:azure.mgmt.containerservice.v2021_10_01.models#module-azure.mgmt.containerservice.v2021_10_01.models>\
+ \ \n\n* 2021-11-01-preview: <xref:azure.mgmt.containerservice.v2021_11_01_preview.models#module-azure.mgmt.containerservice.v2021_11_01_preview.models>\
+ \ \n\n* 2022-01-01: <xref:azure.mgmt.containerservice.v2022_01_01.models#module-azure.mgmt.containerservice.v2022_01_01.models>\
+ \ \n\n* 2022-01-02-preview: <xref:azure.mgmt.containerservice.v2022_01_02_preview.models#module-azure.mgmt.containerservice.v2022_01_02_preview.models>\
+ \ \n\n* 2022-02-01: <xref:azure.mgmt.containerservice.v2022_02_01.models#module-azure.mgmt.containerservice.v2022_02_01.models>\
+ \ \n\n* 2022-02-02-preview: <xref:azure.mgmt.containerservice.v2022_02_02_preview.models#module-azure.mgmt.containerservice.v2022_02_02_preview.models>\
+ \ \n\n* 2022-03-01: <xref:azure.mgmt.containerservice.v2022_03_01.models#module-azure.mgmt.containerservice.v2022_03_01.models>\
+ \ \n\n* 2022-03-02-preview: <xref:azure.mgmt.containerservice.v2022_03_02_preview.models#module-azure.mgmt.containerservice.v2022_03_02_preview.models>\
+ \ \n\n* 2022-04-01: <xref:azure.mgmt.containerservice.v2022_04_01.models#module-azure.mgmt.containerservice.v2022_04_01.models>\
+ \ \n\n* 2022-04-02-preview: <xref:azure.mgmt.containerservice.v2022_04_02_preview.models#module-azure.mgmt.containerservice.v2022_04_02_preview.models>\
+ \ \n\n* 2022-05-02-preview: <xref:azure.mgmt.containerservice.v2022_05_02_preview.models#module-azure.mgmt.containerservice.v2022_05_02_preview.models>\
+ \ \n\n* 2022-06-01: <xref:azure.mgmt.containerservice.v2022_06_01.models#module-azure.mgmt.containerservice.v2022_06_01.models>\
+ \ \n\n* 2022-06-02-preview: <xref:azure.mgmt.containerservice.v2022_06_02_preview.models#module-azure.mgmt.containerservice.v2022_06_02_preview.models>\
+ \ \n\n* 2022-07-01: <xref:azure.mgmt.containerservice.v2022_07_01.models#module-azure.mgmt.containerservice.v2022_07_01.models>\
+ \ \n\n* 2022-07-02-preview: <xref:azure.mgmt.containerservice.v2022_07_02_preview.models#module-azure.mgmt.containerservice.v2022_07_02_preview.models>\
+ \ \n\n* 2022-08-02-preview: <xref:azure.mgmt.containerservice.v2022_08_02_preview.models#module-azure.mgmt.containerservice.v2022_08_02_preview.models>\
+ \ \n\n* 2022-08-03-preview: <xref:azure.mgmt.containerservice.v2022_08_03_preview.models#module-azure.mgmt.containerservice.v2022_08_03_preview.models>\
+ \ \n\n* 2022-09-01: <xref:azure.mgmt.containerservice.v2022_09_01.models#module-azure.mgmt.containerservice.v2022_09_01.models>\
+ \ \n\n* 2022-09-02-preview: <xref:azure.mgmt.containerservice.v2022_09_02_preview.models#module-azure.mgmt.containerservice.v2022_09_02_preview.models>\
+ \ \n\n* 2022-10-02-preview: <xref:azure.mgmt.containerservice.v2022_10_02_preview.models#module-azure.mgmt.containerservice.v2022_10_02_preview.models>\
+ \ \n\n* 2022-11-01: <xref:azure.mgmt.containerservice.v2022_11_01.models#module-azure.mgmt.containerservice.v2022_11_01.models>\
+ \ \n\n* 2022-11-02-preview: <xref:azure.mgmt.containerservice.v2022_11_02_preview.models#module-azure.mgmt.containerservice.v2022_11_02_preview.models>\
+ \ \n\n* 2023-01-01: <xref:azure.mgmt.containerservice.v2023_01_01.models#module-azure.mgmt.containerservice.v2023_01_01.models>\
+ \ \n\n* 2023-01-02-preview: <xref:azure.mgmt.containerservice.v2023_01_02_preview.models#module-azure.mgmt.containerservice.v2023_01_02_preview.models>\
+ \ \n\n* 2023-02-01: <xref:azure.mgmt.containerservice.v2023_02_01.models#module-azure.mgmt.containerservice.v2023_02_01.models>\
+ \ \n\n* 2023-02-02-preview: <xref:azure.mgmt.containerservice.v2023_02_02_preview.models#module-azure.mgmt.containerservice.v2023_02_02_preview.models>\
+ \ \n\n* 2023-03-01: <xref:azure.mgmt.containerservice.v2023_03_01.models#module-azure.mgmt.containerservice.v2023_03_01.models>\
+ \ \n\n* 2023-03-02-preview: <xref:azure.mgmt.containerservice.v2023_03_02_preview.models#module-azure.mgmt.containerservice.v2023_03_02_preview.models>\
+ \ \n\n* 2023-04-01: <xref:azure.mgmt.containerservice.v2023_04_01.models#module-azure.mgmt.containerservice.v2023_04_01.models>\
+ \ \n\n* 2023-04-02-preview: <xref:azure.mgmt.containerservice.v2023_04_02_preview.models#module-azure.mgmt.containerservice.v2023_04_02_preview.models>\
+ \ \n\n* 2023-05-01: <xref:azure.mgmt.containerservice.v2023_05_01.models#module-azure.mgmt.containerservice.v2023_05_01.models>\
+ \ \n\n* 2023-05-02-preview: <xref:azure.mgmt.containerservice.v2023_05_02_preview.models#module-azure.mgmt.containerservice.v2023_05_02_preview.models>\
+ \ \n\n* 2023-06-01: <xref:azure.mgmt.containerservice.v2023_06_01.models#module-azure.mgmt.containerservice.v2023_06_01.models>\
+ \ \n\n* 2023-06-02-preview: <xref:azure.mgmt.containerservice.v2023_06_02_preview.models#module-azure.mgmt.containerservice.v2023_06_02_preview.models>\
+ \ \n\n* 2023-07-01: <xref:azure.mgmt.containerservice.v2023_07_01.models#module-azure.mgmt.containerservice.v2023_07_01.models>"
signature: models(api_version='2023-07-01')
parameters:
- name: api_version
diff --git a/docs-ref-autogen/azure-mgmt-containerservice/azure.mgmt.containerservice.aio.ContainerServiceClient.yml b/docs-ref-autogen/azure-mgmt-containerservice/azure.mgmt.containerservice.aio.ContainerServiceClient.yml
index 8661d20b6646..0df0c145a4ed 100644
--- a/docs-ref-autogen/azure-mgmt-containerservice/azure.mgmt.containerservice.aio.ContainerServiceClient.yml
+++ b/docs-ref-autogen/azure-mgmt-containerservice/azure.mgmt.containerservice.aio.ContainerServiceClient.yml
@@ -64,64 +64,69 @@ methods:
signature: async close()
- uid: azure.mgmt.containerservice.aio.ContainerServiceClient.models
name: models
- summary: "Module depends on the API version:\n\n* 2017-07-01: <xref:azure.mgmt.containerservice.v2017_07_01.models>\
- \ \n\n* 2018-03-31: <xref:azure.mgmt.containerservice.v2018_03_31.models> \n\n\
- * 2018-08-01-preview: <xref:azure.mgmt.containerservice.v2018_08_01_preview.models>\
- \ \n\n* 2018-09-30-preview: <xref:azure.mgmt.containerservice.v2018_09_30_preview.models>\
- \ \n\n* 2019-02-01: <xref:azure.mgmt.containerservice.v2019_02_01.models> \n\n\
- * 2019-04-01: <xref:azure.mgmt.containerservice.v2019_04_01.models> \n\n* 2019-04-30:\
- \ <xref:azure.mgmt.containerservice.v2019_04_30.models> \n\n* 2019-06-01: <xref:azure.mgmt.containerservice.v2019_06_01.models>\
- \ \n\n* 2019-08-01: <xref:azure.mgmt.containerservice.v2019_08_01.models> \n\n\
- * 2019-09-30-preview: <xref:azure.mgmt.containerservice.v2019_09_30_preview.models>\
- \ \n\n* 2019-10-01: <xref:azure.mgmt.containerservice.v2019_10_01.models> \n\n\
- * 2019-10-27-preview: <xref:azure.mgmt.containerservice.v2019_10_27_preview.models>\
- \ \n\n* 2019-11-01: <xref:azure.mgmt.containerservice.v2019_11_01.models> \n\n\
- * 2020-01-01: <xref:azure.mgmt.containerservice.v2020_01_01.models> \n\n* 2020-02-01:\
- \ <xref:azure.mgmt.containerservice.v2020_02_01.models> \n\n* 2020-03-01: <xref:azure.mgmt.containerservice.v2020_03_01.models>\
- \ \n\n* 2020-04-01: <xref:azure.mgmt.containerservice.v2020_04_01.models> \n\n\
- * 2020-06-01: <xref:azure.mgmt.containerservice.v2020_06_01.models> \n\n* 2020-07-01:\
- \ <xref:azure.mgmt.containerservice.v2020_07_01.models> \n\n* 2020-09-01: <xref:azure.mgmt.containerservice.v2020_09_01.models>\
- \ \n\n* 2020-11-01: <xref:azure.mgmt.containerservice.v2020_11_01.models> \n\n\
- * 2020-12-01: <xref:azure.mgmt.containerservice.v2020_12_01.models> \n\n* 2021-02-01:\
- \ <xref:azure.mgmt.containerservice.v2021_02_01.models> \n\n* 2021-03-01: <xref:azure.mgmt.containerservice.v2021_03_01.models>\
- \ \n\n* 2021-05-01: <xref:azure.mgmt.containerservice.v2021_05_01.models> \n\n\
- * 2021-07-01: <xref:azure.mgmt.containerservice.v2021_07_01.models> \n\n* 2021-08-01:\
- \ <xref:azure.mgmt.containerservice.v2021_08_01.models> \n\n* 2021-09-01: <xref:azure.mgmt.containerservice.v2021_09_01.models>\
- \ \n\n* 2021-10-01: <xref:azure.mgmt.containerservice.v2021_10_01.models> \n\n\
- * 2021-11-01-preview: <xref:azure.mgmt.containerservice.v2021_11_01_preview.models>\
- \ \n\n* 2022-01-01: <xref:azure.mgmt.containerservice.v2022_01_01.models> \n\n\
- * 2022-01-02-preview: <xref:azure.mgmt.containerservice.v2022_01_02_preview.models>\
- \ \n\n* 2022-02-01: <xref:azure.mgmt.containerservice.v2022_02_01.models> \n\n\
- * 2022-02-02-preview: <xref:azure.mgmt.containerservice.v2022_02_02_preview.models>\
- \ \n\n* 2022-03-01: <xref:azure.mgmt.containerservice.v2022_03_01.models> \n\n\
- * 2022-03-02-preview: <xref:azure.mgmt.containerservice.v2022_03_02_preview.models>\
- \ \n\n* 2022-04-01: <xref:azure.mgmt.containerservice.v2022_04_01.models> \n\n\
- * 2022-04-02-preview: <xref:azure.mgmt.containerservice.v2022_04_02_preview.models>\
- \ \n\n* 2022-05-02-preview: <xref:azure.mgmt.containerservice.v2022_05_02_preview.models>\
- \ \n\n* 2022-06-01: <xref:azure.mgmt.containerservice.v2022_06_01.models> \n\n\
- * 2022-06-02-preview: <xref:azure.mgmt.containerservice.v2022_06_02_preview.models>\
- \ \n\n* 2022-07-01: <xref:azure.mgmt.containerservice.v2022_07_01.models> \n\n\
- * 2022-07-02-preview: <xref:azure.mgmt.containerservice.v2022_07_02_preview.models>\
- \ \n\n* 2022-08-02-preview: <xref:azure.mgmt.containerservice.v2022_08_02_preview.models>\
- \ \n\n* 2022-08-03-preview: <xref:azure.mgmt.containerservice.v2022_08_03_preview.models>\
- \ \n\n* 2022-09-01: <xref:azure.mgmt.containerservice.v2022_09_01.models> \n\n\
- * 2022-09-02-preview: <xref:azure.mgmt.containerservice.v2022_09_02_preview.models>\
- \ \n\n* 2022-10-02-preview: <xref:azure.mgmt.containerservice.v2022_10_02_preview.models>\
- \ \n\n* 2022-11-01: <xref:azure.mgmt.containerservice.v2022_11_01.models> \n\n\
- * 2022-11-02-preview: <xref:azure.mgmt.containerservice.v2022_11_02_preview.models>\
- \ \n\n* 2023-01-01: <xref:azure.mgmt.containerservice.v2023_01_01.models> \n\n\
- * 2023-01-02-preview: <xref:azure.mgmt.containerservice.v2023_01_02_preview.models>\
- \ \n\n* 2023-02-01: <xref:azure.mgmt.containerservice.v2023_02_01.models> \n\n\
- * 2023-02-02-preview: <xref:azure.mgmt.containerservice.v2023_02_02_preview.models>\
- \ \n\n* 2023-03-01: <xref:azure.mgmt.containerservice.v2023_03_01.models> \n\n\
- * 2023-03-02-preview: <xref:azure.mgmt.containerservice.v2023_03_02_preview.models>\
- \ \n\n* 2023-04-01: <xref:azure.mgmt.containerservice.v2023_04_01.models> \n\n\
- * 2023-04-02-preview: <xref:azure.mgmt.containerservice.v2023_04_02_preview.models>\
- \ \n\n* 2023-05-01: <xref:azure.mgmt.containerservice.v2023_05_01.models> \n\n\
- * 2023-05-02-preview: <xref:azure.mgmt.containerservice.v2023_05_02_preview.models>\
- \ \n\n* 2023-06-01: <xref:azure.mgmt.containerservice.v2023_06_01.models> \n\n\
- * 2023-06-02-preview: <xref:azure.mgmt.containerservice.v2023_06_02_preview.models>\
- \ \n\n* 2023-07-01: <xref:azure.mgmt.containerservice.v2023_07_01.models>"
+ summary: "Module depends on the API version:\n\n* 2017-07-01: <xref:azure.mgmt.containerservice.v2017_07_01.models#module-azure.mgmt.containerservice.v2017_07_01.models>\
+ \ \n\n* 2018-03-31: <xref:azure.mgmt.containerservice.v2018_03_31.models#module-azure.mgmt.containerservice.v2018_03_31.models>\
+ \ \n\n* 2018-08-01-preview: <xref:azure.mgmt.containerservice.v2018_08_01_preview.models#module-azure.mgmt.containerservice.v2018_08_01_preview.models>\
+ \ \n\n* 2018-09-30-preview: <xref:azure.mgmt.containerservice.v2018_09_30_preview.models#module-azure.mgmt.containerservice.v2018_09_30_preview.models>\
+ \ \n\n* 2019-02-01: <xref:azure.mgmt.containerservice.v2019_02_01.models#module-azure.mgmt.containerservice.v2019_02_01.models>\
+ \ \n\n* 2019-04-01: <xref:azure.mgmt.containerservice.v2019_04_01.models#module-azure.mgmt.containerservice.v2019_04_01.models>\
+ \ \n\n* 2019-04-30: <xref:azure.mgmt.containerservice.v2019_04_30.models#module-azure.mgmt.containerservice.v2019_04_30.models>\
+ \ \n\n* 2019-06-01: <xref:azure.mgmt.containerservice.v2019_06_01.models#module-azure.mgmt.containerservice.v2019_06_01.models>\
+ \ \n\n* 2019-08-01: <xref:azure.mgmt.containerservice.v2019_08_01.models#module-azure.mgmt.containerservice.v2019_08_01.models>\
+ \ \n\n* 2019-09-30-preview: <xref:azure.mgmt.containerservice.v2019_09_30_preview.models#module-azure.mgmt.containerservice.v2019_09_30_preview.models>\
+ \ \n\n* 2019-10-01: <xref:azure.mgmt.containerservice.v2019_10_01.models#module-azure.mgmt.containerservice.v2019_10_01.models>\
+ \ \n\n* 2019-10-27-preview: <xref:azure.mgmt.containerservice.v2019_10_27_preview.models#module-azure.mgmt.containerservice.v2019_10_27_preview.models>\
+ \ \n\n* 2019-11-01: <xref:azure.mgmt.containerservice.v2019_11_01.models#module-azure.mgmt.containerservice.v2019_11_01.models>\
+ \ \n\n* 2020-01-01: <xref:azure.mgmt.containerservice.v2020_01_01.models#module-azure.mgmt.containerservice.v2020_01_01.models>\
+ \ \n\n* 2020-02-01: <xref:azure.mgmt.containerservice.v2020_02_01.models#module-azure.mgmt.containerservice.v2020_02_01.models>\
+ \ \n\n* 2020-03-01: <xref:azure.mgmt.containerservice.v2020_03_01.models#module-azure.mgmt.containerservice.v2020_03_01.models>\
+ \ \n\n* 2020-04-01: <xref:azure.mgmt.containerservice.v2020_04_01.models#module-azure.mgmt.containerservice.v2020_04_01.models>\
+ \ \n\n* 2020-06-01: <xref:azure.mgmt.containerservice.v2020_06_01.models#module-azure.mgmt.containerservice.v2020_06_01.models>\
+ \ \n\n* 2020-07-01: <xref:azure.mgmt.containerservice.v2020_07_01.models#module-azure.mgmt.containerservice.v2020_07_01.models>\
+ \ \n\n* 2020-09-01: <xref:azure.mgmt.containerservice.v2020_09_01.models#module-azure.mgmt.containerservice.v2020_09_01.models>\
+ \ \n\n* 2020-11-01: <xref:azure.mgmt.containerservice.v2020_11_01.models#module-azure.mgmt.containerservice.v2020_11_01.models>\
+ \ \n\n* 2020-12-01: <xref:azure.mgmt.containerservice.v2020_12_01.models#module-azure.mgmt.containerservice.v2020_12_01.models>\
+ \ \n\n* 2021-02-01: <xref:azure.mgmt.containerservice.v2021_02_01.models#module-azure.mgmt.containerservice.v2021_02_01.models>\
+ \ \n\n* 2021-03-01: <xref:azure.mgmt.containerservice.v2021_03_01.models#module-azure.mgmt.containerservice.v2021_03_01.models>\
+ \ \n\n* 2021-05-01: <xref:azure.mgmt.containerservice.v2021_05_01.models#module-azure.mgmt.containerservice.v2021_05_01.models>\
+ \ \n\n* 2021-07-01: <xref:azure.mgmt.containerservice.v2021_07_01.models#module-azure.mgmt.containerservice.v2021_07_01.models>\
+ \ \n\n* 2021-08-01: <xref:azure.mgmt.containerservice.v2021_08_01.models#module-azure.mgmt.containerservice.v2021_08_01.models>\
+ \ \n\n* 2021-09-01: <xref:azure.mgmt.containerservice.v2021_09_01.models#module-azure.mgmt.containerservice.v2021_09_01.models>\
+ \ \n\n* 2021-10-01: <xref:azure.mgmt.containerservice.v2021_10_01.models#module-azure.mgmt.containerservice.v2021_10_01.models>\
+ \ \n\n* 2021-11-01-preview: <xref:azure.mgmt.containerservice.v2021_11_01_preview.models#module-azure.mgmt.containerservice.v2021_11_01_preview.models>\
+ \ \n\n* 2022-01-01: <xref:azure.mgmt.containerservice.v2022_01_01.models#module-azure.mgmt.containerservice.v2022_01_01.models>\
+ \ \n\n* 2022-01-02-preview: <xref:azure.mgmt.containerservice.v2022_01_02_preview.models#module-azure.mgmt.containerservice.v2022_01_02_preview.models>\
+ \ \n\n* 2022-02-01: <xref:azure.mgmt.containerservice.v2022_02_01.models#module-azure.mgmt.containerservice.v2022_02_01.models>\
+ \ \n\n* 2022-02-02-preview: <xref:azure.mgmt.containerservice.v2022_02_02_preview.models#module-azure.mgmt.containerservice.v2022_02_02_preview.models>\
+ \ \n\n* 2022-03-01: <xref:azure.mgmt.containerservice.v2022_03_01.models#module-azure.mgmt.containerservice.v2022_03_01.models>\
+ \ \n\n* 2022-03-02-preview: <xref:azure.mgmt.containerservice.v2022_03_02_preview.models#module-azure.mgmt.containerservice.v2022_03_02_preview.models>\
+ \ \n\n* 2022-04-01: <xref:azure.mgmt.containerservice.v2022_04_01.models#module-azure.mgmt.containerservice.v2022_04_01.models>\
+ \ \n\n* 2022-04-02-preview: <xref:azure.mgmt.containerservice.v2022_04_02_preview.models#module-azure.mgmt.containerservice.v2022_04_02_preview.models>\
+ \ \n\n* 2022-05-02-preview: <xref:azure.mgmt.containerservice.v2022_05_02_preview.models#module-azure.mgmt.containerservice.v2022_05_02_preview.models>\
+ \ \n\n* 2022-06-01: <xref:azure.mgmt.containerservice.v2022_06_01.models#module-azure.mgmt.containerservice.v2022_06_01.models>\
+ \ \n\n* 2022-06-02-preview: <xref:azure.mgmt.containerservice.v2022_06_02_preview.models#module-azure.mgmt.containerservice.v2022_06_02_preview.models>\
+ \ \n\n* 2022-07-01: <xref:azure.mgmt.containerservice.v2022_07_01.models#module-azure.mgmt.containerservice.v2022_07_01.models>\
+ \ \n\n* 2022-07-02-preview: <xref:azure.mgmt.containerservice.v2022_07_02_preview.models#module-azure.mgmt.containerservice.v2022_07_02_preview.models>\
+ \ \n\n* 2022-08-02-preview: <xref:azure.mgmt.containerservice.v2022_08_02_preview.models#module-azure.mgmt.containerservice.v2022_08_02_preview.models>\
+ \ \n\n* 2022-08-03-preview: <xref:azure.mgmt.containerservice.v2022_08_03_preview.models#module-azure.mgmt.containerservice.v2022_08_03_preview.models>\
+ \ \n\n* 2022-09-01: <xref:azure.mgmt.containerservice.v2022_09_01.models#module-azure.mgmt.containerservice.v2022_09_01.models>\
+ \ \n\n* 2022-09-02-preview: <xref:azure.mgmt.containerservice.v2022_09_02_preview.models#module-azure.mgmt.containerservice.v2022_09_02_preview.models>\
+ \ \n\n* 2022-10-02-preview: <xref:azure.mgmt.containerservice.v2022_10_02_preview.models#module-azure.mgmt.containerservice.v2022_10_02_preview.models>\
+ \ \n\n* 2022-11-01: <xref:azure.mgmt.containerservice.v2022_11_01.models#module-azure.mgmt.containerservice.v2022_11_01.models>\
+ \ \n\n* 2022-11-02-preview: <xref:azure.mgmt.containerservice.v2022_11_02_preview.models#module-azure.mgmt.containerservice.v2022_11_02_preview.models>\
+ \ \n\n* 2023-01-01: <xref:azure.mgmt.containerservice.v2023_01_01.models#module-azure.mgmt.containerservice.v2023_01_01.models>\
+ \ \n\n* 2023-01-02-preview: <xref:azure.mgmt.containerservice.v2023_01_02_preview.models#module-azure.mgmt.containerservice.v2023_01_02_preview.models>\
+ \ \n\n* 2023-02-01: <xref:azure.mgmt.containerservice.v2023_02_01.models#module-azure.mgmt.containerservice.v2023_02_01.models>\
+ \ \n\n* 2023-02-02-preview: <xref:azure.mgmt.containerservice.v2023_02_02_preview.models#module-azure.mgmt.containerservice.v2023_02_02_preview.models>\
+ \ \n\n* 2023-03-01: <xref:azure.mgmt.containerservice.v2023_03_01.models#module-azure.mgmt.containerservice.v2023_03_01.models>\
+ \ \n\n* 2023-03-02-preview: <xref:azure.mgmt.containerservice.v2023_03_02_preview.models#module-azure.mgmt.containerservice.v2023_03_02_preview.models>\
+ \ \n\n* 2023-04-01: <xref:azure.mgmt.containerservice.v2023_04_01.models#module-azure.mgmt.containerservice.v2023_04_01.models>\
+ \ \n\n* 2023-04-02-preview: <xref:azure.mgmt.containerservice.v2023_04_02_preview.models#module-azure.mgmt.containerservice.v2023_04_02_preview.models>\
+ \ \n\n* 2023-05-01: <xref:azure.mgmt.containerservice.v2023_05_01.models#module-azure.mgmt.containerservice.v2023_05_01.models>\
+ \ \n\n* 2023-05-02-preview: <xref:azure.mgmt.containerservice.v2023_05_02_preview.models#module-azure.mgmt.containerservice.v2023_05_02_preview.models>\
+ \ \n\n* 2023-06-01: <xref:azure.mgmt.containerservice.v2023_06_01.models#module-azure.mgmt.containerservice.v2023_06_01.models>\
+ \ \n\n* 2023-06-02-preview: <xref:azure.mgmt.containerservice.v2023_06_02_preview.models#module-azure.mgmt.containerservice.v2023_06_02_preview.models>\
+ \ \n\n* 2023-07-01: <xref:azure.mgmt.containerservice.v2023_07_01.models#module-azure.mgmt.containerservice.v2023_07_01.models>"
signature: models(api_version='2023-07-01')
parameters:
- name: api_version
diff --git a/docs-ref-autogen/azure-mgmt-containerservice/azure.mgmt.containerservice.yml b/docs-ref-autogen/azure-mgmt-containerservice/azure.mgmt.containerservice.yml
index 7a3c249ed775..0c6a8ab95aa1 100644
--- a/docs-ref-autogen/azure-mgmt-containerservice/azure.mgmt.containerservice.yml
+++ b/docs-ref-autogen/azure-mgmt-containerservice/azure.mgmt.containerservice.yml
@@ -5,8 +5,6 @@ fullName: azure.mgmt.containerservice
type: import
classes:
- azure.mgmt.containerservice.ContainerServiceClient
-modules:
-- azure.mgmt.containerservice.models
packages:
- azure.mgmt.containerservice.aio
- azure.mgmt.containerservice.v2017_07_01
@@ -72,3 +70,5 @@ packages:
- azure.mgmt.containerservice.v2023_06_01
- azure.mgmt.containerservice.v2023_06_02_preview
- azure.mgmt.containerservice.v2023_07_01
+modules:
+- azure.mgmt.containerservice.models
diff --git a/docs-ref-autogen/azure-mgmt-storage/azure.mgmt.storage.StorageManagementClient.yml b/docs-ref-autogen/azure-mgmt-storage/azure.mgmt.storage.StorageManagementClient.yml
index 868acf4f3016..cce95c4b973d 100644
--- a/docs-ref-autogen/azure-mgmt-storage/azure.mgmt.storage.StorageManagementClient.yml
+++ b/docs-ref-autogen/azure-mgmt-storage/azure.mgmt.storage.StorageManagementClient.yml
@@ -64,21 +64,27 @@ methods:
signature: close()
- uid: azure.mgmt.storage.StorageManagementClient.models
name: models
- summary: "Module depends on the API version:\n\n* 2015-06-15: <xref:azure.mgmt.storage.v2015_06_15.models>\
- \ \n\n* 2016-01-01: <xref:azure.mgmt.storage.v2016_01_01.models> \n\n* 2016-12-01:\
- \ <xref:azure.mgmt.storage.v2016_12_01.models> \n\n* 2017-06-01: <xref:azure.mgmt.storage.v2017_06_01.models>\
- \ \n\n* 2017-10-01: <xref:azure.mgmt.storage.v2017_10_01.models> \n\n* 2018-02-01:\
- \ <xref:azure.mgmt.storage.v2018_02_01.models> \n\n* 2018-03-01-preview: <xref:azure.mgmt.storage.v2018_03_01_preview.models>\
- \ \n\n* 2018-07-01: <xref:azure.mgmt.storage.v2018_07_01.models> \n\n* 2018-11-01:\
- \ <xref:azure.mgmt.storage.v2018_11_01.models> \n\n* 2019-04-01: <xref:azure.mgmt.storage.v2019_04_01.models>\
- \ \n\n* 2019-06-01: <xref:azure.mgmt.storage.v2019_06_01.models> \n\n* 2020-08-01-preview:\
- \ <xref:azure.mgmt.storage.v2020_08_01_preview.models> \n\n* 2021-01-01: <xref:azure.mgmt.storage.v2021_01_01.models>\
- \ \n\n* 2021-02-01: <xref:azure.mgmt.storage.v2021_02_01.models> \n\n* 2021-04-01:\
- \ <xref:azure.mgmt.storage.v2021_04_01.models> \n\n* 2021-06-01: <xref:azure.mgmt.storage.v2021_06_01.models>\
- \ \n\n* 2021-08-01: <xref:azure.mgmt.storage.v2021_08_01.models> \n\n* 2021-09-01:\
- \ <xref:azure.mgmt.storage.v2021_09_01.models> \n\n* 2022-05-01: <xref:azure.mgmt.storage.v2022_05_01.models>\
- \ \n\n* 2022-09-01: <xref:azure.mgmt.storage.v2022_09_01.models> \n\n* 2023-01-01:\
- \ <xref:azure.mgmt.storage.v2023_01_01.models>"
+ summary: "Module depends on the API version:\n\n* 2015-06-15: <xref:azure.mgmt.storage.v2015_06_15.models#module-azure.mgmt.storage.v2015_06_15.models>\
+ \ \n\n* 2016-01-01: <xref:azure.mgmt.storage.v2016_01_01.models#module-azure.mgmt.storage.v2016_01_01.models>\
+ \ \n\n* 2016-12-01: <xref:azure.mgmt.storage.v2016_12_01.models#module-azure.mgmt.storage.v2016_12_01.models>\
+ \ \n\n* 2017-06-01: <xref:azure.mgmt.storage.v2017_06_01.models#module-azure.mgmt.storage.v2017_06_01.models>\
+ \ \n\n* 2017-10-01: <xref:azure.mgmt.storage.v2017_10_01.models#module-azure.mgmt.storage.v2017_10_01.models>\
+ \ \n\n* 2018-02-01: <xref:azure.mgmt.storage.v2018_02_01.models#module-azure.mgmt.storage.v2018_02_01.models>\
+ \ \n\n* 2018-03-01-preview: <xref:azure.mgmt.storage.v2018_03_01_preview.models#module-azure.mgmt.storage.v2018_03_01_preview.models>\
+ \ \n\n* 2018-07-01: <xref:azure.mgmt.storage.v2018_07_01.models#module-azure.mgmt.storage.v2018_07_01.models>\
+ \ \n\n* 2018-11-01: <xref:azure.mgmt.storage.v2018_11_01.models#module-azure.mgmt.storage.v2018_11_01.models>\
+ \ \n\n* 2019-04-01: <xref:azure.mgmt.storage.v2019_04_01.models#module-azure.mgmt.storage.v2019_04_01.models>\
+ \ \n\n* 2019-06-01: <xref:azure.mgmt.storage.v2019_06_01.models#module-azure.mgmt.storage.v2019_06_01.models>\
+ \ \n\n* 2020-08-01-preview: <xref:azure.mgmt.storage.v2020_08_01_preview.models#module-azure.mgmt.storage.v2020_08_01_preview.models>\
+ \ \n\n* 2021-01-01: <xref:azure.mgmt.storage.v2021_01_01.models#module-azure.mgmt.storage.v2021_01_01.models>\
+ \ \n\n* 2021-02-01: <xref:azure.mgmt.storage.v2021_02_01.models#module-azure.mgmt.storage.v2021_02_01.models>\
+ \ \n\n* 2021-04-01: <xref:azure.mgmt.storage.v2021_04_01.models#module-azure.mgmt.storage.v2021_04_01.models>\
+ \ \n\n* 2021-06-01: <xref:azure.mgmt.storage.v2021_06_01.models#module-azure.mgmt.storage.v2021_06_01.models>\
+ \ \n\n* 2021-08-01: <xref:azure.mgmt.storage.v2021_08_01.models#module-azure.mgmt.storage.v2021_08_01.models>\
+ \ \n\n* 2021-09-01: <xref:azure.mgmt.storage.v2021_09_01.models#module-azure.mgmt.storage.v2021_09_01.models>\
+ \ \n\n* 2022-05-01: <xref:azure.mgmt.storage.v2022_05_01.models#module-azure.mgmt.storage.v2022_05_01.models>\
+ \ \n\n* 2022-09-01: <xref:azure.mgmt.storage.v2022_09_01.models#module-azure.mgmt.storage.v2022_09_01.models>\
+ \ \n\n* 2023-01-01: <xref:azure.mgmt.storage.v2023_01_01.models#module-azure.mgmt.storage.v2023_01_01.models>"
signature: models(api_version='2023-01-01')
parameters:
- name: api_version
diff --git a/docs-ref-autogen/azure-mgmt-storage/azure.mgmt.storage.aio.StorageManagementClient.yml b/docs-ref-autogen/azure-mgmt-storage/azure.mgmt.storage.aio.StorageManagementClient.yml
index 0a73d75d04ef..83facc0f83e3 100644
--- a/docs-ref-autogen/azure-mgmt-storage/azure.mgmt.storage.aio.StorageManagementClient.yml
+++ b/docs-ref-autogen/azure-mgmt-storage/azure.mgmt.storage.aio.StorageManagementClient.yml
@@ -64,21 +64,27 @@ methods:
signature: async close()
- uid: azure.mgmt.storage.aio.StorageManagementClient.models
name: models
- summary: "Module depends on the API version:\n\n* 2015-06-15: <xref:azure.mgmt.storage.v2015_06_15.models>\
- \ \n\n* 2016-01-01: <xref:azure.mgmt.storage.v2016_01_01.models> \n\n* 2016-12-01:\
- \ <xref:azure.mgmt.storage.v2016_12_01.models> \n\n* 2017-06-01: <xref:azure.mgmt.storage.v2017_06_01.models>\
- \ \n\n* 2017-10-01: <xref:azure.mgmt.storage.v2017_10_01.models> \n\n* 2018-02-01:\
- \ <xref:azure.mgmt.storage.v2018_02_01.models> \n\n* 2018-03-01-preview: <xref:azure.mgmt.storage.v2018_03_01_preview.models>\
- \ \n\n* 2018-07-01: <xref:azure.mgmt.storage.v2018_07_01.models> \n\n* 2018-11-01:\
- \ <xref:azure.mgmt.storage.v2018_11_01.models> \n\n* 2019-04-01: <xref:azure.mgmt.storage.v2019_04_01.models>\
- \ \n\n* 2019-06-01: <xref:azure.mgmt.storage.v2019_06_01.models> \n\n* 2020-08-01-preview:\
- \ <xref:azure.mgmt.storage.v2020_08_01_preview.models> \n\n* 2021-01-01: <xref:azure.mgmt.storage.v2021_01_01.models>\
- \ \n\n* 2021-02-01: <xref:azure.mgmt.storage.v2021_02_01.models> \n\n* 2021-04-01:\
- \ <xref:azure.mgmt.storage.v2021_04_01.models> \n\n* 2021-06-01: <xref:azure.mgmt.storage.v2021_06_01.models>\
- \ \n\n* 2021-08-01: <xref:azure.mgmt.storage.v2021_08_01.models> \n\n* 2021-09-01:\
- \ <xref:azure.mgmt.storage.v2021_09_01.models> \n\n* 2022-05-01: <xref:azure.mgmt.storage.v2022_05_01.models>\
- \ \n\n* 2022-09-01: <xref:azure.mgmt.storage.v2022_09_01.models> \n\n* 2023-01-01:\
- \ <xref:azure.mgmt.storage.v2023_01_01.models>"
+ summary: "Module depends on the API version:\n\n* 2015-06-15: <xref:azure.mgmt.storage.v2015_06_15.models#module-azure.mgmt.storage.v2015_06_15.models>\
+ \ \n\n* 2016-01-01: <xref:azure.mgmt.storage.v2016_01_01.models#module-azure.mgmt.storage.v2016_01_01.models>\
+ \ \n\n* 2016-12-01: <xref:azure.mgmt.storage.v2016_12_01.models#module-azure.mgmt.storage.v2016_12_01.models>\
+ \ \n\n* 2017-06-01: <xref:azure.mgmt.storage.v2017_06_01.models#module-azure.mgmt.storage.v2017_06_01.models>\
+ \ \n\n* 2017-10-01: <xref:azure.mgmt.storage.v2017_10_01.models#module-azure.mgmt.storage.v2017_10_01.models>\
+ \ \n\n* 2018-02-01: <xref:azure.mgmt.storage.v2018_02_01.models#module-azure.mgmt.storage.v2018_02_01.models>\
+ \ \n\n* 2018-03-01-preview: <xref:azure.mgmt.storage.v2018_03_01_preview.models#module-azure.mgmt.storage.v2018_03_01_preview.models>\
+ \ \n\n* 2018-07-01: <xref:azure.mgmt.storage.v2018_07_01.models#module-azure.mgmt.storage.v2018_07_01.models>\
+ \ \n\n* 2018-11-01: <xref:azure.mgmt.storage.v2018_11_01.models#module-azure.mgmt.storage.v2018_11_01.models>\
+ \ \n\n* 2019-04-01: <xref:azure.mgmt.storage.v2019_04_01.models#module-azure.mgmt.storage.v2019_04_01.models>\
+ \ \n\n* 2019-06-01: <xref:azure.mgmt.storage.v2019_06_01.models#module-azure.mgmt.storage.v2019_06_01.models>\
+ \ \n\n* 2020-08-01-preview: <xref:azure.mgmt.storage.v2020_08_01_preview.models#module-azure.mgmt.storage.v2020_08_01_preview.models>\
+ \ \n\n* 2021-01-01: <xref:azure.mgmt.storage.v2021_01_01.models#module-azure.mgmt.storage.v2021_01_01.models>\
+ \ \n\n* 2021-02-01: <xref:azure.mgmt.storage.v2021_02_01.models#module-azure.mgmt.storage.v2021_02_01.models>\
+ \ \n\n* 2021-04-01: <xref:azure.mgmt.storage.v2021_04_01.models#module-azure.mgmt.storage.v2021_04_01.models>\
+ \ \n\n* 2021-06-01: <xref:azure.mgmt.storage.v2021_06_01.models#module-azure.mgmt.storage.v2021_06_01.models>\
+ \ \n\n* 2021-08-01: <xref:azure.mgmt.storage.v2021_08_01.models#module-azure.mgmt.storage.v2021_08_01.models>\
+ \ \n\n* 2021-09-01: <xref:azure.mgmt.storage.v2021_09_01.models#module-azure.mgmt.storage.v2021_09_01.models>\
+ \ \n\n* 2022-05-01: <xref:azure.mgmt.storage.v2022_05_01.models#module-azure.mgmt.storage.v2022_05_01.models>\
+ \ \n\n* 2022-09-01: <xref:azure.mgmt.storage.v2022_09_01.models#module-azure.mgmt.storage.v2022_09_01.models>\
+ \ \n\n* 2023-01-01: <xref:azure.mgmt.storage.v2023_01_01.models#module-azure.mgmt.storage.v2023_01_01.models>"
signature: models(api_version='2023-01-01')
parameters:
- name: api_version
diff --git a/docs-ref-autogen/azure-mgmt-storage/azure.mgmt.storage.yml b/docs-ref-autogen/azure-mgmt-storage/azure.mgmt.storage.yml
index 6767db34ef79..3cd4dc461d0c 100644
--- a/docs-ref-autogen/azure-mgmt-storage/azure.mgmt.storage.yml
+++ b/docs-ref-autogen/azure-mgmt-storage/azure.mgmt.storage.yml
@@ -5,8 +5,6 @@ fullName: azure.mgmt.storage
type: import
classes:
- azure.mgmt.storage.StorageManagementClient
-modules:
-- azure.mgmt.storage.models
packages:
- azure.mgmt.storage.aio
- azure.mgmt.storage.v2015_06_15
@@ -30,3 +28,5 @@ packages:
- azure.mgmt.storage.v2022_05_01
- azure.mgmt.storage.v2022_09_01
- azure.mgmt.storage.v2023_01_01
+modules:
+- azure.mgmt.storage.models
diff --git a/docs-ref-autogen/azure-mgmt-web/azure.mgmt.web.WebSiteManagementClient.yml b/docs-ref-autogen/azure-mgmt-web/azure.mgmt.web.WebSiteManagementClient.yml
index c6793f9130cc..0c555f46d0cf 100644
--- a/docs-ref-autogen/azure-mgmt-web/azure.mgmt.web.WebSiteManagementClient.yml
+++ b/docs-ref-autogen/azure-mgmt-web/azure.mgmt.web.WebSiteManagementClient.yml
@@ -66,16 +66,20 @@ methods:
signature: close()
- uid: azure.mgmt.web.WebSiteManagementClient.models
name: models
- summary: "Module depends on the API version:\n\n* 2015-04-01: <xref:azure.mgmt.web.v2015_04_01.models>\
- \ \n\n* 2015-08-01: <xref:azure.mgmt.web.v2015_08_01.models> \n\n* 2016-03-01:\
- \ <xref:azure.mgmt.web.v2016_03_01.models> \n\n* 2016-08-01: <xref:azure.mgmt.web.v2016_08_01.models>\
- \ \n\n* 2016-09-01: <xref:azure.mgmt.web.v2016_09_01.models> \n\n* 2018-02-01:\
- \ <xref:azure.mgmt.web.v2018_02_01.models> \n\n* 2018-11-01: <xref:azure.mgmt.web.v2018_11_01.models>\
- \ \n\n* 2019-08-01: <xref:azure.mgmt.web.v2019_08_01.models> \n\n* 2020-06-01:\
- \ <xref:azure.mgmt.web.v2020_06_01.models> \n\n* 2020-09-01: <xref:azure.mgmt.web.v2020_09_01.models>\
- \ \n\n* 2020-12-01: <xref:azure.mgmt.web.v2020_12_01.models> \n\n* 2021-01-01:\
- \ <xref:azure.mgmt.web.v2021_01_01.models> \n\n* 2021-01-15: <xref:azure.mgmt.web.v2021_01_15.models>\
- \ \n\n* 2022-09-01: <xref:azure.mgmt.web.v2022_09_01.models>"
+ summary: "Module depends on the API version:\n\n* 2015-04-01: <xref:azure.mgmt.web.v2015_04_01.models#module-azure.mgmt.web.v2015_04_01.models>\
+ \ \n\n* 2015-08-01: <xref:azure.mgmt.web.v2015_08_01.models#module-azure.mgmt.web.v2015_08_01.models>\
+ \ \n\n* 2016-03-01: <xref:azure.mgmt.web.v2016_03_01.models#module-azure.mgmt.web.v2016_03_01.models>\
+ \ \n\n* 2016-08-01: <xref:azure.mgmt.web.v2016_08_01.models#module-azure.mgmt.web.v2016_08_01.models>\
+ \ \n\n* 2016-09-01: <xref:azure.mgmt.web.v2016_09_01.models#module-azure.mgmt.web.v2016_09_01.models>\
+ \ \n\n* 2018-02-01: <xref:azure.mgmt.web.v2018_02_01.models#module-azure.mgmt.web.v2018_02_01.models>\
+ \ \n\n* 2018-11-01: <xref:azure.mgmt.web.v2018_11_01.models#module-azure.mgmt.web.v2018_11_01.models>\
+ \ \n\n* 2019-08-01: <xref:azure.mgmt.web.v2019_08_01.models#module-azure.mgmt.web.v2019_08_01.models>\
+ \ \n\n* 2020-06-01: <xref:azure.mgmt.web.v2020_06_01.models#module-azure.mgmt.web.v2020_06_01.models>\
+ \ \n\n* 2020-09-01: <xref:azure.mgmt.web.v2020_09_01.models#module-azure.mgmt.web.v2020_09_01.models>\
+ \ \n\n* 2020-12-01: <xref:azure.mgmt.web.v2020_12_01.models#module-azure.mgmt.web.v2020_12_01.models>\
+ \ \n\n* 2021-01-01: <xref:azure.mgmt.web.v2021_01_01.models#module-azure.mgmt.web.v2021_01_01.models>\
+ \ \n\n* 2021-01-15: <xref:azure.mgmt.web.v2021_01_15.models#module-azure.mgmt.web.v2021_01_15.models>\
+ \ \n\n* 2022-09-01: <xref:azure.mgmt.web.v2022_09_01.models#module-azure.mgmt.web.v2022_09_01.models>"
signature: models(api_version='2022-09-01')
parameters:
- name: api_version
diff --git a/docs-ref-autogen/azure-mgmt-web/azure.mgmt.web.aio.WebSiteManagementClient.yml b/docs-ref-autogen/azure-mgmt-web/azure.mgmt.web.aio.WebSiteManagementClient.yml
index b01e8efa8491..7121e979bdbd 100644
--- a/docs-ref-autogen/azure-mgmt-web/azure.mgmt.web.aio.WebSiteManagementClient.yml
+++ b/docs-ref-autogen/azure-mgmt-web/azure.mgmt.web.aio.WebSiteManagementClient.yml
@@ -66,16 +66,20 @@ methods:
signature: async close()
- uid: azure.mgmt.web.aio.WebSiteManagementClient.models
name: models
- summary: "Module depends on the API version:\n\n* 2015-04-01: <xref:azure.mgmt.web.v2015_04_01.models>\
- \ \n\n* 2015-08-01: <xref:azure.mgmt.web.v2015_08_01.models> \n\n* 2016-03-01:\
- \ <xref:azure.mgmt.web.v2016_03_01.models> \n\n* 2016-08-01: <xref:azure.mgmt.web.v2016_08_01.models>\
- \ \n\n* 2016-09-01: <xref:azure.mgmt.web.v2016_09_01.models> \n\n* 2018-02-01:\
- \ <xref:azure.mgmt.web.v2018_02_01.models> \n\n* 2018-11-01: <xref:azure.mgmt.web.v2018_11_01.models>\
- \ \n\n* 2019-08-01: <xref:azure.mgmt.web.v2019_08_01.models> \n\n* 2020-06-01:\
- \ <xref:azure.mgmt.web.v2020_06_01.models> \n\n* 2020-09-01: <xref:azure.mgmt.web.v2020_09_01.models>\
- \ \n\n* 2020-12-01: <xref:azure.mgmt.web.v2020_12_01.models> \n\n* 2021-01-01:\
- \ <xref:azure.mgmt.web.v2021_01_01.models> \n\n* 2021-01-15: <xref:azure.mgmt.web.v2021_01_15.models>\
- \ \n\n* 2022-09-01: <xref:azure.mgmt.web.v2022_09_01.models>"
+ summary: "Module depends on the API version:\n\n* 2015-04-01: <xref:azure.mgmt.web.v2015_04_01.models#module-azure.mgmt.web.v2015_04_01.models>\
+ \ \n\n* 2015-08-01: <xref:azure.mgmt.web.v2015_08_01.models#module-azure.mgmt.web.v2015_08_01.models>\
+ \ \n\n* 2016-03-01: <xref:azure.mgmt.web.v2016_03_01.models#module-azure.mgmt.web.v2016_03_01.models>\
+ \ \n\n* 2016-08-01: <xref:azure.mgmt.web.v2016_08_01.models#module-azure.mgmt.web.v2016_08_01.models>\
+ \ \n\n* 2016-09-01: <xref:azure.mgmt.web.v2016_09_01.models#module-azure.mgmt.web.v2016_09_01.models>\
+ \ \n\n* 2018-02-01: <xref:azure.mgmt.web.v2018_02_01.models#module-azure.mgmt.web.v2018_02_01.models>\
+ \ \n\n* 2018-11-01: <xref:azure.mgmt.web.v2018_11_01.models#module-azure.mgmt.web.v2018_11_01.models>\
+ \ \n\n* 2019-08-01: <xref:azure.mgmt.web.v2019_08_01.models#module-azure.mgmt.web.v2019_08_01.models>\
+ \ \n\n* 2020-06-01: <xref:azure.mgmt.web.v2020_06_01.models#module-azure.mgmt.web.v2020_06_01.models>\
+ \ \n\n* 2020-09-01: <xref:azure.mgmt.web.v2020_09_01.models#module-azure.mgmt.web.v2020_09_01.models>\
+ \ \n\n* 2020-12-01: <xref:azure.mgmt.web.v2020_12_01.models#module-azure.mgmt.web.v2020_12_01.models>\
+ \ \n\n* 2021-01-01: <xref:azure.mgmt.web.v2021_01_01.models#module-azure.mgmt.web.v2021_01_01.models>\
+ \ \n\n* 2021-01-15: <xref:azure.mgmt.web.v2021_01_15.models#module-azure.mgmt.web.v2021_01_15.models>\
+ \ \n\n* 2022-09-01: <xref:azure.mgmt.web.v2022_09_01.models#module-azure.mgmt.web.v2022_09_01.models>"
signature: models(api_version='2022-09-01')
parameters:
- name: api_version
diff --git a/docs-ref-autogen/azure-mgmt-web/azure.mgmt.web.yml b/docs-ref-autogen/azure-mgmt-web/azure.mgmt.web.yml
index 434ed21bb00c..d03050fc9b4e 100644
--- a/docs-ref-autogen/azure-mgmt-web/azure.mgmt.web.yml
+++ b/docs-ref-autogen/azure-mgmt-web/azure.mgmt.web.yml
@@ -5,8 +5,6 @@ fullName: azure.mgmt.web
type: import
classes:
- azure.mgmt.web.WebSiteManagementClient
-modules:
-- azure.mgmt.web.models
packages:
- azure.mgmt.web.aio
- azure.mgmt.web.v2015_04_01
@@ -23,3 +21,5 @@ packages:
- azure.mgmt.web.v2021_01_01
- azure.mgmt.web.v2021_01_15
- azure.mgmt.web.v2022_09_01
+modules:
+- azure.mgmt.web.models
diff --git a/docs-ref-autogen/azure-monitor-query/azure.monitor.query.LogsQueryClient.yml b/docs-ref-autogen/azure-monitor-query/azure.monitor.query.LogsQueryClient.yml
index 64adcc74acc8..aff3823f8ec4 100644
--- a/docs-ref-autogen/azure-monitor-query/azure.monitor.query.LogsQueryClient.yml
+++ b/docs-ref-autogen/azure-monitor-query/azure.monitor.query.LogsQueryClient.yml
@@ -44,28 +44,29 @@ methods:
\ in the same order as that of the requests sent.\n\nGet a response for multiple\
\ Log Queries.<!--[!code-python[Main](les\\sample_batch_query.py )]-->\n\n<!--\
\ literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [],\
- \ \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 201\\\\azure-monitor-query-1.2.0\\\\samples\\\\sample_batch_query.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n requests =\
- \ [\n LogsBatchQuery(\n query=\"AzureActivity | summarize count()\"\
- ,\n timespan=timedelta(hours=1),\n workspace_id= os.environ['LOGS_WORKSPACE_ID']\n\
- \ ),\n LogsBatchQuery(\n query= \"\"\"bad query\"\"\",\n\
- \ timespan=timedelta(days=1),\n workspace_id= os.environ['LOGS_WORKSPACE_ID']\n\
- \ ),\n LogsBatchQuery(\n query= \"\"\"let Weight = 92233720368547758;\n\
- \ range x from 1 to 3 step 1\n | summarize percentilesw(x,\
- \ Weight * 100, 50)\"\"\",\n workspace_id= os.environ['LOGS_WORKSPACE_ID'],\n\
- \ timespan=(datetime(2021, 6, 2, tzinfo=timezone.utc), datetime(2021,\
- \ 6, 5, tzinfo=timezone.utc)), # (start, end)\n include_statistics=True\n\
- \ ),\n ]\n results = client.query_batch(requests)\n\n for res in results:\n\
- \ if res.status == LogsQueryStatus.FAILURE:\n # this will be a\
- \ LogsQueryError\n print(res)\n elif res.status == LogsQueryStatus.PARTIAL:\n\
- \ ## this will be a LogsQueryPartialResult\n print(res.partial_error)\n\
- \ for table in res.partial_data:\n df = pd.DataFrame(table.rows,\
- \ columns=table.columns)\n print(df)\n elif res.status ==\
- \ LogsQueryStatus.SUCCESS:\n ## this will be a LogsQueryResult\n \
- \ table = res.tables[0]\n df = pd.DataFrame(table.rows, columns=table.columns)\n\
- \ print(df)\n\n\n\n ````"
+ \ \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\200\\\\azure-monitor-query-1.2.0\\\
+ \\samples\\\\sample_batch_query.py\", \"xml:space\": \"preserve\", \"force\":\
+ \ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n requests = [\n LogsBatchQuery(\n\
+ \ query=\"AzureActivity | summarize count()\",\n timespan=timedelta(hours=1),\n\
+ \ workspace_id= os.environ['LOGS_WORKSPACE_ID']\n ),\n LogsBatchQuery(\n\
+ \ query= \"\"\"bad query\"\"\",\n timespan=timedelta(days=1),\n\
+ \ workspace_id= os.environ['LOGS_WORKSPACE_ID']\n ),\n LogsBatchQuery(\n\
+ \ query= \"\"\"let Weight = 92233720368547758;\n range x from\
+ \ 1 to 3 step 1\n | summarize percentilesw(x, Weight * 100, 50)\"\"\"\
+ ,\n workspace_id= os.environ['LOGS_WORKSPACE_ID'],\n timespan=(datetime(2021,\
+ \ 6, 2, tzinfo=timezone.utc), datetime(2021, 6, 5, tzinfo=timezone.utc)), # (start,\
+ \ end)\n include_statistics=True\n ),\n ]\n results = client.query_batch(requests)\n\
+ \n for res in results:\n if res.status == LogsQueryStatus.FAILURE:\n \
+ \ # this will be a LogsQueryError\n print(res)\n elif\
+ \ res.status == LogsQueryStatus.PARTIAL:\n ## this will be a LogsQueryPartialResult\n\
+ \ print(res.partial_error)\n for table in res.partial_data:\n\
+ \ df = pd.DataFrame(table.rows, columns=table.columns)\n \
+ \ print(df)\n elif res.status == LogsQueryStatus.SUCCESS:\n \
+ \ ## this will be a LogsQueryResult\n table = res.tables[0]\n \
+ \ df = pd.DataFrame(table.rows, columns=table.columns)\n print(df)\n\
+ \n\n\n ````"
signature: 'query_batch(queries: Sequence[Dict] | Sequence[LogsBatchQuery], **kwargs:
Any) -> List[LogsQueryResult | LogsQueryError | LogsQueryPartialResult]'
parameters:
@@ -95,8 +96,9 @@ methods:
\ logs matching the given Kusto query for an Azure resource.\n\nGet a response\
\ for a single query on a resource's logs.<!--[!code-python[Main](les\\sample_resource_logs_query.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\201\\\\azure-monitor-query-1.2.0\\\\samples\\\\sample_resource_logs_query.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 200\\\\azure-monitor-query-1.2.0\\\\samples\\\\sample_resource_logs_query.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n import os\n import pandas as pd\n from datetime import timedelta\n \
diff --git a/docs-ref-autogen/azure-monitor-query/azure.monitor.query.MetricsQueryClient.yml b/docs-ref-autogen/azure-monitor-query/azure.monitor.query.MetricsQueryClient.yml
index a28b82b88968..192d24638d76 100644
--- a/docs-ref-autogen/azure-monitor-query/azure.monitor.query.MetricsQueryClient.yml
+++ b/docs-ref-autogen/azure-monitor-query/azure.monitor.query.MetricsQueryClient.yml
@@ -12,10 +12,11 @@ summary: "MetricsQueryClient should be used to collect numeric data from monitor
\ making them particularly useful for alerting and\nfast detection of issues.\n\n\
Creating the MetricsQueryClient with a TokenCredential.<!--[!code-python[Main](les\\\
sample_metrics_query.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
- \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\
- \\1\\\\s\\\\dist_temp\\\\201\\\\azure-monitor-query-1.2.0\\\\samples\\\\sample_metrics_query.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n credential =\
+ \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\200\\\\azure-monitor-query-1.2.0\\\\samples\\\\sample_metrics_query.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
+ \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n credential =\
\ DefaultAzureCredential()\n\n client = MetricsQueryClient(credential)\n\n ````"
constructor:
syntax: 'MetricsQueryClient(credential: TokenCredential, **kwargs: Any)'
diff --git a/docs-ref-autogen/azure-monitor-query/azure.monitor.query.aio.LogsQueryClient.yml b/docs-ref-autogen/azure-monitor-query/azure.monitor.query.aio.LogsQueryClient.yml
index 2e5e532532ab..613b4752844a 100644
--- a/docs-ref-autogen/azure-monitor-query/azure.monitor.query.aio.LogsQueryClient.yml
+++ b/docs-ref-autogen/azure-monitor-query/azure.monitor.query.aio.LogsQueryClient.yml
@@ -77,17 +77,17 @@ methods:
\ for a single query on a resource's logs.<!--[!code-python[Main](les\\async_samples\\\
sample_resource_logs_query_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\201\\\\azure-monitor-query-1.2.0\\\
- \\samples\\\\async_samples\\\\sample_resource_logs_query_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from datetime\
- \ import timedelta\n import os\n\n import pandas as pd\n\n from azure.core.exceptions\
- \ import HttpResponseError\n from azure.identity.aio import DefaultAzureCredential\n\
- \ from azure.monitor.query.aio import LogsQueryClient\n from azure.monitor.query\
- \ import LogsQueryStatus\n\n\n credential = DefaultAzureCredential()\n client\
- \ = LogsQueryClient(credential)\n\n query = \"\"\"AzureActivity | take 5\"\"\
- \"\n\n async def resource_logs_query():\n async with client:\n \
- \ try:\n response = await client.query_resource(os.environ['LOGS_RESOURCE_ID'],\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\200\\\\azure-monitor-query-1.2.0\\\\samples\\\\async_samples\\\
+ \\sample_resource_logs_query_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from datetime import timedelta\n import\
+ \ os\n\n import pandas as pd\n\n from azure.core.exceptions import HttpResponseError\n\
+ \ from azure.identity.aio import DefaultAzureCredential\n from azure.monitor.query.aio\
+ \ import LogsQueryClient\n from azure.monitor.query import LogsQueryStatus\n\
+ \n\n credential = DefaultAzureCredential()\n client = LogsQueryClient(credential)\n\
+ \n query = \"\"\"AzureActivity | take 5\"\"\"\n\n async def resource_logs_query():\n\
+ \ async with client:\n try:\n response = await client.query_resource(os.environ['LOGS_RESOURCE_ID'],\
\ query, timespan=timedelta(days=1))\n if response.status == LogsQueryStatus.PARTIAL:\n\
\ error = response.partial_error\n data =\
\ response.partial_data\n print(error)\n elif\
diff --git a/docs-ref-autogen/azure-schemaregistry/azure.schemaregistry.SchemaRegistryClient.yml b/docs-ref-autogen/azure-schemaregistry/azure.schemaregistry.SchemaRegistryClient.yml
index 243b7a6b079e..300b71faf325 100644
--- a/docs-ref-autogen/azure-schemaregistry/azure.schemaregistry.SchemaRegistryClient.yml
+++ b/docs-ref-autogen/azure-schemaregistry/azure.schemaregistry.SchemaRegistryClient.yml
@@ -33,12 +33,12 @@ examples:
- "Create a new instance of the SchemaRegistryClient.<!--[!code-python[Main](les\\\
sync_samples\\sample_code_schemaregistry.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\202\\\\azure-schemaregistry-1.2.0\\\
- \\samples\\\\sync_samples\\\\sample_code_schemaregistry.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n SCHEMAREGISTRY_FQN\
- \ = os.environ[\"SCHEMAREGISTRY_FULLY_QUALIFIED_NAMESPACE\"]\n token_credential\
- \ = DefaultAzureCredential()\n schema_registry_client = SchemaRegistryClient(\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\201\\\\azure-schemaregistry-1.2.0\\\\samples\\\\sync_samples\\\
+ \\sample_code_schemaregistry.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n SCHEMAREGISTRY_FQN = os.environ[\"SCHEMAREGISTRY_FULLY_QUALIFIED_NAMESPACE\"\
+ ]\n token_credential = DefaultAzureCredential()\n schema_registry_client = SchemaRegistryClient(\n\
\ fully_qualified_namespace=SCHEMAREGISTRY_FQN, credential=token_credential\n\
\ )\n\n ````\n"
methods:
@@ -92,17 +92,18 @@ methods:
examples:
- "Get schema by id.<!--[!code-python[Main](les\\sync_samples\\sample_code_schemaregistry.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\202\\\\azure-schemaregistry-1.2.0\\\\samples\\\\sync_samples\\\\\
- sample_code_schemaregistry.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n schema = schema_registry_client.get_schema(schema_id)\n\
- \ definition = schema.definition\n properties = schema.properties\n\n ````\n\
- \nGet schema by version.<!--[!code-python[Main](les\\sync_samples\\sample_code_schemaregistry.py\
- \ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\202\\\\azure-schemaregistry-1.2.0\\\\samples\\\\sync_samples\\\\\
- sample_code_schemaregistry.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 201\\\\azure-schemaregistry-1.2.0\\\\samples\\\\sync_samples\\\\sample_code_schemaregistry.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n schema = schema_registry_client.get_schema(schema_id)\n definition = schema.definition\n\
+ \ properties = schema.properties\n\n ````\n\nGet schema by version.<!--[!code-python[Main](les\\\
+ sync_samples\\sample_code_schemaregistry.py )]-->\n\n<!-- literal_block {\"ids\"\
+ : [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\201\\\\azure-schemaregistry-1.2.0\\\\samples\\\\sync_samples\\\
+ \\sample_code_schemaregistry.py\", \"xml:space\": \"preserve\", \"force\": false,\
\ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
: false} -->\n\n````python\n\n group_name = os.environ[\"SCHEMAREGISTRY_GROUP\"\
]\n name = \"your-schema-name\"\n schema = schema_registry_client.get_schema(group_name=group_name,\
@@ -146,20 +147,20 @@ methods:
examples:
- "Get schema id.<!--[!code-python[Main](les\\sync_samples\\sample_code_schemaregistry.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\202\\\\azure-schemaregistry-1.2.0\\\\samples\\\\sync_samples\\\\\
- sample_code_schemaregistry.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n group_name = os.environ[\"SCHEMAREGISTRY_GROUP\"\
- ]\n name = \"your-schema-name\"\n format = \"Avro\"\n schema_json = {\n\
- \ \"namespace\": \"example.avro\",\n \"type\": \"record\",\n \
- \ \"name\": \"User\",\n \"fields\": [\n {\"name\": \"name\",\
- \ \"type\": \"string\"},\n {\"name\": \"favorite_number\", \"type\"\
- : [\"int\", \"null\"]},\n {\"name\": \"favorite_color\", \"type\": [\"\
- string\", \"null\"]},\n ],\n }\n definition = json.dumps(schema_json,\
- \ separators=(\",\", \":\"))\n schema_properties = schema_registry_client.get_schema_properties(\n\
- \ group_name, name, definition, format\n )\n schema_id = schema_properties.id\n\
- \n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 201\\\\azure-schemaregistry-1.2.0\\\\samples\\\\sync_samples\\\\sample_code_schemaregistry.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n group_name = os.environ[\"SCHEMAREGISTRY_GROUP\"]\n name = \"your-schema-name\"\
+ \n format = \"Avro\"\n schema_json = {\n \"namespace\": \"example.avro\"\
+ ,\n \"type\": \"record\",\n \"name\": \"User\",\n \"fields\"\
+ : [\n {\"name\": \"name\", \"type\": \"string\"},\n {\"name\"\
+ : \"favorite_number\", \"type\": [\"int\", \"null\"]},\n {\"name\":\
+ \ \"favorite_color\", \"type\": [\"string\", \"null\"]},\n ],\n }\n \
+ \ definition = json.dumps(schema_json, separators=(\",\", \":\"))\n schema_properties\
+ \ = schema_registry_client.get_schema_properties(\n group_name, name, definition,\
+ \ format\n )\n schema_id = schema_properties.id\n\n ````\n"
- uid: azure.schemaregistry.SchemaRegistryClient.register_schema
name: register_schema
summary: 'Register new schema. If schema of specified name does not exist in specified
@@ -202,17 +203,17 @@ methods:
examples:
- "Register a new schema.<!--[!code-python[Main](les\\sync_samples\\sample_code_schemaregistry.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\202\\\\azure-schemaregistry-1.2.0\\\\samples\\\\sync_samples\\\\\
- sample_code_schemaregistry.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n GROUP_NAME = os.environ[\"SCHEMAREGISTRY_GROUP\"\
- ]\n NAME = \"your-schema-name\"\n FORMAT = \"Avro\"\n SCHEMA_JSON = {\n\
- \ \"namespace\": \"example.avro\",\n \"type\": \"record\",\n \
- \ \"name\": \"User\",\n \"fields\": [\n {\"name\": \"name\",\
- \ \"type\": \"string\"},\n {\"name\": \"favorite_number\", \"type\"\
- : [\"int\", \"null\"]},\n {\"name\": \"favorite_color\", \"type\": [\"\
- string\", \"null\"]},\n ],\n }\n DEFINTION = json.dumps(SCHEMA_JSON,\
- \ separators=(\",\", \":\"))\n schema_properties = schema_registry_client.register_schema(\n\
- \ GROUP_NAME, NAME, DEFINTION, FORMAT\n )\n schema_id = schema_properties.id\n\
- \n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 201\\\\azure-schemaregistry-1.2.0\\\\samples\\\\sync_samples\\\\sample_code_schemaregistry.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n GROUP_NAME = os.environ[\"SCHEMAREGISTRY_GROUP\"]\n NAME = \"your-schema-name\"\
+ \n FORMAT = \"Avro\"\n SCHEMA_JSON = {\n \"namespace\": \"example.avro\"\
+ ,\n \"type\": \"record\",\n \"name\": \"User\",\n \"fields\"\
+ : [\n {\"name\": \"name\", \"type\": \"string\"},\n {\"name\"\
+ : \"favorite_number\", \"type\": [\"int\", \"null\"]},\n {\"name\":\
+ \ \"favorite_color\", \"type\": [\"string\", \"null\"]},\n ],\n }\n \
+ \ DEFINTION = json.dumps(SCHEMA_JSON, separators=(\",\", \":\"))\n schema_properties\
+ \ = schema_registry_client.register_schema(\n GROUP_NAME, NAME, DEFINTION,\
+ \ FORMAT\n )\n schema_id = schema_properties.id\n\n ````\n"
diff --git a/docs-ref-autogen/azure-schemaregistry/azure.schemaregistry.aio.SchemaRegistryClient.yml b/docs-ref-autogen/azure-schemaregistry/azure.schemaregistry.aio.SchemaRegistryClient.yml
index df302f9a5de9..c86331f20fbd 100644
--- a/docs-ref-autogen/azure-schemaregistry/azure.schemaregistry.aio.SchemaRegistryClient.yml
+++ b/docs-ref-autogen/azure-schemaregistry/azure.schemaregistry.aio.SchemaRegistryClient.yml
@@ -33,8 +33,9 @@ examples:
- "Create a new instance of the SchemaRegistryClient.<!--[!code-python[Main](les\\\
async_samples\\sample_code_schemaregistry_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"\
- source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\202\\\\azure-schemaregistry-1.2.0\\\
- \\samples\\\\async_samples\\\\sample_code_schemaregistry_async.py\", \"xml:space\"\
+ source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\
+ \\site-packages\\\\py2docfx\\\\dist_temp\\\\201\\\\azure-schemaregistry-1.2.0\\\\\
+ samples\\\\async_samples\\\\sample_code_schemaregistry_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
\ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n SCHEMAREGISTRY_FQN\
\ = os.environ[\"SCHEMAREGISTRY_FULLY_QUALIFIED_NAMESPACE\"]\n token_credential\
@@ -92,22 +93,24 @@ methods:
examples:
- "Get schema by id.<!--[!code-python[Main](les\\async_samples\\sample_code_schemaregistry_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\202\\\\azure-schemaregistry-1.2.0\\\\samples\\\\async_samples\\\\\
- sample_code_schemaregistry_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n schema = await schema_registry_client.get_schema(schema_id)\n\
- \ definition = schema.definition\n properties = schema.properties\n\n ````\n\
- \nGet schema by version.<!--[!code-python[Main](les\\async_samples\\sample_code_schemaregistry_async.py\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 201\\\\azure-schemaregistry-1.2.0\\\\samples\\\\async_samples\\\\sample_code_schemaregistry_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n schema = await schema_registry_client.get_schema(schema_id)\n definition\
+ \ = schema.definition\n properties = schema.properties\n\n ````\n\nGet schema\
+ \ by version.<!--[!code-python[Main](les\\async_samples\\sample_code_schemaregistry_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\202\\\\azure-schemaregistry-1.2.0\\\\samples\\\\async_samples\\\\\
- sample_code_schemaregistry_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n group_name = os.environ[\"SCHEMAREGISTRY_GROUP\"\
- ]\n name = \"your-schema-name\"\n schema = await schema_registry_client.get_schema(group_name=group_name,\
- \ name=name, version=version)\n definition = schema.definition\n properties\
- \ = schema.properties\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 201\\\\azure-schemaregistry-1.2.0\\\\samples\\\\async_samples\\\\sample_code_schemaregistry_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n group_name = os.environ[\"SCHEMAREGISTRY_GROUP\"]\n name = \"your-schema-name\"\
+ \n schema = await schema_registry_client.get_schema(group_name=group_name, name=name,\
+ \ version=version)\n definition = schema.definition\n properties = schema.properties\n\
+ \n ````\n"
- uid: azure.schemaregistry.aio.SchemaRegistryClient.get_schema_properties
name: get_schema_properties
summary: 'Gets the schema properties corresponding to an existing schema within
@@ -146,20 +149,20 @@ methods:
examples:
- "Get schema by id.<!--[!code-python[Main](les\\async_samples\\sample_code_schemaregistry_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\202\\\\azure-schemaregistry-1.2.0\\\\samples\\\\async_samples\\\\\
- sample_code_schemaregistry_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n group_name = os.environ[\"SCHEMAREGISTRY_GROUP\"\
- ]\n name = \"your-schema-name\"\n format = \"Avro\"\n schema_json = {\n\
- \ \"namespace\": \"example.avro\",\n \"type\": \"record\",\n \
- \ \"name\": \"User\",\n \"fields\": [\n {\"name\": \"name\",\
- \ \"type\": \"string\"},\n {\"name\": \"favorite_number\", \"type\"\
- : [\"int\", \"null\"]},\n {\"name\": \"favorite_color\", \"type\": [\"\
- string\", \"null\"]},\n ],\n }\n definition = json.dumps(schema_json,\
- \ separators=(\",\", \":\"))\n schema_properties = await schema_registry_client.get_schema_properties(\n\
- \ group_name, name, definition, format\n )\n schema_id = schema_properties.id\n\
- \n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 201\\\\azure-schemaregistry-1.2.0\\\\samples\\\\async_samples\\\\sample_code_schemaregistry_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n group_name = os.environ[\"SCHEMAREGISTRY_GROUP\"]\n name = \"your-schema-name\"\
+ \n format = \"Avro\"\n schema_json = {\n \"namespace\": \"example.avro\"\
+ ,\n \"type\": \"record\",\n \"name\": \"User\",\n \"fields\"\
+ : [\n {\"name\": \"name\", \"type\": \"string\"},\n {\"name\"\
+ : \"favorite_number\", \"type\": [\"int\", \"null\"]},\n {\"name\":\
+ \ \"favorite_color\", \"type\": [\"string\", \"null\"]},\n ],\n }\n \
+ \ definition = json.dumps(schema_json, separators=(\",\", \":\"))\n schema_properties\
+ \ = await schema_registry_client.get_schema_properties(\n group_name, name,\
+ \ definition, format\n )\n schema_id = schema_properties.id\n\n ````\n"
- uid: azure.schemaregistry.aio.SchemaRegistryClient.register_schema
name: register_schema
summary: 'Register new schema. If schema of specified name does not exist in specified
@@ -202,17 +205,17 @@ methods:
examples:
- "Register a new schema.<!--[!code-python[Main](les\\async_samples\\sample_code_schemaregistry_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\202\\\\azure-schemaregistry-1.2.0\\\\samples\\\\async_samples\\\\\
- sample_code_schemaregistry_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n GROUP_NAME = os.environ[\"SCHEMAREGISTRY_GROUP\"\
- ]\n NAME = \"your-schema-name\"\n FORMAT = \"Avro\"\n SCHEMA_JSON = {\n\
- \ \"namespace\": \"example.avro\",\n \"type\": \"record\",\n \
- \ \"name\": \"User\",\n \"fields\": [\n {\"name\": \"name\",\
- \ \"type\": \"string\"},\n {\"name\": \"favorite_number\", \"type\"\
- : [\"int\", \"null\"]},\n {\"name\": \"favorite_color\", \"type\": [\"\
- string\", \"null\"]},\n ],\n }\n DEFINITION = json.dumps(SCHEMA_JSON,\
- \ separators=(\",\", \":\"))\n schema_properties = await schema_registry_client.register_schema(\n\
- \ GROUP_NAME, NAME, DEFINITION, FORMAT\n )\n schema_id = schema_properties.id\n\
- \n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 201\\\\azure-schemaregistry-1.2.0\\\\samples\\\\async_samples\\\\sample_code_schemaregistry_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n GROUP_NAME = os.environ[\"SCHEMAREGISTRY_GROUP\"]\n NAME = \"your-schema-name\"\
+ \n FORMAT = \"Avro\"\n SCHEMA_JSON = {\n \"namespace\": \"example.avro\"\
+ ,\n \"type\": \"record\",\n \"name\": \"User\",\n \"fields\"\
+ : [\n {\"name\": \"name\", \"type\": \"string\"},\n {\"name\"\
+ : \"favorite_number\", \"type\": [\"int\", \"null\"]},\n {\"name\":\
+ \ \"favorite_color\", \"type\": [\"string\", \"null\"]},\n ],\n }\n \
+ \ DEFINITION = json.dumps(SCHEMA_JSON, separators=(\",\", \":\"))\n schema_properties\
+ \ = await schema_registry_client.register_schema(\n GROUP_NAME, NAME, DEFINITION,\
+ \ FORMAT\n )\n schema_id = schema_properties.id\n\n ````\n"
diff --git a/docs-ref-autogen/azure-search-documents/azure.search.documents.SearchClient.yml b/docs-ref-autogen/azure-search-documents/azure.search.documents.SearchClient.yml
index ae487ae4db82..e397c0908199 100644
--- a/docs-ref-autogen/azure-search-documents/azure.search.documents.SearchClient.yml
+++ b/docs-ref-autogen/azure-search-documents/azure.search.documents.SearchClient.yml
@@ -43,15 +43,15 @@ constructor:
examples:
- "Creating the SearchClient with an API key.<!--[!code-python[Main](les\\sample_authentication.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 204\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_authentication.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.search.documents import SearchClient\n\
- \n service_endpoint = os.getenv(\"AZURE_SEARCH_SERVICE_ENDPOINT\")\n index_name\
- \ = os.getenv(\"AZURE_SEARCH_INDEX_NAME\")\n key = os.getenv(\"AZURE_SEARCH_API_KEY\"\
- )\n\n search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key))\n\
- \n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\203\\\\azure-search-documents-11.3.0\\\
+ \\samples\\\\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.search.documents import SearchClient\n\n service_endpoint = os.getenv(\"\
+ AZURE_SEARCH_SERVICE_ENDPOINT\")\n index_name = os.getenv(\"AZURE_SEARCH_INDEX_NAME\"\
+ )\n key = os.getenv(\"AZURE_SEARCH_API_KEY\")\n\n search_client = SearchClient(service_endpoint,\
+ \ index_name, AzureKeyCredential(key))\n\n ````\n"
methods:
- uid: azure.search.documents.SearchClient.autocomplete
name: autocomplete
@@ -129,13 +129,13 @@ methods:
examples:
- "Get a auto-completions.<!--[!code-python[Main](les\\sample_autocomplete.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\204\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_autocomplete.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.core.credentials import AzureKeyCredential\n from azure.search.documents\
- \ import SearchClient\n\n search_client = SearchClient(service_endpoint, index_name,\
- \ AzureKeyCredential(key))\n\n results = search_client.autocomplete(search_text=\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\203\\\\azure-search-documents-11.3.0\\\
+ \\samples\\\\sample_autocomplete.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.search.documents import SearchClient\n\n search_client = SearchClient(service_endpoint,\
+ \ index_name, AzureKeyCredential(key))\n\n results = search_client.autocomplete(search_text=\"\
bo\", suggester_name=\"sg\")\n\n print(\"Autocomplete suggestions for 'bo'\"\
)\n for result in results:\n print(\" Completion: {}\".format(result[\"\
text\"]))\n\n ````\n"
@@ -175,8 +175,9 @@ methods:
examples:
- "Delete existing documents to an index<!--[!code-python[Main](les\\sample_crud_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_crud_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_crud_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n result = search_client.delete_documents(documents=[{\"HotelId\": \"1000\"\
@@ -204,17 +205,17 @@ methods:
examples:
- "Get a specific document from the search index.<!--[!code-python[Main](les\\sample_get_document.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_get_document.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.core.credentials import AzureKeyCredential\n from azure.search.documents\
- \ import SearchClient\n\n search_client = SearchClient(service_endpoint, index_name,\
- \ AzureKeyCredential(key))\n\n result = search_client.get_document(key=\"23\"\
- )\n\n print(\"Details for hotel '23' are:\")\n print(\" Name: {}\"\
- .format(result[\"HotelName\"]))\n print(\" Rating: {}\".format(result[\"\
- Rating\"]))\n print(\" Category: {}\".format(result[\"Category\"]))\n\n \
- \ ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_get_document.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
+ \ import AzureKeyCredential\n from azure.search.documents import SearchClient\n\
+ \n search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key))\n\
+ \n result = search_client.get_document(key=\"23\")\n\n print(\"Details for\
+ \ hotel '23' are:\")\n print(\" Name: {}\".format(result[\"HotelName\"\
+ ]))\n print(\" Rating: {}\".format(result[\"Rating\"]))\n print(\" \
+ \ Category: {}\".format(result[\"Category\"]))\n\n ````\n"
- uid: azure.search.documents.SearchClient.get_document_count
name: get_document_count
summary: Return the number of documents in the Azure search index.
@@ -263,11 +264,12 @@ methods:
examples:
- "Merge fields into existing documents to an index<!--[!code-python[Main](les\\\
sample_crud_operations.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\\
- samples\\\\sample_crud_operations.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n result = search_client.merge_documents(documents=[{\"\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\203\\\\azure-search-documents-11.3.0\\\\samples\\\\\
+ sample_crud_operations.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n result = search_client.merge_documents(documents=[{\"\
HotelId\": \"1000\", \"Rating\": 4.5}])\n\n print(\"Merge into new document\
\ succeeded: {}\".format(result[0].succeeded))\n\n ````\n"
- uid: azure.search.documents.SearchClient.merge_or_upload_documents
@@ -454,13 +456,13 @@ methods:
examples:
- "Get search result facets.<!--[!code-python[Main](les\\sample_facet_query.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\204\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_facet_query.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.core.credentials import AzureKeyCredential\n from azure.search.documents\
- \ import SearchClient\n\n search_client = SearchClient(service_endpoint, index_name,\
- \ AzureKeyCredential(key))\n\n results = search_client.search(search_text=\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\203\\\\azure-search-documents-11.3.0\\\
+ \\samples\\\\sample_facet_query.py\", \"xml:space\": \"preserve\", \"force\":\
+ \ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.search.documents import SearchClient\n\n search_client = SearchClient(service_endpoint,\
+ \ index_name, AzureKeyCredential(key))\n\n results = search_client.search(search_text=\"\
WiFi\", facets=[\"Category,count:3\", \"ParkingIncluded\"])\n\n facets = results.get_facets()\n\
\n print(\"Catgory facet counts for hotels:\")\n for facet in facets[\"Category\"\
]:\n print(\" {}\".format(facet))\n\n ````\n"
@@ -549,13 +551,13 @@ methods:
examples:
- "Get search suggestions.<!--[!code-python[Main](les\\sample_suggestions.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\204\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_suggestions.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.core.credentials import AzureKeyCredential\n from azure.search.documents\
- \ import SearchClient\n\n search_client = SearchClient(service_endpoint, index_name,\
- \ AzureKeyCredential(key))\n\n results = search_client.suggest(search_text=\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\203\\\\azure-search-documents-11.3.0\\\
+ \\samples\\\\sample_suggestions.py\", \"xml:space\": \"preserve\", \"force\":\
+ \ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.search.documents import SearchClient\n\n search_client = SearchClient(service_endpoint,\
+ \ index_name, AzureKeyCredential(key))\n\n results = search_client.suggest(search_text=\"\
coffee\", suggester_name=\"sg\")\n\n print(\"Search suggestions for 'coffee'\"\
)\n for result in results:\n hotel = search_client.get_document(key=result[\"\
HotelId\"])\n print(\" Text: {} for Hotel: {}\".format(repr(result[\"\
@@ -583,8 +585,9 @@ methods:
examples:
- "Upload new documents to an index<!--[!code-python[Main](les\\sample_crud_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_crud_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_crud_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n DOCUMENT = {\n 'Category': 'Hotel',\n 'HotelId': '1000',\n \
diff --git a/docs-ref-autogen/azure-search-documents/azure.search.documents.aio.SearchClient.yml b/docs-ref-autogen/azure-search-documents/azure.search.documents.aio.SearchClient.yml
index 7dc7e27f202b..b1609e280939 100644
--- a/docs-ref-autogen/azure-search-documents/azure.search.documents.aio.SearchClient.yml
+++ b/docs-ref-autogen/azure-search-documents/azure.search.documents.aio.SearchClient.yml
@@ -43,13 +43,13 @@ constructor:
examples:
- "Creating the SearchClient with an API key.<!--[!code-python[Main](les\\async_samples\\\
sample_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\
- \\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials import\
- \ AzureKeyCredential\n from azure.search.documents.aio import SearchClient\n \
- \ service_endpoint = os.getenv(\"AZURE_SEARCH_SERVICE_ENDPOINT\")\n index_name\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\203\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\\sample_authentication_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
+ \ import AzureKeyCredential\n from azure.search.documents.aio import SearchClient\n\
+ \ service_endpoint = os.getenv(\"AZURE_SEARCH_SERVICE_ENDPOINT\")\n index_name\
\ = os.getenv(\"AZURE_SEARCH_INDEX_NAME\")\n key = os.getenv(\"AZURE_SEARCH_API_KEY\"\
)\n\n search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key))\n\
\n ````\n"
@@ -130,17 +130,17 @@ methods:
examples:
- "Get a auto-completions.<!--[!code-python[Main](les\\async_samples\\sample_autocomplete_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\
- \\sample_autocomplete_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
- \ from azure.search.documents.aio import SearchClient\n\n search_client =\
- \ SearchClient(service_endpoint, index_name, AzureKeyCredential(key))\n\n async\
- \ with search_client:\n results = await search_client.autocomplete(search_text=\"\
- bo\", suggester_name=\"sg\")\n\n print(\"Autocomplete suggestions for 'bo'\"\
- )\n for result in results:\n print(\" Completion: {}\".format(result[\"\
- text\"]))\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\\sample_autocomplete_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.core.credentials import AzureKeyCredential\n from azure.search.documents.aio\
+ \ import SearchClient\n\n search_client = SearchClient(service_endpoint, index_name,\
+ \ AzureKeyCredential(key))\n\n async with search_client:\n results = await\
+ \ search_client.autocomplete(search_text=\"bo\", suggester_name=\"sg\")\n\n \
+ \ print(\"Autocomplete suggestions for 'bo'\")\n for result in results:\n\
+ \ print(\" Completion: {}\".format(result[\"text\"]))\n\n ````\n"
- uid: azure.search.documents.aio.SearchClient.close
name: close
summary: Close the <xref:azure.search.documents.aio.SearchClient> session.
@@ -177,13 +177,14 @@ methods:
examples:
- "Delete existing documents to an index<!--[!code-python[Main](les\\async_samples\\\
sample_crud_operations_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\\
- samples\\\\async_samples\\\\sample_crud_operations_async.py\", \"xml:space\":\
- \ \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n result = await\
- \ search_client.upload_documents(documents=[{\"HotelId\": \"1000\"}])\n\n print(\"\
- Delete new document succeeded: {}\".format(result[0].succeeded))\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\203\\\\azure-search-documents-11.3.0\\\\samples\\\\\
+ async_samples\\\\sample_crud_operations_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n result = await search_client.upload_documents(documents=[{\"\
+ HotelId\": \"1000\"}])\n\n print(\"Delete new document succeeded: {}\".format(result[0].succeeded))\n\
+ \n ````\n"
- uid: azure.search.documents.aio.SearchClient.get_document
name: get_document
summary: Retrieve a document from the Azure search index by its key.
@@ -206,11 +207,12 @@ methods:
examples:
- "Get a specific document from the search index.<!--[!code-python[Main](les\\async_samples\\\
sample_get_document_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\\
- samples\\\\async_samples\\\\sample_get_document_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\203\\\\azure-search-documents-11.3.0\\\\samples\\\\\
+ async_samples\\\\sample_get_document_async.py\", \"xml:space\": \"preserve\",\
+ \ \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
\ import AzureKeyCredential\n from azure.search.documents.aio import SearchClient\n\
\n search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key))\n\
\n async with search_client:\n result = await search_client.get_document(key=\"\
@@ -268,7 +270,8 @@ methods:
- "Merge fields into existing documents to an index<!--[!code-python[Main](les\\\
async_samples\\sample_crud_operations_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\203\\\\azure-search-documents-11.3.0\\\
\\samples\\\\async_samples\\\\sample_crud_operations_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n result = await\
@@ -460,18 +463,18 @@ methods:
examples:
- "Get search result facets.<!--[!code-python[Main](les\\async_samples\\sample_facet_query_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\
- \\sample_facet_query_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
- \ from azure.search.documents.aio import SearchClient\n\n search_client =\
- \ SearchClient(service_endpoint, index_name, AzureKeyCredential(key))\n\n async\
- \ with search_client:\n results = await search_client.search(search_text=\"\
- WiFi\", facets=[\"Category,count:3\", \"ParkingIncluded\"])\n\n facets =\
- \ await results.get_facets()\n\n print(\"Catgory facet counts for hotels:\"\
- )\n for facet in facets[\"Category\"]:\n print(\" {}\".format(facet))\n\
- \n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\\sample_facet_query_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.core.credentials import AzureKeyCredential\n from azure.search.documents.aio\
+ \ import SearchClient\n\n search_client = SearchClient(service_endpoint, index_name,\
+ \ AzureKeyCredential(key))\n\n async with search_client:\n results = await\
+ \ search_client.search(search_text=\"WiFi\", facets=[\"Category,count:3\", \"\
+ ParkingIncluded\"])\n\n facets = await results.get_facets()\n\n print(\"\
+ Catgory facet counts for hotels:\")\n for facet in facets[\"Category\"]:\n\
+ \ print(\" {}\".format(facet))\n\n ````\n"
- uid: azure.search.documents.aio.SearchClient.suggest
name: suggest
summary: "Get search suggestion results from the Azure search index.\n\ncharacter,\
@@ -558,18 +561,19 @@ methods:
examples:
- "Get search suggestions.<!--[!code-python[Main](les\\async_samples\\sample_suggestions_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\
- \\sample_suggestions_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
- \ from azure.search.documents.aio import SearchClient\n\n search_client =\
- \ SearchClient(service_endpoint, index_name, AzureKeyCredential(key))\n\n async\
- \ with search_client:\n results = await search_client.suggest(search_text=\"\
- coffee\", suggester_name=\"sg\")\n\n print(\"Search suggestions for 'coffee'\"\
- )\n for result in results:\n hotel = await search_client.get_document(key=result[\"\
- HotelId\"])\n print(\" Text: {} for Hotel: {}\".format(repr(result[\"\
- text\"]), hotel[\"HotelName\"]))\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\\sample_suggestions_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.core.credentials import AzureKeyCredential\n from azure.search.documents.aio\
+ \ import SearchClient\n\n search_client = SearchClient(service_endpoint, index_name,\
+ \ AzureKeyCredential(key))\n\n async with search_client:\n results = await\
+ \ search_client.suggest(search_text=\"coffee\", suggester_name=\"sg\")\n\n \
+ \ print(\"Search suggestions for 'coffee'\")\n for result in results:\n\
+ \ hotel = await search_client.get_document(key=result[\"HotelId\"])\n\
+ \ print(\" Text: {} for Hotel: {}\".format(repr(result[\"text\"]),\
+ \ hotel[\"HotelName\"]))\n\n ````\n"
- uid: azure.search.documents.aio.SearchClient.upload_documents
name: upload_documents
summary: 'Upload documents to the Azure search index.
@@ -593,12 +597,13 @@ methods:
examples:
- "Upload new documents to an index<!--[!code-python[Main](les\\async_samples\\\
sample_crud_operations_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\\
- samples\\\\async_samples\\\\sample_crud_operations_async.py\", \"xml:space\":\
- \ \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n DOCUMENT =\
- \ {\n 'Category': 'Hotel',\n 'HotelId': '1000',\n 'Rating':\
- \ 4.0,\n 'Rooms': [],\n 'HotelName': 'Azure Inn',\n }\n\n result\
- \ = await search_client.upload_documents(documents=[DOCUMENT])\n\n print(\"\
- Upload of new document succeeded: {}\".format(result[0].succeeded))\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\203\\\\azure-search-documents-11.3.0\\\\samples\\\\\
+ async_samples\\\\sample_crud_operations_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n DOCUMENT = {\n 'Category':\
+ \ 'Hotel',\n 'HotelId': '1000',\n 'Rating': 4.0,\n 'Rooms':\
+ \ [],\n 'HotelName': 'Azure Inn',\n }\n\n result = await search_client.upload_documents(documents=[DOCUMENT])\n\
+ \n print(\"Upload of new document succeeded: {}\".format(result[0].succeeded))\n\
+ \n ````\n"
diff --git a/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.SearchIndexClient.yml b/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.SearchIndexClient.yml
index 17f1ecba8f20..bf36596d3d04 100644
--- a/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.SearchIndexClient.yml
+++ b/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.SearchIndexClient.yml
@@ -61,16 +61,16 @@ methods:
examples:
- "Analyze text<!--[!code-python[Main](les\\sample_analyze_text.py )]-->\n\n<!--\
\ literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [],\
- \ \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 204\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_analyze_text.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.search.documents.indexes import SearchIndexClient\n\
- \ from azure.search.documents.indexes.models import AnalyzeTextOptions\n\n \
- \ client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))\n\n \
- \ analyze_request = AnalyzeTextOptions(text=\"One's <two/>\", analyzer_name=\"\
- standard.lucene\")\n\n result = client.analyze_text(index_name, analyze_request)\n\
- \ print(result.as_dict())\n\n ````\n"
+ \ \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\203\\\\azure-search-documents-11.3.0\\\
+ \\samples\\\\sample_analyze_text.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.search.documents.indexes import SearchIndexClient\n from azure.search.documents.indexes.models\
+ \ import AnalyzeTextOptions\n\n client = SearchIndexClient(service_endpoint,\
+ \ AzureKeyCredential(key))\n\n analyze_request = AnalyzeTextOptions(text=\"\
+ One's <two/>\", analyzer_name=\"standard.lucene\")\n\n result = client.analyze_text(index_name,\
+ \ analyze_request)\n print(result.as_dict())\n\n ````\n"
- uid: azure.search.documents.indexes.SearchIndexClient.close
name: close
summary: Close the <xref:azure.search.documents.indexes.SearchIndexClient> session.
@@ -94,8 +94,9 @@ methods:
examples:
- "Creating a new index.<!--[!code-python[Main](les\\sample_index_crud_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_index_crud_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_index_crud_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n name = \"hotels\"\n fields = [\n SimpleField(name=\"hotelId\", type=SearchFieldDataType.String,\
@@ -153,8 +154,9 @@ methods:
examples:
- "Update an index.<!--[!code-python[Main](les\\sample_index_crud_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_index_crud_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_index_crud_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n name = \"hotels\"\n fields = [\n SimpleField(name=\"hotelId\", type=SearchFieldDataType.String,\
@@ -209,8 +211,9 @@ methods:
examples:
- "Create a Synonym Map<!--[!code-python[Main](les\\sample_synonym_map_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_synonym_map_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_synonym_map_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n synonyms = [\n \"USA, United States, United States of America\",\n\
@@ -240,8 +243,9 @@ methods:
examples:
- "Delete an index.<!--[!code-python[Main](les\\sample_index_crud_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_index_crud_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_index_crud_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n name = \"hotels\"\n client.delete_index(name)\n\n ````\n"
@@ -272,8 +276,9 @@ methods:
examples:
- "Delete a Synonym Map<!--[!code-python[Main](les\\sample_synonym_map_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_synonym_map_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_synonym_map_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n client.delete_synonym_map(\"test-syn-map\")\n print(\"Synonym Map 'test-syn-map'\
@@ -296,11 +301,12 @@ methods:
examples:
- "Get an index.<!--[!code-python[Main](les\\sample_index_crud_operations.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\204\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_index_crud_operations.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n name = \"hotels\"\n result = client.get_index(name)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\203\\\\azure-search-documents-11.3.0\\\
+ \\samples\\\\sample_index_crud_operations.py\", \"xml:space\": \"preserve\", \"\
+ force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n name = \"hotels\"\n result\
+ \ = client.get_index(name)\n\n ````\n"
- uid: azure.search.documents.indexes.SearchIndexClient.get_index_statistics
name: get_index_statistics
summary: 'Returns statistics for the given index, including a document count
@@ -356,8 +362,9 @@ methods:
examples:
- "Get a Synonym Map<!--[!code-python[Main](les\\sample_synonym_map_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_synonym_map_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_synonym_map_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n result = client.get_synonym_map(\"test-syn-map\")\n print(\"Retrived Synonym\
@@ -396,8 +403,9 @@ methods:
examples:
- "List Synonym Maps<!--[!code-python[Main](les\\sample_synonym_map_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_synonym_map_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_synonym_map_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n result = client.get_synonym_maps()\n names = [x.name for x in result]\n\
diff --git a/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.SearchIndexerClient.yml b/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.SearchIndexerClient.yml
index aa956733877f..b9cae70d0e17 100644
--- a/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.SearchIndexerClient.yml
+++ b/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.SearchIndexerClient.yml
@@ -58,8 +58,9 @@ methods:
examples:
- "Create a Data Source<!--[!code-python[Main](les\\sample_data_source_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_data_source_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_data_source_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n container = SearchIndexerDataContainer(name='searchcontainer')\n data_source_connection\
@@ -179,8 +180,9 @@ methods:
examples:
- "Delete a SearchIndexerDataSourceConnection<!--[!code-python[Main](les\\sample_data_source_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_data_source_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_data_source_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n client.delete_data_source_connection(\"sample-data-source-connection\")\n\
@@ -248,8 +250,9 @@ methods:
examples:
- "Retrieve a SearchIndexerDataSourceConnection<!--[!code-python[Main](les\\sample_data_source_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_data_source_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\sample_data_source_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n result = client.get_data_source_connection(\"sample-data-source-connection\"\
@@ -285,10 +288,11 @@ methods:
- "List all the SearchIndexerDataSourceConnections<!--[!code-python[Main](les\\\
sample_data_source_operations.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\
- \\samples\\\\sample_data_source_operations.py\", \"xml:space\": \"preserve\",\
- \ \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n result = client.get_data_source_connections()\n\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\203\\\\azure-search-documents-11.3.0\\\\samples\\\\\
+ sample_data_source_operations.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n result = client.get_data_source_connections()\n\
\ names = [ds.name for ds in result]\n print(\"Found {} Data Source Connections\
\ in the service: {}\".format(len(result), \", \".join(names)))\n\n ````\n"
- uid: azure.search.documents.indexes.SearchIndexerClient.get_indexer
diff --git a/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.aio.SearchIndexClient.yml b/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.aio.SearchIndexClient.yml
index fe510bc6bb7d..8b023c9ce1e4 100644
--- a/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.aio.SearchIndexClient.yml
+++ b/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.aio.SearchIndexClient.yml
@@ -61,16 +61,16 @@ methods:
examples:
- "Analyze text<!--[!code-python[Main](les\\async_samples\\sample_analyze_text_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\
- \\sample_analyze_text_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
- \ from azure.search.documents.indexes.aio import SearchIndexClient\n from\
- \ azure.search.documents.indexes.models import AnalyzeTextOptions\n\n client\
- \ = SearchIndexClient(service_endpoint, AzureKeyCredential(key))\n\n analyze_request\
- \ = AnalyzeTextOptions(text=\"One's <two/>\", analyzer_name=\"standard.lucene\"\
- )\n\n async with client:\n result = await client.analyze_text(index_name,\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\\sample_analyze_text_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.core.credentials import AzureKeyCredential\n from azure.search.documents.indexes.aio\
+ \ import SearchIndexClient\n from azure.search.documents.indexes.models import\
+ \ AnalyzeTextOptions\n\n client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))\n\
+ \n analyze_request = AnalyzeTextOptions(text=\"One's <two/>\", analyzer_name=\"\
+ standard.lucene\")\n\n async with client:\n result = await client.analyze_text(index_name,\
\ analyze_request)\n print(result.as_dict())\n\n ````\n"
- uid: azure.search.documents.indexes.aio.SearchIndexClient.close
name: close
@@ -95,21 +95,22 @@ methods:
examples:
- "Creating a new index.<!--[!code-python[Main](les\\async_samples\\sample_index_crud_operations_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\
- \\sample_index_crud_operations_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n name = \"hotels\"\n fields = [\n \
- \ SimpleField(name=\"hotelId\", type=SearchFieldDataType.String, key=True),\n\
- \ SimpleField(name=\"baseRate\", type=SearchFieldDataType.Double),\n \
- \ SearchableField(name=\"description\", type=SearchFieldDataType.String, collection=True),\n\
- \ ComplexField(name=\"address\", fields=[\n SimpleField(name=\"\
- streetAddress\", type=SearchFieldDataType.String),\n SimpleField(name=\"\
- city\", type=SearchFieldDataType.String),\n ], collection=True)\n ]\n\n\
- \ cors_options = CorsOptions(allowed_origins=[\"*\"], max_age_in_seconds=60)\n\
- \ scoring_profiles = []\n index = SearchIndex(\n name=name,\n \
- \ fields=fields,\n scoring_profiles=scoring_profiles,\n cors_options=cors_options)\n\
- \n result = await client.create_index(index)\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\\sample_index_crud_operations_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n name = \"hotels\"\n fields = [\n SimpleField(name=\"hotelId\", type=SearchFieldDataType.String,\
+ \ key=True),\n SimpleField(name=\"baseRate\", type=SearchFieldDataType.Double),\n\
+ \ SearchableField(name=\"description\", type=SearchFieldDataType.String,\
+ \ collection=True),\n ComplexField(name=\"address\", fields=[\n \
+ \ SimpleField(name=\"streetAddress\", type=SearchFieldDataType.String),\n \
+ \ SimpleField(name=\"city\", type=SearchFieldDataType.String),\n \
+ \ ], collection=True)\n ]\n\n cors_options = CorsOptions(allowed_origins=[\"\
+ *\"], max_age_in_seconds=60)\n scoring_profiles = []\n index = SearchIndex(\n\
+ \ name=name,\n fields=fields,\n scoring_profiles=scoring_profiles,\n\
+ \ cors_options=cors_options)\n\n result = await client.create_index(index)\n\
+ \n ````\n"
- uid: azure.search.documents.indexes.aio.SearchIndexClient.create_or_update_index
name: create_or_update_index
summary: Creates a new search index or updates an index if it already exists.
@@ -154,15 +155,15 @@ methods:
examples:
- "Update an index.<!--[!code-python[Main](les\\async_samples\\sample_index_crud_operations_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\
- \\sample_index_crud_operations_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n name = \"hotels\"\n fields = [\n \
- \ SimpleField(name=\"hotelId\", type=SearchFieldDataType.String, key=True),\n\
- \ SimpleField(name=\"baseRate\", type=SearchFieldDataType.Double),\n \
- \ SearchableField(name=\"description\", type=SearchFieldDataType.String, collection=True),\n\
- \ SearchableField(name=\"hotelName\", type=SearchFieldDataType.String),\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\\sample_index_crud_operations_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n name = \"hotels\"\n fields = [\n SimpleField(name=\"hotelId\", type=SearchFieldDataType.String,\
+ \ key=True),\n SimpleField(name=\"baseRate\", type=SearchFieldDataType.Double),\n\
+ \ SearchableField(name=\"description\", type=SearchFieldDataType.String,\
+ \ collection=True),\n SearchableField(name=\"hotelName\", type=SearchFieldDataType.String),\n\
\ ComplexField(name=\"address\", fields=[\n SimpleField(name=\"\
streetAddress\", type=SearchFieldDataType.String),\n SimpleField(name=\"\
city\", type=SearchFieldDataType.String),\n SimpleField(name=\"state\"\
@@ -212,13 +213,14 @@ methods:
examples:
- "Create a Synonym Map<!--[!code-python[Main](les\\async_samples\\sample_synonym_map_operations_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\
- \\sample_synonym_map_operations_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n synonyms = [\n \"USA, United States,\
- \ United States of America\",\n \"Washington, Wash. => WA\",\n ]\n synonym_map\
- \ = SynonymMap(name=\"test-syn-map\", synonyms=synonyms)\n result = await client.create_synonym_map(synonym_map)\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\\sample_synonym_map_operations_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n synonyms = [\n \"USA, United States, United States of America\",\n\
+ \ \"Washington, Wash. => WA\",\n ]\n synonym_map = SynonymMap(name=\"\
+ test-syn-map\", synonyms=synonyms)\n result = await client.create_synonym_map(synonym_map)\n\
\ print(\"Create new Synonym Map 'test-syn-map succeeded\")\n\n ````\n"
- uid: azure.search.documents.indexes.aio.SearchIndexClient.delete_index
name: delete_index
@@ -242,12 +244,12 @@ methods:
examples:
- "Delete an index.<!--[!code-python[Main](les\\async_samples\\sample_index_crud_operations_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\
- \\sample_index_crud_operations_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n name = \"hotels\"\n await client.delete_index(name)\n\
- \n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\\sample_index_crud_operations_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n name = \"hotels\"\n await client.delete_index(name)\n\n ````\n"
- uid: azure.search.documents.indexes.aio.SearchIndexClient.delete_synonym_map
name: delete_synonym_map
summary: 'Delete a named Synonym Map in an Azure Search service. To use access conditions,
@@ -275,12 +277,13 @@ methods:
examples:
- "Delete a Synonym Map<!--[!code-python[Main](les\\async_samples\\sample_synonym_map_operations_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\
- \\sample_synonym_map_operations_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n await client.delete_synonym_map(\"test-syn-map\"\
- )\n print(\"Synonym Map 'test-syn-map' deleted\")\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\\sample_synonym_map_operations_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n await client.delete_synonym_map(\"test-syn-map\")\n print(\"Synonym Map\
+ \ 'test-syn-map' deleted\")\n\n ````\n"
- uid: azure.search.documents.indexes.aio.SearchIndexClient.get_index
name: get_index
signature: 'async get_index(name: str, **kwargs: Any) -> SearchIndex'
@@ -299,12 +302,12 @@ methods:
examples:
- "Get an index.<!--[!code-python[Main](les\\async_samples\\sample_index_crud_operations_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\
- \\sample_index_crud_operations_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n name = \"hotels\"\n result = await\
- \ client.get_index(name)\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\\sample_index_crud_operations_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n name = \"hotels\"\n result = await client.get_index(name)\n\n ````\n"
- uid: azure.search.documents.indexes.aio.SearchIndexClient.get_index_statistics
name: get_index_statistics
summary: 'Returns statistics for the given index, including a document count
@@ -360,14 +363,14 @@ methods:
examples:
- "Get a Synonym Map<!--[!code-python[Main](les\\async_samples\\sample_synonym_map_operations_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\
- \\sample_synonym_map_operations_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n result = await client.get_synonym_map(\"\
- test-syn-map\")\n print(\"Retrived Synonym Map 'test-syn-map' with synonyms\"\
- )\n for syn in result.synonyms:\n print(\" {}\".format(syn))\n\n \
- \ ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\\sample_synonym_map_operations_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n result = await client.get_synonym_map(\"test-syn-map\")\n print(\"Retrived\
+ \ Synonym Map 'test-syn-map' with synonyms\")\n for syn in result.synonyms:\n\
+ \ print(\" {}\".format(syn))\n\n ````\n"
- uid: azure.search.documents.indexes.aio.SearchIndexClient.get_synonym_map_names
name: get_synonym_map_names
summary: List the Synonym Map names in an Azure Search service.
@@ -401,13 +404,14 @@ methods:
examples:
- "List Synonym Maps<!--[!code-python[Main](les\\async_samples\\sample_synonym_map_operations_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\
- \\sample_synonym_map_operations_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n result = await client.get_synonym_maps()\n\
- \ names = [x.name for x in result]\n print(\"Found {} Synonym Maps in the\
- \ service: {}\".format(len(result), \", \".join(names)))\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 203\\\\azure-search-documents-11.3.0\\\\samples\\\\async_samples\\\\sample_synonym_map_operations_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n result = await client.get_synonym_maps()\n names = [x.name for x in result]\n\
+ \ print(\"Found {} Synonym Maps in the service: {}\".format(len(result), \"\
+ , \".join(names)))\n\n ````\n"
- uid: azure.search.documents.indexes.aio.SearchIndexClient.list_index_names
name: list_index_names
summary: List the index names in an Azure Search service.
diff --git a/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.aio.SearchIndexerClient.yml b/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.aio.SearchIndexerClient.yml
index 520c0b73ff0a..7c921b82afb0 100644
--- a/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.aio.SearchIndexerClient.yml
+++ b/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.aio.SearchIndexerClient.yml
@@ -59,15 +59,15 @@ methods:
- "Create a SearchIndexerDataSourceConnection<!--[!code-python[Main](les\\async_samples\\\
sample_data_source_operations_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\
- \\samples\\\\async_samples\\\\sample_data_source_operations_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n container\
- \ = SearchIndexerDataContainer(name='searchcontainer')\n data_source = SearchIndexerDataSourceConnection(\n\
- \ name=\"async-sample-data-source-connection\",\n type=\"azureblob\"\
- ,\n connection_string=connection_string,\n container=container\n \
- \ )\n result = await client.create_data_source_connection(data_source)\n \
- \ print(\"Create new Data Source Connection - async-sample-data-source-connection\"\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\203\\\\azure-search-documents-11.3.0\\\\samples\\\\\
+ async_samples\\\\sample_data_source_operations_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n container = SearchIndexerDataContainer(name='searchcontainer')\n\
+ \ data_source = SearchIndexerDataSourceConnection(\n name=\"async-sample-data-source-connection\"\
+ ,\n type=\"azureblob\",\n connection_string=connection_string,\n \
+ \ container=container\n )\n result = await client.create_data_source_connection(data_source)\n\
+ \ print(\"Create new Data Source Connection - async-sample-data-source-connection\"\
)\n\n ````\n"
- uid: azure.search.documents.indexes.aio.SearchIndexerClient.create_indexer
name: create_indexer
@@ -249,7 +249,7 @@ methods:
- '<xref:azure.search.documents.indexes.models.SearchIndexerDataSourceConnectionRetrieve
a SearchIndexerDataSourceConnection<!-->[<xref:!code-python>[<xref:Main>](<xref:les\async_samples\sample_data_source_operations_async.py
>)]<xref:--<!-- literal_block {"ids": >[], <xref:"classes": >[], <xref:"names":
- >[], <xref:"dupnames": >[], <xref:"backrefs": >[], <xref:"source": "D:\\a\\_work\\1\\s\\dist_temp\\204\\azure-search-documents-11.3.0\\samples\\async_samples\\sample_data_source_operations_async.py">,
+ >[], <xref:"dupnames": >[], <xref:"backrefs": >[], <xref:"source": "C:\\hostedtoolcache\\windows\\Python\\3.11.5\\x64\\Lib\\site-packages\\py2docfx\\dist_temp\\203\\azure-search-documents-11.3.0\\samples\\async_samples\\sample_data_source_operations_async.py">,
<xref:"xml:space": "preserve">, <xref:"force": false>, <xref:"language": "python">,
<xref:"highlight_args": {"linenostart": 1}>, <xref:"linenos": false} --````python result
= await client.get_data_source_connection>(<xref:"async-sample-data-source-connection">)<xref: print>(<xref:"Retrived
@@ -275,13 +275,13 @@ methods:
- "List all SearchIndexerDataSourceConnections<!--[!code-python[Main](les\\async_samples\\\
sample_data_source_operations_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\204\\\\azure-search-documents-11.3.0\\\
- \\samples\\\\async_samples\\\\sample_data_source_operations_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n result = await\
- \ client.get_data_source_connections()\n names = [x.name for x in result]\n\
- \ print(\"Found {} Data Source Connections in the service: {}\".format(len(result),\
- \ \", \".join(names)))\n\n ````\n"
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\203\\\\azure-search-documents-11.3.0\\\\samples\\\\\
+ async_samples\\\\sample_data_source_operations_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n result = await client.get_data_source_connections()\n\
+ \ names = [x.name for x in result]\n print(\"Found {} Data Source Connections\
+ \ in the service: {}\".format(len(result), \", \".join(names)))\n\n ````\n"
- uid: azure.search.documents.indexes.aio.SearchIndexerClient.get_indexer
name: get_indexer
summary: Retrieves a indexer definition.
diff --git a/docs-ref-autogen/azure-security-attestation/azure.security.attestation.AttestationAdministrationClient.yml b/docs-ref-autogen/azure-security-attestation/azure.security.attestation.AttestationAdministrationClient.yml
index d0546e65a234..122bb5658a26 100644
--- a/docs-ref-autogen/azure-security-attestation/azure.security.attestation.AttestationAdministrationClient.yml
+++ b/docs-ref-autogen/azure-security-attestation/azure.security.attestation.AttestationAdministrationClient.yml
@@ -196,8 +196,9 @@ methods:
examples:
- "Adding a policy management certificate.<!--[!code-python[Main](les\\sample_get_set_policy.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\205\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_get_set_policy.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 204\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_get_set_policy.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n new_key = create_rsa_key()\n new_certificate = create_x509_certificate(new_key,\
@@ -286,8 +287,9 @@ methods:
examples:
- "Getting the current policy document.<!--[!code-python[Main](les\\sample_get_set_policy.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\205\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_get_set_policy.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 204\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_get_set_policy.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n with AttestationAdministrationClient(\n os.environ.get(\"ATTESTATION_AAD_URL\"\
@@ -365,8 +367,9 @@ methods:
examples:
- "Retrieving the policy management certificates.<!--[!code-python[Main](les\\sample_get_set_policy.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\205\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_get_set_policy.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 204\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_get_set_policy.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n print(\"Get the policy management certificates for a isolated instance.\"\
@@ -483,8 +486,9 @@ methods:
examples:
- "Removing a policy management certificate.<!--[!code-python[Main](les\\sample_get_set_policy.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\205\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_get_set_policy.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 204\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_get_set_policy.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n with AttestationAdministrationClient(\n endpoint, DefaultAzureCredential()\n\
@@ -581,8 +585,9 @@ methods:
examples:
- "Resetting an AAD mode attestation instance.<!--[!code-python[Main](les\\sample_get_set_policy.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\205\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_get_set_policy.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 204\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_get_set_policy.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n print(\"Set Secured Policy on an Isolated mode attestation instance.\")\n\
@@ -680,22 +685,22 @@ methods:
examples:
- "Setting the attestation policy with hash verification.<!--[!code-python[Main](les\\\
sample_get_set_policy.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\205\\\\azure-security-attestation-1.0.0\\\
- \\samples\\\\sample_get_set_policy.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from cryptography.hazmat.primitives\
- \ import hashes\n\n write_banner(\"set_policy_aad_secured\")\n \
- \ print(\"Set Secured Policy on an AAD mode attestation instance.\")\n \
- \ with AttestationAdministrationClient(\n os.environ.get(\"\
- ATTESTATION_AAD_URL\"), DefaultAzureCredential()\n ) as admin_client:\n\
- \ # Create an RSA Key and wrap an X.509 certificate around\n \
- \ # the public key for that certificate.\n rsa_key =\
- \ create_rsa_key()\n cert = create_x509_certificate(rsa_key, u\"\
- TestCertificate\")\n\n # Set a minimal policy.\n policy_to_set\
- \ = \"\"\"\n version= 1.0;\n authorizationrules{=> permit();};\n issuancerules\
- \ {};\n \"\"\"\n set_result, _ = admin_client.set_policy(\n \
- \ AttestationType.SGX_ENCLAVE,\n policy_to_set,\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\204\\\\azure-security-attestation-1.0.0\\\\samples\\\
+ \\sample_get_set_policy.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from cryptography.hazmat.primitives import\
+ \ hashes\n\n write_banner(\"set_policy_aad_secured\")\n print(\"\
+ Set Secured Policy on an AAD mode attestation instance.\")\n with AttestationAdministrationClient(\n\
+ \ os.environ.get(\"ATTESTATION_AAD_URL\"), DefaultAzureCredential()\n\
+ \ ) as admin_client:\n # Create an RSA Key and wrap an\
+ \ X.509 certificate around\n # the public key for that certificate.\n\
+ \ rsa_key = create_rsa_key()\n cert = create_x509_certificate(rsa_key,\
+ \ u\"TestCertificate\")\n\n # Set a minimal policy.\n \
+ \ policy_to_set = \"\"\"\n version= 1.0;\n authorizationrules{=> permit();};\n\
+ \ issuancerules {};\n \"\"\"\n set_result, _ = admin_client.set_policy(\n\
+ \ AttestationType.SGX_ENCLAVE,\n policy_to_set,\n\
\ signing_key=rsa_key,\n signing_certificate=cert,\n\
\ )\n print(\"Policy Set Resolution: \", set_result.policy_resolution)\n\
\ print(\"Resulting policy signer should match the input certificate:\"\
diff --git a/docs-ref-autogen/azure-security-attestation/azure.security.attestation.AttestationClient.yml b/docs-ref-autogen/azure-security-attestation/azure.security.attestation.AttestationClient.yml
index 2643259583ac..a585ea0a3ac6 100644
--- a/docs-ref-autogen/azure-security-attestation/azure.security.attestation.AttestationClient.yml
+++ b/docs-ref-autogen/azure-security-attestation/azure.security.attestation.AttestationClient.yml
@@ -206,8 +206,9 @@ methods:
examples:
- "Attesting using a draft attestation policy.<!--[!code-python[Main](les\\sample_attest_enclave.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\205\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_attest_enclave.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 204\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_attest_enclave.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n draft_policy = \"\"\"\n version= 1.0;\n authorizationrules\n {\n \
@@ -334,8 +335,9 @@ methods:
examples:
- "Attesting an SGX Enclave<!--[!code-python[Main](les\\sample_attest_enclave.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\205\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_attest_enclave.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 204\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_attest_enclave.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n print(\"\\nAttest SGX enclave using {}\".format(self.shared_url))\n with\
diff --git a/docs-ref-autogen/azure-security-attestation/azure.security.attestation.aio.AttestationAdministrationClient.yml b/docs-ref-autogen/azure-security-attestation/azure.security.attestation.aio.AttestationAdministrationClient.yml
index fe30e7a49bf1..f6e0d9744e7b 100644
--- a/docs-ref-autogen/azure-security-attestation/azure.security.attestation.aio.AttestationAdministrationClient.yml
+++ b/docs-ref-autogen/azure-security-attestation/azure.security.attestation.aio.AttestationAdministrationClient.yml
@@ -194,8 +194,9 @@ methods:
examples:
- "Adding a policy management certificate.<!--[!code-python[Main](les\\sample_get_set_policy_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\205\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_get_set_policy_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 204\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_get_set_policy_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n async with DefaultAzureCredential() as credential, AttestationAdministrationClient(\n\
@@ -286,8 +287,9 @@ methods:
examples:
- "Getting the current policy document.<!--[!code-python[Main](les\\sample_get_set_policy_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\205\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_get_set_policy_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 204\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_get_set_policy_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n async with DefaultAzureCredential() as credential, AttestationAdministrationClient(\n\
@@ -366,8 +368,9 @@ methods:
examples:
- "Retrieving the policy management certificates.<!--[!code-python[Main](les\\sample_get_set_policy_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\205\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_get_set_policy_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 204\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_get_set_policy_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n print(\"Get the policy management certificates for a isolated instance.\"\
@@ -484,8 +487,9 @@ methods:
examples:
- "Removing a policy management certificate.<!--[!code-python[Main](les\\sample_get_set_policy_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\205\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_get_set_policy_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 204\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_get_set_policy_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n async with DefaultAzureCredential() as credential, AttestationAdministrationClient(\n\
@@ -664,16 +668,17 @@ methods:
examples:
- "Setting the attestation policy with hash verification.<!--[!code-python[Main](les\\\
sample_get_set_policy_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\205\\\\azure-security-attestation-1.0.0\\\
- \\samples\\\\sample_get_set_policy_async.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from cryptography.hazmat.primitives\
- \ import hashes\n\n write_banner(\"set_policy_aad_secured\")\n \
- \ print(\"Set Secured Policy on an AAD mode attestation instance.\")\n \
- \ async with DefaultAzureCredential() as credential, AttestationAdministrationClient(\n\
- \ os.environ.get(\"ATTESTATION_AAD_URL\"), credential\n \
- \ ) as admin_client:\n # Create an RSA Key and wrap an X.509 certificate\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\204\\\\azure-security-attestation-1.0.0\\\\samples\\\
+ \\sample_get_set_policy_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from cryptography.hazmat.primitives import\
+ \ hashes\n\n write_banner(\"set_policy_aad_secured\")\n print(\"\
+ Set Secured Policy on an AAD mode attestation instance.\")\n async with\
+ \ DefaultAzureCredential() as credential, AttestationAdministrationClient(\n \
+ \ os.environ.get(\"ATTESTATION_AAD_URL\"), credential\n \
+ \ ) as admin_client:\n # Create an RSA Key and wrap an X.509 certificate\
\ around\n # the public key for that certificate.\n \
\ rsa_key = create_rsa_key()\n cert = create_x509_certificate(rsa_key,\
\ u\"TestCertificate\")\n\n # Set a minimal policy.\n \
diff --git a/docs-ref-autogen/azure-security-attestation/azure.security.attestation.aio.AttestationClient.yml b/docs-ref-autogen/azure-security-attestation/azure.security.attestation.aio.AttestationClient.yml
index 9d8243ed7fe8..b25955c6ed8f 100644
--- a/docs-ref-autogen/azure-security-attestation/azure.security.attestation.aio.AttestationClient.yml
+++ b/docs-ref-autogen/azure-security-attestation/azure.security.attestation.aio.AttestationClient.yml
@@ -206,8 +206,9 @@ methods:
examples:
- "Attesting using a draft attestation policy.<!--[!code-python[Main](les\\sample_attest_enclave_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\205\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_attest_enclave_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 204\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_attest_enclave_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n draft_policy = \"\"\"\n version= 1.0;\n authorizationrules\n {\n \
@@ -335,8 +336,9 @@ methods:
examples:
- "Attesting an SGX Enclave<!--[!code-python[Main](les\\sample_attest_enclave_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\205\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_attest_enclave_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 204\\\\azure-security-attestation-1.0.0\\\\samples\\\\sample_attest_enclave_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n print(\"\\nAttest SGX enclave using {}\".format(self.shared_url))\n async\
diff --git a/docs-ref-autogen/azure-servicebus/azure.servicebus.AutoLockRenewer.yml b/docs-ref-autogen/azure-servicebus/azure.servicebus.AutoLockRenewer.yml
index 4dfec3d3f514..c46787b3c30a 100644
--- a/docs-ref-autogen/azure-servicebus/azure.servicebus.AutoLockRenewer.yml
+++ b/docs-ref-autogen/azure-servicebus/azure.servicebus.AutoLockRenewer.yml
@@ -85,19 +85,20 @@ constructor:
examples:
- "Automatically renew a message lock<!--[!code-python[Main](les\\sync_samples\\sample_code_servicebus.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\206\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.servicebus\
- \ import AutoLockRenewer\n lock_renewal = AutoLockRenewer(max_workers=4)\n with\
- \ servicebus_receiver:\n for message in servicebus_receiver:\n #\
- \ Auto renew message for 1 minute.\n lock_renewal.register(servicebus_receiver,\
- \ message, max_lock_renewal_duration=60)\n process_message(message)\n\
- \ servicebus_receiver.complete_message(message)\n\n ````\n\nAutomatically\
- \ renew a session lock<!--[!code-python[Main](les\\sync_samples\\sample_code_servicebus.py\
- \ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\206\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\
+ \\samples\\\\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.servicebus import AutoLockRenewer\n\
+ \ lock_renewal = AutoLockRenewer(max_workers=4)\n with servicebus_receiver:\n\
+ \ for message in servicebus_receiver:\n # Auto renew message for\
+ \ 1 minute.\n lock_renewal.register(servicebus_receiver, message, max_lock_renewal_duration=60)\n\
+ \ process_message(message)\n servicebus_receiver.complete_message(message)\n\
+ \n ````\n\nAutomatically renew a session lock<!--[!code-python[Main](les\\sync_samples\\\
+ sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.servicebus\
\ import AutoLockRenewer\n\n lock_renewal = AutoLockRenewer(max_workers=4)\n\
diff --git a/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusClient.yml b/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusClient.yml
index f41ef1c276b0..47544943f285 100644
--- a/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusClient.yml
+++ b/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusClient.yml
@@ -132,15 +132,15 @@ variables:
examples:
- "Create a new instance of the ServiceBusClient.<!--[!code-python[Main](les\\sync_samples\\\
sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\\\
- sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n import os\n from azure.identity import\
- \ DefaultAzureCredential\n from azure.servicebus import ServiceBusClient\n fully_qualified_namespace\
- \ = os.environ['SERVICEBUS_FULLY_QUALIFIED_NAMESPACE']\n servicebus_client = ServiceBusClient(\n\
- \ fully_qualified_namespace=fully_qualified_namespace,\n credential=DefaultAzureCredential()\n\
- \ )\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
+ \ from azure.identity import DefaultAzureCredential\n from azure.servicebus\
+ \ import ServiceBusClient\n fully_qualified_namespace = os.environ['SERVICEBUS_FULLY_QUALIFIED_NAMESPACE']\n\
+ \ servicebus_client = ServiceBusClient(\n fully_qualified_namespace=fully_qualified_namespace,\n\
+ \ credential=DefaultAzureCredential()\n )\n\n ````\n"
methods:
- uid: azure.servicebus.ServiceBusClient.close
name: close
@@ -255,12 +255,13 @@ methods:
- "Create a new instance of the ServiceBusClient from connection string.<!--[!code-python[Main](les\\\
sync_samples\\sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\
- \\samples\\\\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.servicebus\
- \ import ServiceBusClient\n servicebus_connection_str = os.environ['SERVICEBUS_CONNECTION_STR']\n\
- \ servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.servicebus import ServiceBusClient\n\
+ \ servicebus_connection_str = os.environ['SERVICEBUS_CONNECTION_STR']\n servicebus_client\
+ \ = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)\n\
\n ````\n"
- uid: azure.servicebus.ServiceBusClient.get_queue_receiver
name: get_queue_receiver
@@ -391,12 +392,13 @@ methods:
- "Create a new instance of the ServiceBusReceiver from ServiceBusClient.<!--[!code-python[Main](les\\\
sync_samples\\sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\
- \\samples\\\\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.servicebus\
- \ import ServiceBusClient\n servicebus_connection_str = os.environ['SERVICEBUS_CONNECTION_STR']\n\
- \ queue_name = os.environ['SERVICEBUS_QUEUE_NAME']\n servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.servicebus import ServiceBusClient\n\
+ \ servicebus_connection_str = os.environ['SERVICEBUS_CONNECTION_STR']\n queue_name\
+ \ = os.environ['SERVICEBUS_QUEUE_NAME']\n servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)\n\
\ with servicebus_client:\n queue_receiver = servicebus_client.get_queue_receiver(queue_name=queue_name)\n\
\n ````\n"
- uid: azure.servicebus.ServiceBusClient.get_queue_sender
@@ -439,12 +441,13 @@ methods:
- "Create a new instance of the ServiceBusSender from ServiceBusClient.<!--[!code-python[Main](les\\\
sync_samples\\sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\
- \\samples\\\\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.servicebus\
- \ import ServiceBusClient\n servicebus_connection_str = os.environ['SERVICEBUS_CONNECTION_STR']\n\
- \ queue_name = os.environ['SERVICEBUS_QUEUE_NAME']\n servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.servicebus import ServiceBusClient\n\
+ \ servicebus_connection_str = os.environ['SERVICEBUS_CONNECTION_STR']\n queue_name\
+ \ = os.environ['SERVICEBUS_QUEUE_NAME']\n servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)\n\
\ with servicebus_client:\n queue_sender = servicebus_client.get_queue_sender(queue_name=queue_name)\n\
\n ````\n"
- uid: azure.servicebus.ServiceBusClient.get_subscription_receiver
@@ -584,13 +587,14 @@ methods:
- "Create a new instance of the ServiceBusReceiver from ServiceBusClient.<!--[!code-python[Main](les\\\
sync_samples\\sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\
- \\samples\\\\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.servicebus\
- \ import ServiceBusClient\n servicebus_connection_str = os.environ['SERVICEBUS_CONNECTION_STR']\n\
- \ topic_name = os.environ[\"SERVICEBUS_TOPIC_NAME\"]\n subscription_name =\
- \ os.environ[\"SERVICEBUS_SUBSCRIPTION_NAME\"]\n servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.servicebus import ServiceBusClient\n\
+ \ servicebus_connection_str = os.environ['SERVICEBUS_CONNECTION_STR']\n topic_name\
+ \ = os.environ[\"SERVICEBUS_TOPIC_NAME\"]\n subscription_name = os.environ[\"\
+ SERVICEBUS_SUBSCRIPTION_NAME\"]\n servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)\n\
\ with servicebus_client:\n subscription_receiver = servicebus_client.get_subscription_receiver(\n\
\ topic_name=topic_name,\n subscription_name=subscription_name,\n\
\ )\n\n ````\n"
@@ -634,11 +638,12 @@ methods:
- "Create a new instance of the ServiceBusSender from ServiceBusClient.<!--[!code-python[Main](les\\\
sync_samples\\sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\
- \\samples\\\\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.servicebus\
- \ import ServiceBusClient\n servicebus_connection_str = os.environ['SERVICEBUS_CONNECTION_STR']\n\
- \ topic_name = os.environ['SERVICEBUS_TOPIC_NAME']\n servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.servicebus import ServiceBusClient\n\
+ \ servicebus_connection_str = os.environ['SERVICEBUS_CONNECTION_STR']\n topic_name\
+ \ = os.environ['SERVICEBUS_TOPIC_NAME']\n servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)\n\
\ with servicebus_client:\n topic_sender = servicebus_client.get_topic_sender(topic_name=topic_name)\n\
\n ````\n"
diff --git a/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusMessage.yml b/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusMessage.yml
index ee153ac4ce5c..1fd176b6fd7e 100644
--- a/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusMessage.yml
+++ b/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusMessage.yml
@@ -78,12 +78,12 @@ constructor:
examples:
- "Sending a message with additional properties<!--[!code-python[Main](les\\sync_samples\\\
sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\\\
- sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n message = ServiceBusMessage(\n \"\
- Hello World!!\",\n session_id=\"MySessionID\",\n application_properties={'data':\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n message = ServiceBusMessage(\n\
+ \ \"Hello World!!\",\n session_id=\"MySessionID\",\n application_properties={'data':\
\ 'custom_data'},\n time_to_live=datetime.timedelta(seconds=30),\n label='MyLabel'\n\
\ )\n\n ````\n"
attributes:
diff --git a/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusReceivedMessage.yml b/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusReceivedMessage.yml
index 4a1fb5b89b21..089476a50300 100644
--- a/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusReceivedMessage.yml
+++ b/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusReceivedMessage.yml
@@ -26,22 +26,22 @@ variables:
examples:
- "Checking the properties on a received message.<!--[!code-python[Main](les\\sync_samples\\\
sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\\\
- sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n messages = servicebus_receiver.receive_messages(max_wait_time=5)\n\
- \ for message in messages:\n print(\"Receiving: {}\".format(message))\n\
- \ print(\"Time to live: {}\".format(message.time_to_live))\n \
- \ print(\"Sequence number: {}\".format(message.sequence_number))\n print(\"\
- Enqueued Sequence number: {}\".format(message.enqueued_sequence_number))\n \
- \ print(\"Partition Key: {}\".format(message.partition_key))\n print(\"\
- Application Properties: {}\".format(message.application_properties))\n \
- \ print(\"Delivery count: {}\".format(message.delivery_count))\n print(\"\
- Message ID: {}\".format(message.message_id))\n print(\"Locked until: {}\"\
- .format(message.locked_until_utc))\n print(\"Lock Token: {}\".format(message.lock_token))\n\
- \ print(\"Enqueued time: {}\".format(message.enqueued_time_utc))\n\n \
- \ ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n messages\
+ \ = servicebus_receiver.receive_messages(max_wait_time=5)\n for message in\
+ \ messages:\n print(\"Receiving: {}\".format(message))\n print(\"\
+ Time to live: {}\".format(message.time_to_live))\n print(\"Sequence number:\
+ \ {}\".format(message.sequence_number))\n print(\"Enqueued Sequence number:\
+ \ {}\".format(message.enqueued_sequence_number))\n print(\"Partition Key:\
+ \ {}\".format(message.partition_key))\n print(\"Application Properties:\
+ \ {}\".format(message.application_properties))\n print(\"Delivery count:\
+ \ {}\".format(message.delivery_count))\n print(\"Message ID: {}\".format(message.message_id))\n\
+ \ print(\"Locked until: {}\".format(message.locked_until_utc))\n \
+ \ print(\"Lock Token: {}\".format(message.lock_token))\n print(\"\
+ Enqueued time: {}\".format(message.enqueued_time_utc))\n\n ````\n"
attributes:
- uid: azure.servicebus.ServiceBusReceivedMessage.application_properties
name: application_properties
diff --git a/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusReceiver.yml b/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusReceiver.yml
index e9b9d93f701f..00201f373a8e 100644
--- a/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusReceiver.yml
+++ b/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusReceiver.yml
@@ -206,8 +206,9 @@ methods:
examples:
- "Abandon a received message.<!--[!code-python[Main](les\\sync_samples\\sample_code_servicebus.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n messages = servicebus_receiver.receive_messages(max_wait_time=5)\n \
@@ -241,8 +242,9 @@ methods:
examples:
- "Complete a received message.<!--[!code-python[Main](les\\sync_samples\\sample_code_servicebus.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n messages = servicebus_receiver.receive_messages(max_wait_time=5)\n \
@@ -290,8 +292,9 @@ methods:
examples:
- "Dead letter a received message.<!--[!code-python[Main](les\\sync_samples\\sample_code_servicebus.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n messages = servicebus_receiver.receive_messages(max_wait_time=5)\n \
@@ -324,8 +327,9 @@ methods:
examples:
- "Defer a received message.<!--[!code-python[Main](les\\sync_samples\\sample_code_servicebus.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n messages = servicebus_receiver.receive_messages(max_wait_time=5)\n \
@@ -371,13 +375,14 @@ methods:
examples:
- "Look at pending messages in the queue.<!--[!code-python[Main](les\\sync_samples\\\
sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\
- \\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n with servicebus_receiver:\n\
- \ messages = servicebus_receiver.peek_messages()\n for message in\
- \ messages:\n print(str(message))\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n with servicebus_receiver:\n messages =\
+ \ servicebus_receiver.peek_messages()\n for message in messages:\n \
+ \ print(str(message))\n\n ````\n"
- uid: azure.servicebus.ServiceBusReceiver.receive_deferred_messages
name: receive_deferred_messages
summary: 'Receive messages that have previously been deferred.
@@ -411,12 +416,13 @@ methods:
examples:
- "Receive deferred messages from ServiceBus.<!--[!code-python[Main](les\\sync_samples\\\
sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\
- \\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n with servicebus_receiver:\n\
- \ deferred_sequenced_numbers = []\n messages = servicebus_receiver.receive_messages(max_wait_time=5)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n with servicebus_receiver:\n deferred_sequenced_numbers\
+ \ = []\n messages = servicebus_receiver.receive_messages(max_wait_time=5)\n\
\ for message in messages:\n deferred_sequenced_numbers.append(message.sequence_number)\n\
\ print(str(message))\n servicebus_receiver.defer_message(message)\n\
\n received_deferred_msg = servicebus_receiver.receive_deferred_messages(\n\
@@ -483,13 +489,14 @@ methods:
examples:
- "Receive messages from ServiceBus.<!--[!code-python[Main](les\\sync_samples\\\
sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\
- \\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n with servicebus_receiver:\n\
- \ messages = servicebus_receiver.receive_messages(max_wait_time=5)\n \
- \ for message in messages:\n print(str(message))\n servicebus_receiver.complete_message(message)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n with servicebus_receiver:\n messages =\
+ \ servicebus_receiver.receive_messages(max_wait_time=5)\n for message in\
+ \ messages:\n print(str(message))\n servicebus_receiver.complete_message(message)\n\
\n ````\n"
- uid: azure.servicebus.ServiceBusReceiver.renew_message_lock
name: renew_message_lock
@@ -539,11 +546,12 @@ methods:
examples:
- "Renew the lock on a received message.<!--[!code-python[Main](les\\sync_samples\\\
sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\
- \\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n messages = servicebus_receiver.receive_messages(max_wait_time=5)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n messages = servicebus_receiver.receive_messages(max_wait_time=5)\n\
\ for message in messages:\n servicebus_receiver.renew_message_lock(message)\n\
\n ````\n"
attributes:
@@ -566,8 +574,9 @@ attributes:
examples:
- "Get session from a receiver<!--[!code-python[Main](les\\sync_samples\\sample_code_servicebus.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n with servicebus_client.get_queue_receiver(queue_name=queue_name, session_id=session_id)\
diff --git a/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusSender.yml b/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusSender.yml
index e98bf1c03330..4e833dd5cfcb 100644
--- a/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusSender.yml
+++ b/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusSender.yml
@@ -138,11 +138,12 @@ methods:
- "Cancelling messages scheduled to be sent in future<!--[!code-python[Main](les\\\
sync_samples\\sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\
- \\samples\\\\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n with servicebus_sender:\n \
- \ servicebus_sender.cancel_scheduled_messages(sequence_nums)\n\n ````\n"
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n with servicebus_sender:\n servicebus_sender.cancel_scheduled_messages(sequence_nums)\n\
+ \n ````\n"
- uid: azure.servicebus.ServiceBusSender.close
name: close
summary: 'Close down the handler links (and connection if the handler uses a separate
@@ -179,11 +180,12 @@ methods:
- "Create ServiceBusMessageBatch object within limited size<!--[!code-python[Main](les\\\
sync_samples\\sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\
- \\samples\\\\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n with servicebus_sender:\n \
- \ batch_message = servicebus_sender.create_message_batch()\n batch_message.add_message(ServiceBusMessage(\"\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n with servicebus_sender:\n batch_message\
+ \ = servicebus_sender.create_message_batch()\n batch_message.add_message(ServiceBusMessage(\"\
Single message inside batch\"))\n\n ````\n"
- uid: azure.servicebus.ServiceBusSender.schedule_messages
name: schedule_messages
@@ -219,15 +221,16 @@ methods:
examples:
- "Schedule a message to be sent in future<!--[!code-python[Main](les\\sync_samples\\\
sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\
- \\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n with servicebus_sender:\n \
- \ scheduled_time_utc = datetime.datetime.utcnow() + datetime.timedelta(seconds=30)\n\
- \ scheduled_messages = [ServiceBusMessage(\"Scheduled message\") for _ in\
- \ range(10)]\n sequence_nums = servicebus_sender.schedule_messages(scheduled_messages,\
- \ scheduled_time_utc)\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n with servicebus_sender:\n scheduled_time_utc\
+ \ = datetime.datetime.utcnow() + datetime.timedelta(seconds=30)\n scheduled_messages\
+ \ = [ServiceBusMessage(\"Scheduled message\") for _ in range(10)]\n sequence_nums\
+ \ = servicebus_sender.schedule_messages(scheduled_messages, scheduled_time_utc)\n\
+ \n ````\n"
- uid: azure.servicebus.ServiceBusSender.send_messages
name: send_messages
summary: 'Sends message and blocks until acknowledgement is received or operation
@@ -263,8 +266,9 @@ methods:
examples:
- "Send message.<!--[!code-python[Main](les\\sync_samples\\sample_code_servicebus.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n with servicebus_sender:\n message = ServiceBusMessage(\"Hello World\"\
diff --git a/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusSession.yml b/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusSession.yml
index 7db8e9a8ba11..7887c6cca011 100644
--- a/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusSession.yml
+++ b/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusSession.yml
@@ -28,10 +28,11 @@ variables:
examples:
- "Get session from a receiver<!--[!code-python[Main](les\\sync_samples\\sample_code_servicebus.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\206\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n with servicebus_client.get_queue_receiver(queue_name=queue_name,\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\
+ \\samples\\\\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n with servicebus_client.get_queue_receiver(queue_name=queue_name,\
\ session_id=session_id) as receiver:\n session = receiver.session\n\n\
\ ````\n"
methods:
@@ -57,8 +58,9 @@ methods:
examples:
- "Get the session state<!--[!code-python[Main](les\\sync_samples\\sample_code_servicebus.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n with servicebus_client.get_queue_receiver(queue_name=queue_name, session_id=session_id)\
@@ -98,11 +100,12 @@ methods:
examples:
- "Renew the session lock before it expires<!--[!code-python[Main](les\\sync_samples\\\
sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\
- \\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n with servicebus_client.get_queue_receiver(queue_name=queue_name,\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n with servicebus_client.get_queue_receiver(queue_name=queue_name,\
\ session_id=session_id) as receiver:\n session = receiver.session\n\
\ session.renew_lock()\n\n ````\n"
- uid: azure.servicebus.ServiceBusSession.set_state
@@ -130,8 +133,9 @@ methods:
examples:
- "Set the session state<!--[!code-python[Main](les\\sync_samples\\sample_code_servicebus.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 205\\\\azure-servicebus-7.11.2\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n with servicebus_client.get_queue_receiver(queue_name=queue_name, session_id=session_id)\
diff --git a/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.AutoLockRenewer.yml b/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.AutoLockRenewer.yml
index eefe7c6690bd..f758129aeb63 100644
--- a/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.AutoLockRenewer.yml
+++ b/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.AutoLockRenewer.yml
@@ -36,21 +36,22 @@ constructor:
examples:
- "Automatically renew a message lock<!--[!code-python[Main](les\\async_samples\\\
sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\\\
- async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.servicebus.aio import\
- \ AutoLockRenewer\n\n lock_renewal = AutoLockRenewer()\n async with servicebus_receiver:\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\205\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.servicebus.aio\
+ \ import AutoLockRenewer\n\n lock_renewal = AutoLockRenewer()\n async with servicebus_receiver:\n\
\ async for message in servicebus_receiver:\n lock_renewal.register(servicebus_receiver,\
\ message, max_lock_renewal_duration=60)\n await process_message(message)\n\
\ await servicebus_receiver.complete_message(message)\n\n ````\n\nAutomatically\
\ renew a session lock<!--[!code-python[Main](les\\async_samples\\sample_code_servicebus_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\206\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.servicebus.aio\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\
+ \\samples\\\\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\":\
+ \ \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
+ \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.servicebus.aio\
\ import AutoLockRenewer\n\n lock_renewal = AutoLockRenewer()\n async\
\ with servicebus_client.get_queue_receiver(queue_name=queue_name, session_id=session_id)\
\ as receiver:\n session = receiver.session\n # Auto renew session\
diff --git a/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusClient.yml b/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusClient.yml
index 52073b4bdf77..b694a4666a77 100644
--- a/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusClient.yml
+++ b/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusClient.yml
@@ -132,13 +132,13 @@ variables:
examples:
- "Create a new instance of the ServiceBusClient.<!--[!code-python[Main](les\\async_samples\\\
sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\\\
- async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.identity.aio\
- \ import DefaultAzureCredential\n from azure.servicebus.aio import ServiceBusClient\n\
- \ fully_qualified_namespace = os.environ['SERVICEBUS_FULLY_QUALIFIED_NAMESPACE']\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\205\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
+ \ from azure.identity.aio import DefaultAzureCredential\n from azure.servicebus.aio\
+ \ import ServiceBusClient\n fully_qualified_namespace = os.environ['SERVICEBUS_FULLY_QUALIFIED_NAMESPACE']\n\
\ servicebus_client = ServiceBusClient(\n fully_qualified_namespace=fully_qualified_namespace,\n\
\ credential=DefaultAzureCredential()\n )\n\n ````\n"
methods:
@@ -255,7 +255,8 @@ methods:
- "Create a new instance of the ServiceBusClient from connection string.<!--[!code-python[Main](les\\\
async_samples\\sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\
\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -393,7 +394,8 @@ methods:
- "Create a new instance of the ServiceBusSender from ServiceBusClient.<!--[!code-python[Main](les\\\
async_samples\\sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\
\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -442,7 +444,8 @@ methods:
- "Create a new instance of the ServiceBusClient from connection string.<!--[!code-python[Main](les\\\
async_samples\\sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\
\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -590,7 +593,8 @@ methods:
- "Create a new instance of the ServiceBusReceiver from ServiceBusClient.<!--[!code-python[Main](les\\\
async_samples\\sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\
\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -641,7 +645,8 @@ methods:
- "Create a new instance of the ServiceBusSender from ServiceBusClient.<!--[!code-python[Main](les\\\
async_samples\\sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\
\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
diff --git a/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusReceiver.yml b/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusReceiver.yml
index 7f9d6eeac5f7..5ff657b86799 100644
--- a/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusReceiver.yml
+++ b/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusReceiver.yml
@@ -207,11 +207,12 @@ methods:
examples:
- "Abandon a received message.<!--[!code-python[Main](les\\async_samples\\sample_code_servicebus_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\\\
- sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 205\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
\ for message in messages:\n await servicebus_receiver.abandon_message(message)\n\
\n ````\n"
- uid: azure.servicebus.aio.ServiceBusReceiver.close
@@ -242,11 +243,12 @@ methods:
examples:
- "Complete a received message.<!--[!code-python[Main](les\\async_samples\\sample_code_servicebus_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\\\
- sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 205\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
\ for message in messages:\n await servicebus_receiver.complete_message(message)\n\
\n ````\n"
- uid: azure.servicebus.aio.ServiceBusReceiver.dead_letter_message
@@ -291,11 +293,12 @@ methods:
examples:
- "Dead letter a received message.<!--[!code-python[Main](les\\async_samples\\sample_code_servicebus_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\\\
- sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 205\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
\ for message in messages:\n await servicebus_receiver.dead_letter_message(message)\n\
\n ````\n"
- uid: azure.servicebus.aio.ServiceBusReceiver.defer_message
@@ -325,11 +328,12 @@ methods:
examples:
- "Defer a received message.<!--[!code-python[Main](les\\async_samples\\sample_code_servicebus_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\\\
- sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 205\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
\ for message in messages:\n await servicebus_receiver.defer_message(message)\n\
\n ````\n"
- uid: azure.servicebus.aio.ServiceBusReceiver.peek_messages
@@ -369,13 +373,13 @@ methods:
examples:
- "Peek messages in the queue.<!--[!code-python[Main](les\\async_samples\\sample_code_servicebus_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\\\
- sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n async with servicebus_receiver:\n messages\
- \ = await servicebus_receiver.peek_messages()\n for message in messages:\n\
- \ print(str(message))\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 205\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n async with servicebus_receiver:\n messages = await servicebus_receiver.peek_messages()\n\
+ \ for message in messages:\n print(str(message))\n\n ````\n"
- uid: azure.servicebus.aio.ServiceBusReceiver.receive_deferred_messages
name: receive_deferred_messages
summary: 'Receive messages that have previously been deferred.
@@ -408,12 +412,13 @@ methods:
examples:
- "Receive deferred messages from ServiceBus.<!--[!code-python[Main](les\\async_samples\\\
sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\
- \\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n async with servicebus_receiver:\n\
- \ deferred_sequenced_numbers = []\n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\
+ \\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n async with servicebus_receiver:\n deferred_sequenced_numbers\
+ \ = []\n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
\ for message in messages:\n deferred_sequenced_numbers.append(message.sequence_number)\n\
\ print(str(message))\n await servicebus_receiver.defer_message(message)\n\
\n received_deferred_msg = await servicebus_receiver.receive_deferred_messages(\n\
@@ -481,14 +486,15 @@ methods:
examples:
- "Receive messages from ServiceBus.<!--[!code-python[Main](les\\async_samples\\\
sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\
- \\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n async with servicebus_receiver:\n\
- \ messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
- \ for message in messages:\n print(str(message))\n await\
- \ servicebus_receiver.complete_message(message)\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\
+ \\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n async with servicebus_receiver:\n messages\
+ \ = await servicebus_receiver.receive_messages(max_wait_time=5)\n for message\
+ \ in messages:\n print(str(message))\n await servicebus_receiver.complete_message(message)\n\
+ \n ````\n"
- uid: azure.servicebus.aio.ServiceBusReceiver.renew_message_lock
name: renew_message_lock
summary: 'Renew the message lock.
@@ -537,11 +543,12 @@ methods:
examples:
- "Renew the lock on a received message.<!--[!code-python[Main](les\\async_samples\\\
sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\
- \\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\
+ \\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
\ for message in messages:\n await servicebus_receiver.renew_message_lock(message)\n\
\n ````\n"
attributes:
@@ -564,10 +571,11 @@ attributes:
examples:
- "Get session from a receiver<!--[!code-python[Main](les\\async_samples\\sample_code_servicebus_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\\\
- sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n async with servicebus_client.get_queue_receiver(queue_name=queue_name,\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 205\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n async with servicebus_client.get_queue_receiver(queue_name=queue_name,\
\ session_id=session_id) as receiver:\n session = receiver.session\n\
\n ````\n"
diff --git a/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusSender.yml b/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusSender.yml
index 2bdabd609085..d53036d7757a 100644
--- a/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusSender.yml
+++ b/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusSender.yml
@@ -142,7 +142,8 @@ methods:
- "Cancelling messages scheduled to be sent in future<!--[!code-python[Main](les\\\
async_samples\\sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\
\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n async with\
@@ -188,7 +189,8 @@ methods:
- "Create ServiceBusMessageBatch object within limited size<!--[!code-python[Main](les\\\
async_samples\\sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\
\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n async with\
@@ -232,15 +234,16 @@ methods:
examples:
- "Schedule a message to be sent in future<!--[!code-python[Main](les\\async_samples\\\
sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\
- \\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n async with servicebus_sender:\n\
- \ scheduled_time_utc = datetime.datetime.utcnow() + datetime.timedelta(seconds=30)\n\
- \ scheduled_messages = [ServiceBusMessage(\"Scheduled message\") for _ in\
- \ range(10)]\n sequence_nums = await servicebus_sender.schedule_messages(scheduled_messages,\
- \ scheduled_time_utc)\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\
+ \\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n async with servicebus_sender:\n scheduled_time_utc\
+ \ = datetime.datetime.utcnow() + datetime.timedelta(seconds=30)\n scheduled_messages\
+ \ = [ServiceBusMessage(\"Scheduled message\") for _ in range(10)]\n sequence_nums\
+ \ = await servicebus_sender.schedule_messages(scheduled_messages, scheduled_time_utc)\n\
+ \n ````\n"
- uid: azure.servicebus.aio.ServiceBusSender.send_messages
name: send_messages
summary: 'Sends message and blocks until acknowledgement is received or operation
@@ -277,13 +280,13 @@ methods:
examples:
- "Send message.<!--[!code-python[Main](les\\async_samples\\sample_code_servicebus_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\\\
- sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n async with servicebus_sender:\n message\
- \ = ServiceBusMessage(\"Hello World\")\n await servicebus_sender.send_messages(message)\n\
- \n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 205\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n async with servicebus_sender:\n message = ServiceBusMessage(\"Hello\
+ \ World\")\n await servicebus_sender.send_messages(message)\n\n ````\n"
attributes:
- uid: azure.servicebus.aio.ServiceBusSender.client_identifier
name: client_identifier
diff --git a/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusSession.yml b/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusSession.yml
index 0cbaf32d2d73..68f794d08ab7 100644
--- a/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusSession.yml
+++ b/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusSession.yml
@@ -21,10 +21,11 @@ constructor:
examples:
- "Get session from a receiver<!--[!code-python[Main](les\\async_samples\\sample_code_servicebus_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\206\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n async with\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\
+ \\samples\\\\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\":\
+ \ \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
+ \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n async with\
\ servicebus_client.get_queue_receiver(queue_name=queue_name, session_id=session_id)\
\ as receiver:\n session = receiver.session\n\n ````\n"
methods:
@@ -50,11 +51,12 @@ methods:
examples:
- "Get the session state<!--[!code-python[Main](les\\async_samples\\sample_code_servicebus_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\\\
- sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n async with servicebus_client.get_queue_receiver(queue_name=queue_name,\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 205\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n async with servicebus_client.get_queue_receiver(queue_name=queue_name,\
\ session_id=session_id) as receiver:\n session = receiver.session\n\
\ session_state = await session.get_state()\n\n ````\n"
- uid: azure.servicebus.aio.ServiceBusSession.renew_lock
@@ -92,11 +94,12 @@ methods:
examples:
- "Renew the session lock before it expires<!--[!code-python[Main](les\\async_samples\\\
sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\
- \\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n async with servicebus_client.get_queue_receiver(queue_name=queue_name,\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\205\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\
+ \\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n async with servicebus_client.get_queue_receiver(queue_name=queue_name,\
\ session_id=session_id) as receiver:\n session = receiver.session\n\
\ await session.renew_lock()\n\n ````\n"
- uid: azure.servicebus.aio.ServiceBusSession.set_state
@@ -128,11 +131,12 @@ methods:
examples:
- "Set the session state<!--[!code-python[Main](les\\async_samples\\sample_code_servicebus_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\206\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\\\
- sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n async with servicebus_client.get_queue_receiver(queue_name=queue_name,\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 205\\\\azure-servicebus-7.11.2\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n async with servicebus_client.get_queue_receiver(queue_name=queue_name,\
\ session_id=session_id) as receiver:\n session = receiver.session\n\
\ await session.set_state(\"START\")\n\n ````\n"
attributes:
diff --git a/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.DataLakeDirectoryClient.yml b/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.DataLakeDirectoryClient.yml
index 10bf66059911..f2abccc63f40 100644
--- a/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.DataLakeDirectoryClient.yml
+++ b/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.DataLakeDirectoryClient.yml
@@ -82,11 +82,12 @@ examples:
- "Creating the DataLakeServiceClient from connection string.<!--[!code-python[Main](les\\\
datalake_samples_instantiate_client.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_instantiate_client.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.storage.filedatalake\
- \ import DataLakeDirectoryClient\n DataLakeDirectoryClient.from_connection_string(connection_string,\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_instantiate_client.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.storage.filedatalake import\
+ \ DataLakeDirectoryClient\n DataLakeDirectoryClient.from_connection_string(connection_string,\
\ \"myfilesystem\", \"mydirectory\")\n\n ````\n"
methods:
- uid: azure.storage.filedatalake.DataLakeDirectoryClient.acquire_lease
@@ -330,11 +331,12 @@ methods:
examples:
- "Create directory.<!--[!code-python[Main](les\\datalake_samples_directory.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_directory.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n directory_client.create_directory()\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\
+ \\samples\\\\datalake_samples_directory.py\", \"xml:space\": \"preserve\", \"\
+ force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n directory_client.create_directory()\n\
+ \n ````\n"
- uid: azure.storage.filedatalake.DataLakeDirectoryClient.create_file
name: create_file
summary: Create a new file and return the file client to be interacted with.
@@ -728,11 +730,12 @@ methods:
examples:
- "Delete directory.<!--[!code-python[Main](les\\datalake_samples_directory.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_directory.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n new_directory.delete_directory()\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\
+ \\samples\\\\datalake_samples_directory.py\", \"xml:space\": \"preserve\", \"\
+ force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n new_directory.delete_directory()\n\
+ \n ````\n"
- uid: azure.storage.filedatalake.DataLakeDirectoryClient.delete_sub_directory
name: delete_sub_directory
summary: Marks the specified subdirectory for deletion.
@@ -1054,8 +1057,9 @@ methods:
examples:
- "Getting the properties for a file/directory.<!--[!code-python[Main](les\\datalake_samples_directory.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_directory.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_directory.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n props = new_directory.get_directory_properties()\n\n ````\n"
@@ -1306,8 +1310,9 @@ methods:
examples:
- "Rename the source directory.<!--[!code-python[Main](les\\datalake_samples_directory.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_directory.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_directory.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n new_dir_name = \"testdir2\"\n print(\"Renaming the directory named '{}'\
diff --git a/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.DataLakeFileClient.yml b/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.DataLakeFileClient.yml
index 2c87c4a40ec4..ea3ff66ff8ae 100644
--- a/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.DataLakeFileClient.yml
+++ b/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.DataLakeFileClient.yml
@@ -76,11 +76,12 @@ examples:
- "Creating the DataLakeServiceClient from connection string.<!--[!code-python[Main](les\\\
datalake_samples_instantiate_client.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_instantiate_client.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.storage.filedatalake\
- \ import DataLakeFileClient\n DataLakeFileClient.from_connection_string(connection_string,\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_instantiate_client.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.storage.filedatalake import\
+ \ DataLakeFileClient\n DataLakeFileClient.from_connection_string(connection_string,\
\ \"myfilesystem\", \"mydirectory\", \"myfile\")\n\n ````\n"
methods:
- uid: azure.storage.filedatalake.DataLakeFileClient.acquire_lease
@@ -248,8 +249,9 @@ methods:
examples:
- "Append data to the file.<!--[!code-python[Main](les\\datalake_samples_upload_download.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n file_client.append_data(data=file_content[2048:3072], offset=2048, length=1024)\n\
@@ -432,8 +434,9 @@ methods:
examples:
- "Create file.<!--[!code-python[Main](les\\datalake_samples_upload_download.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n file_client = filesystem_client.get_file_client(file_name)\n file_client.create_file()\n\
@@ -503,8 +506,9 @@ methods:
examples:
- "Delete file.<!--[!code-python[Main](les\\datalake_samples_upload_download.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n new_client.delete_file()\n\n ````\n"
@@ -611,8 +615,9 @@ methods:
examples:
- "Return the downloaded data.<!--[!code-python[Main](les\\datalake_samples_upload_download.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n download = file_client.download_file()\n downloaded_bytes = download.readall()\n\
@@ -785,8 +790,9 @@ methods:
examples:
- "Commit the previous appended data.<!--[!code-python[Main](les\\datalake_samples_file_system.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n with open(SOURCE_FILE, \"rb\") as data:\n file_client = file_system_client.get_file_client(\"\
@@ -999,8 +1005,9 @@ methods:
examples:
- "Getting the properties for a file.<!--[!code-python[Main](les\\datalake_samples_upload_download.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n properties = file_client.get_file_properties()\n\n ````\n"
@@ -1130,12 +1137,13 @@ methods:
examples:
- "select/project on datalake file data by providing simple query expressions.<!--[!code-python[Main](les\\\
datalake_samples_query.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_query.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n errors = []\n def on_error(error):\n\
- \ errors.append(error)\n\n # upload the csv file\n file_client = datalake_service_client.get_file_client(filesystem_name,\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_query.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n errors = []\n def on_error(error):\n \
+ \ errors.append(error)\n\n # upload the csv file\n file_client = datalake_service_client.get_file_client(filesystem_name,\
\ \"csvfile\")\n file_client.upload_data(CSV_DATA, overwrite=True)\n\n # select\
\ the second column of the csv file\n query_expression = \"SELECT _2 from DataLakeStorage\"\
\n input_format = DelimitedTextDialect(delimiter=',', quotechar='\"', lineterminator='\\\
@@ -1348,8 +1356,9 @@ methods:
examples:
- "Rename the source file.<!--[!code-python[Main](les\\datalake_samples_upload_download.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n new_client = file_client.rename_file(file_client.file_system_name + '/' +\
diff --git a/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.DataLakeServiceClient.yml b/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.DataLakeServiceClient.yml
index ff6035d17713..b22895d4e410 100644
--- a/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.DataLakeServiceClient.yml
+++ b/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.DataLakeServiceClient.yml
@@ -77,24 +77,25 @@ variables:
examples:
- "Creating the DataLakeServiceClient from connection string.<!--[!code-python[Main](les\\\
datalake_samples_service.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_service.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.storage.filedatalake import\
- \ DataLakeServiceClient\n datalake_service_client = DataLakeServiceClient.from_connection_string(self.connection_string)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_service.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.storage.filedatalake\
+ \ import DataLakeServiceClient\n datalake_service_client = DataLakeServiceClient.from_connection_string(self.connection_string)\n\
\n ````\n\nCreating the DataLakeServiceClient with Azure Identity credentials.<!--[!code-python[Main](les\\\
datalake_samples_service.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_service.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.identity import ClientSecretCredential\n\
- \ token_credential = ClientSecretCredential(\n self.active_directory_tenant_id,\n\
- \ self.active_directory_application_id,\n self.active_directory_application_secret,\n\
- \ )\n datalake_service_client = DataLakeServiceClient(\"https://{}.dfs.core.windows.net\"\
- .format(self.account_name),\n \
- \ credential=token_credential)\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_service.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
+ \ import ClientSecretCredential\n token_credential = ClientSecretCredential(\n\
+ \ self.active_directory_tenant_id,\n self.active_directory_application_id,\n\
+ \ self.active_directory_application_secret,\n )\n datalake_service_client\
+ \ = DataLakeServiceClient(\"https://{}.dfs.core.windows.net\".format(self.account_name),\n\
+ \ credential=token_credential)\n\
+ \n ````\n"
methods:
- uid: azure.storage.filedatalake.DataLakeServiceClient.close
name: close
@@ -162,11 +163,12 @@ methods:
examples:
- "Creating a file system in the datalake service.<!--[!code-python[Main](les\\\
datalake_samples_service.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_service.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n datalake_service_client.create_file_system(\"\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_service.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n datalake_service_client.create_file_system(\"\
filesystem\")\n\n ````\n"
- uid: azure.storage.filedatalake.DataLakeServiceClient.delete_file_system
name: delete_file_system
@@ -251,11 +253,12 @@ methods:
examples:
- "Deleting a file system in the datalake service.<!--[!code-python[Main](les\\\
datalake_samples_service.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_service.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n datalake_service_client.delete_file_system(\"\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_service.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n datalake_service_client.delete_file_system(\"\
filesystem\")\n\n ````\n"
- uid: azure.storage.filedatalake.DataLakeServiceClient.from_connection_string
name: from_connection_string
@@ -293,12 +296,13 @@ methods:
examples:
- "Creating the DataLakeServiceClient from a connection string.<!--[!code-python[Main](les\\\
datalake_samples_file_system.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_file_system.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.storage.filedatalake\
- \ import DataLakeServiceClient\n datalake_service_client = DataLakeServiceClient.from_connection_string(self.connection_string)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_file_system.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.storage.filedatalake import DataLakeServiceClient\n\
+ \ datalake_service_client = DataLakeServiceClient.from_connection_string(self.connection_string)\n\
\n ````\n"
- uid: azure.storage.filedatalake.DataLakeServiceClient.get_directory_client
name: get_directory_client
@@ -334,11 +338,12 @@ methods:
examples:
- "Getting the directory client to interact with a specific directory.<!--[!code-python[Main](les\\\
datalake_samples_service.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_service.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n directory_client = datalake_service_client.get_directory_client(file_system_client.file_system_name,\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_service.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n directory_client = datalake_service_client.get_directory_client(file_system_client.file_system_name,\n\
\ \"mydirectory\"\
)\n\n ````\n"
- uid: azure.storage.filedatalake.DataLakeServiceClient.get_file_client
@@ -375,11 +380,12 @@ methods:
examples:
- "Getting the file client to interact with a specific file.<!--[!code-python[Main](les\\\
datalake_samples_service.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_service.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n file_client = datalake_service_client.get_file_client(file_system_client.file_system_name,\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_service.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n file_client = datalake_service_client.get_file_client(file_system_client.file_system_name,\
\ \"myfile\")\n\n ````\n"
- uid: azure.storage.filedatalake.DataLakeServiceClient.get_file_system_client
name: get_file_system_client
@@ -404,12 +410,13 @@ methods:
examples:
- "Getting the file system client to interact with a specific file system.<!--[!code-python[Main](les\\\
datalake_samples_file_system.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_file_system.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n # Instantiate a DataLakeServiceClient\
- \ using a connection string\n from azure.storage.filedatalake import DataLakeServiceClient\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_file_system.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n # Instantiate a DataLakeServiceClient using a\
+ \ connection string\n from azure.storage.filedatalake import DataLakeServiceClient\n\
\ datalake_service_client = DataLakeServiceClient.from_connection_string(self.connection_string)\n\
\n # Instantiate a FileSystemClient\n file_system_client = datalake_service_client.get_file_system_client(\"\
mynewfilesystem\")\n\n ````\n"
@@ -478,12 +485,13 @@ methods:
examples:
- "Get user delegation key from datalake service client.<!--[!code-python[Main](les\\\
datalake_samples_service.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_service.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from datetime import datetime, timedelta\n\
- \ user_delegation_key = datalake_service_client.get_user_delegation_key(datetime.utcnow(),\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_service.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from datetime import datetime, timedelta\n \
+ \ user_delegation_key = datalake_service_client.get_user_delegation_key(datetime.utcnow(),\n\
\ datetime.utcnow()\
\ + timedelta(hours=1))\n\n ````\n"
- uid: azure.storage.filedatalake.DataLakeServiceClient.list_file_systems
@@ -552,11 +560,12 @@ methods:
examples:
- "Listing the file systems in the datalake service.<!--[!code-python[Main](les\\\
datalake_samples_service.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_service.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n file_systems = datalake_service_client.list_file_systems()\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_service.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n file_systems = datalake_service_client.list_file_systems()\n\
\ for file_system in file_systems:\n print(file_system.name)\n\n ````\n"
- uid: azure.storage.filedatalake.DataLakeServiceClient.set_service_properties
name: set_service_properties
diff --git a/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.FileSystemClient.yml b/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.FileSystemClient.yml
index dd1ab9cbdc15..1b321049ae08 100644
--- a/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.FileSystemClient.yml
+++ b/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.FileSystemClient.yml
@@ -76,13 +76,13 @@ variables:
examples:
- "Get a FileSystemClient from an existing DataLakeServiceClient.<!--[!code-python[Main](les\\\
datalake_samples_file_system.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_file_system.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\":\
- \ 1}, \"linenos\": false} -->\n\n````python\n\n # Instantiate a DataLakeServiceClient\
- \ using a connection string\n from azure.storage.filedatalake import DataLakeServiceClient\n\
- \ datalake_service_client = DataLakeServiceClient.from_connection_string(self.connection_string)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # Instantiate\
+ \ a DataLakeServiceClient using a connection string\n from azure.storage.filedatalake\
+ \ import DataLakeServiceClient\n datalake_service_client = DataLakeServiceClient.from_connection_string(self.connection_string)\n\
\n # Instantiate a FileSystemClient\n file_system_client = datalake_service_client.get_file_system_client(\"\
mynewfilesystem\")\n\n ````\n"
methods:
@@ -169,8 +169,9 @@ methods:
examples:
- "Acquiring a lease on the file system.<!--[!code-python[Main](les\\datalake_samples_file_system.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Acquire a lease on the file system\n lease = file_system_client.acquire_lease()\n\
@@ -337,8 +338,9 @@ methods:
examples:
- "Create directory in the file system.<!--[!code-python[Main](les\\datalake_samples_file_system.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n directory_client = file_system_client.create_directory(\"mydirectory\")\n\
@@ -513,8 +515,9 @@ methods:
examples:
- "Create file in the file system.<!--[!code-python[Main](les\\datalake_samples_file_system.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n file_client = file_system_client.create_file(\"myfile\")\n\n ````\n"
@@ -574,12 +577,13 @@ methods:
examples:
- "Creating a file system in the datalake service.<!--[!code-python[Main](les\\\
datalake_samples_file_system.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_file_system.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n file_system_client.create_file_system()\n\
- \n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_file_system.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n file_system_client.create_file_system()\n\n \
+ \ ````\n"
- uid: azure.storage.filedatalake.FileSystemClient.delete_directory
name: delete_directory
summary: Marks the specified path for deletion.
@@ -655,8 +659,9 @@ methods:
examples:
- "Delete directory in the file system.<!--[!code-python[Main](les\\datalake_samples_file_system.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n file_system_client.delete_directory(\"mydirectory\")\n\n ````\n"
@@ -734,8 +739,9 @@ methods:
examples:
- "Delete file in the file system.<!--[!code-python[Main](les\\datalake_samples_file_system.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n file_system_client.delete_file(\"myfile\")\n\n ````\n"
@@ -812,12 +818,13 @@ methods:
examples:
- "Deleting a file system in the datalake service.<!--[!code-python[Main](les\\\
datalake_samples_file_system.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_file_system.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n file_system_client.delete_file_system()\n\
- \n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_file_system.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n file_system_client.delete_file_system()\n\n \
+ \ ````\n"
- uid: azure.storage.filedatalake.FileSystemClient.exists
name: exists
summary: Returns True if a file system exists and returns False otherwise.
@@ -885,8 +892,9 @@ methods:
examples:
- "Create FileSystemClient from connection string<!--[!code-python[Main](les\\datalake_samples_file_system.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.storage.filedatalake import FileSystemClient\n file_system_client\
@@ -916,13 +924,14 @@ methods:
examples:
- "Getting the directory client to interact with a specific directory.<!--[!code-python[Main](les\\\
datalake_samples_file_system.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_file_system.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n # Get the DataLakeDirectoryClient\
- \ from the FileSystemClient to interact with a specific file\n directory_client\
- \ = file_system_client.get_directory_client(\"mynewdirectory\")\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_file_system.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n # Get the DataLakeDirectoryClient from the FileSystemClient\
+ \ to interact with a specific file\n directory_client = file_system_client.get_directory_client(\"\
+ mynewdirectory\")\n\n ````\n"
- uid: azure.storage.filedatalake.FileSystemClient.get_file_client
name: get_file_client
summary: 'Get a client to interact with the specified file.
@@ -947,12 +956,13 @@ methods:
examples:
- "Getting the file client to interact with a specific file.<!--[!code-python[Main](les\\\
datalake_samples_file_system.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_file_system.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n # Get the FileClient from the\
- \ FileSystemClient to interact with a specific file\n file_client = file_system_client.get_file_client(\"\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_file_system.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n # Get the FileClient from the FileSystemClient\
+ \ to interact with a specific file\n file_client = file_system_client.get_file_client(\"\
mynewfile\")\n\n ````\n"
- uid: azure.storage.filedatalake.FileSystemClient.get_file_system_access_policy
name: get_file_system_access_policy
@@ -1017,8 +1027,9 @@ methods:
examples:
- "Getting properties on the file system.<!--[!code-python[Main](les\\datalake_samples_file_system.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n properties = file_system_client.get_file_system_properties()\n\n ````\n"
@@ -1087,8 +1098,9 @@ methods:
examples:
- "List the paths in the file system.<!--[!code-python[Main](les\\datalake_samples_file_system.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n path_list = file_system_client.get_paths()\n for path in path_list:\n \
@@ -1291,8 +1303,9 @@ methods:
examples:
- "Setting metadata on the file system.<!--[!code-python[Main](les\\datalake_samples_file_system.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Create key, value pairs for metadata\n metadata = {'type': 'test'}\n\n\
diff --git a/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.aio.DataLakeDirectoryClient.yml b/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.aio.DataLakeDirectoryClient.yml
index 536e088bc78e..2677cf8e5f23 100644
--- a/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.aio.DataLakeDirectoryClient.yml
+++ b/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.aio.DataLakeDirectoryClient.yml
@@ -84,10 +84,11 @@ examples:
- "Creating the DataLakeServiceClient from connection string.<!--[!code-python[Main](les\\\
datalake_samples_instantiate_client_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_instantiate_client_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.storage.filedatalake.aio\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_instantiate_client_async.py\", \"xml:space\": \"preserve\", \"\
+ force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\":\
+ \ 1}, \"linenos\": false} -->\n\n````python\n\n from azure.storage.filedatalake.aio\
\ import DataLakeDirectoryClient\n DataLakeDirectoryClient.from_connection_string(connection_string,\
\ \"myfilesystem\", \"mydirectory\")\n\n ````\n"
methods:
@@ -332,8 +333,9 @@ methods:
examples:
- "Create directory.<!--[!code-python[Main](les\\datalake_samples_directory_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_directory_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_directory_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n await directory_client.create_directory()\n\n ````\n"
@@ -730,8 +732,9 @@ methods:
examples:
- "Delete directory.<!--[!code-python[Main](les\\datalake_samples_directory_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_directory_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_directory_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n await new_directory.delete_directory()\n\n ````\n"
@@ -1056,8 +1059,9 @@ methods:
examples:
- "Getting the properties for a file/directory.<!--[!code-python[Main](les\\datalake_samples_directory_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_directory_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_directory_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n props = await new_directory.get_directory_properties()\n\n ````\n"
@@ -1308,8 +1312,9 @@ methods:
examples:
- "Rename the source directory.<!--[!code-python[Main](les\\datalake_samples_directory_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_directory_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_directory_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n new_dir_name = \"testdir2\"\n print(\"Renaming the directory named '{}'\
diff --git a/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.aio.DataLakeFileClient.yml b/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.aio.DataLakeFileClient.yml
index 9b9e7f3c79c6..86edb352d9a8 100644
--- a/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.aio.DataLakeFileClient.yml
+++ b/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.aio.DataLakeFileClient.yml
@@ -77,10 +77,11 @@ examples:
- "Creating the DataLakeServiceClient from connection string.<!--[!code-python[Main](les\\\
datalake_samples_instantiate_client_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_instantiate_client_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.storage.filedatalake.aio\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_instantiate_client_async.py\", \"xml:space\": \"preserve\", \"\
+ force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\":\
+ \ 1}, \"linenos\": false} -->\n\n````python\n\n from azure.storage.filedatalake.aio\
\ import DataLakeFileClient\n DataLakeFileClient.from_connection_string(connection_string,\
\ \"myfilesystem\", \"mydirectory\", \"myfile\")\n\n ````\n"
methods:
@@ -250,8 +251,9 @@ methods:
examples:
- "Append data to the file.<!--[!code-python[Main](les\\datalake_samples_upload_download_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n await file_client.append_data(data=file_content[2048:3072], offset=2048,\
@@ -434,8 +436,9 @@ methods:
examples:
- "Create file.<!--[!code-python[Main](les\\datalake_samples_upload_download_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n file_client = filesystem_client.get_file_client(file_name)\n await file_client.create_file()\n\
@@ -505,8 +508,9 @@ methods:
examples:
- "Delete file.<!--[!code-python[Main](les\\datalake_samples_upload_download_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n await new_client.delete_file()\n\n ````\n"
@@ -613,8 +617,9 @@ methods:
examples:
- "Return the downloaded data.<!--[!code-python[Main](les\\datalake_samples_upload_download_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n download = await file_client.download_file()\n downloaded_bytes = await\
@@ -787,8 +792,9 @@ methods:
examples:
- "Commit the previous appended data.<!--[!code-python[Main](les\\datalake_samples_file_system_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n file_client = file_system_client.get_file_client(\"myfile\")\n await file_client.create_file()\n\
@@ -1003,8 +1009,9 @@ methods:
examples:
- "Getting the properties for a file.<!--[!code-python[Main](les\\datalake_samples_upload_download_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n properties = await file_client.get_file_properties()\n\n ````\n"
@@ -1134,12 +1141,13 @@ methods:
examples:
- "select/project on datalake file data by providing simple query expressions.<!--[!code-python[Main](les\\\
datalake_samples_query.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_query.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n errors = []\n def on_error(error):\n\
- \ errors.append(error)\n\n # upload the csv file\n file_client = datalake_service_client.get_file_client(filesystem_name,\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_query.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n errors = []\n def on_error(error):\n \
+ \ errors.append(error)\n\n # upload the csv file\n file_client = datalake_service_client.get_file_client(filesystem_name,\
\ \"csvfile\")\n file_client.upload_data(CSV_DATA, overwrite=True)\n\n # select\
\ the second column of the csv file\n query_expression = \"SELECT _2 from DataLakeStorage\"\
\n input_format = DelimitedTextDialect(delimiter=',', quotechar='\"', lineterminator='\\\
@@ -1355,8 +1363,9 @@ methods:
examples:
- "Rename the source file.<!--[!code-python[Main](les\\datalake_samples_upload_download_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_upload_download_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n new_client = await file_client.rename_file(file_client.file_system_name +\
diff --git a/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.aio.DataLakeServiceClient.yml b/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.aio.DataLakeServiceClient.yml
index 6ae89cce0134..6b349a698539 100644
--- a/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.aio.DataLakeServiceClient.yml
+++ b/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.aio.DataLakeServiceClient.yml
@@ -78,23 +78,24 @@ variables:
examples:
- "Creating the DataLakeServiceClient from connection string.<!--[!code-python[Main](les\\\
datalake_samples_service_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_service_async.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\":\
- \ 1}, \"linenos\": false} -->\n\n````python\n\n from azure.storage.filedatalake.aio\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_service_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.storage.filedatalake.aio\
\ import DataLakeServiceClient\n datalake_service_client = DataLakeServiceClient.from_connection_string(connection_string)\n\
\n ````\n\nCreating the DataLakeServiceClient with Azure Identity credentials.<!--[!code-python[Main](les\\\
datalake_samples_service_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_service_async.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\":\
- \ 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
- \ ClientSecretCredential\n token_credential = ClientSecretCredential(\n \
- \ active_directory_tenant_id,\n active_directory_application_id,\n active_directory_application_secret,\n\
- \ )\n datalake_service_client = DataLakeServiceClient(\"https://{}.dfs.core.windows.net\"\
- .format(account_name),\n credential=token_credential)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_service_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
+ \ import ClientSecretCredential\n token_credential = ClientSecretCredential(\n\
+ \ active_directory_tenant_id,\n active_directory_application_id,\n \
+ \ active_directory_application_secret,\n )\n datalake_service_client =\
+ \ DataLakeServiceClient(\"https://{}.dfs.core.windows.net\".format(account_name),\n\
+ \ credential=token_credential)\n\
\n ````\n"
methods:
- uid: azure.storage.filedatalake.aio.DataLakeServiceClient.close
@@ -164,10 +165,11 @@ methods:
- "Creating a file system in the datalake service.<!--[!code-python[Main](les\\\
datalake_samples_service_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_service_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n await datalake_service_client.create_file_system(\"\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_service_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n await datalake_service_client.create_file_system(\"\
filesystem\")\n\n ````\n"
- uid: azure.storage.filedatalake.aio.DataLakeServiceClient.delete_file_system
name: delete_file_system
@@ -253,10 +255,11 @@ methods:
- "Deleting a file system in the datalake service.<!--[!code-python[Main](les\\\
datalake_samples_service_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_service_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n await datalake_service_client.delete_file_system(\"\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_service_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n await datalake_service_client.delete_file_system(\"\
filesystem\")\n\n ````\n"
- uid: azure.storage.filedatalake.aio.DataLakeServiceClient.from_connection_string
name: from_connection_string
@@ -294,12 +297,13 @@ methods:
examples:
- "Creating the DataLakeServiceClient from a connection string.<!--[!code-python[Main](les\\\
datalake_samples_file_system.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_file_system.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.storage.filedatalake\
- \ import DataLakeServiceClient\n datalake_service_client = DataLakeServiceClient.from_connection_string(self.connection_string)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_file_system.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.storage.filedatalake import DataLakeServiceClient\n\
+ \ datalake_service_client = DataLakeServiceClient.from_connection_string(self.connection_string)\n\
\n ````\n"
- uid: azure.storage.filedatalake.aio.DataLakeServiceClient.get_directory_client
name: get_directory_client
@@ -336,10 +340,11 @@ methods:
- "Getting the directory client to interact with a specific directory.<!--[!code-python[Main](les\\\
datalake_samples_service_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_service_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n directory_client = datalake_service_client.get_directory_client(file_system_client.file_system_name,\n\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_service_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n directory_client = datalake_service_client.get_directory_client(file_system_client.file_system_name,\n\
\ \"mydirectory\"\
)\n\n ````\n"
- uid: azure.storage.filedatalake.aio.DataLakeServiceClient.get_file_client
@@ -377,10 +382,11 @@ methods:
- "Getting the file client to interact with a specific file.<!--[!code-python[Main](les\\\
datalake_samples_service_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_service_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n file_client = datalake_service_client.get_file_client(file_system_client.file_system_name,\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_service_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n file_client = datalake_service_client.get_file_client(file_system_client.file_system_name,\
\ \"myfile\")\n\n ````\n"
- uid: azure.storage.filedatalake.aio.DataLakeServiceClient.get_file_system_client
name: get_file_system_client
@@ -406,10 +412,11 @@ methods:
- "Getting the file system client to interact with a specific file system.<!--[!code-python[Main](les\\\
datalake_samples_file_system_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_file_system_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n # Instantiate a DataLakeServiceClient\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_file_system_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # Instantiate a DataLakeServiceClient\
\ using a connection string\n from azure.storage.filedatalake.aio import DataLakeServiceClient\n\
\ datalake_service_client = DataLakeServiceClient.from_connection_string(self.connection_string)\n\
\n async with datalake_service_client:\n # Instantiate a FileSystemClient\n\
@@ -481,11 +488,12 @@ methods:
- "Get user delegation key from datalake service client.<!--[!code-python[Main](les\\\
datalake_samples_service_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_service_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from datetime import datetime,\
- \ timedelta\n user_delegation_key = await datalake_service_client.get_user_delegation_key(datetime.utcnow(),\n\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_service_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from datetime import datetime, timedelta\n\
+ \ user_delegation_key = await datalake_service_client.get_user_delegation_key(datetime.utcnow(),\n\
\ datetime.utcnow()\
\ + timedelta(hours=1))\n\n ````\n"
- uid: azure.storage.filedatalake.aio.DataLakeServiceClient.list_file_systems
@@ -555,10 +563,11 @@ methods:
- "Listing the file systems in the datalake service.<!--[!code-python[Main](les\\\
datalake_samples_service_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_service_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n file_systems = datalake_service_client.list_file_systems()\n\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_service_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n file_systems = datalake_service_client.list_file_systems()\n\
\ async for file_system in file_systems:\n print(file_system.name)\n\n\
\ ````\n"
- uid: azure.storage.filedatalake.aio.DataLakeServiceClient.set_service_properties
diff --git a/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.aio.FileSystemClient.yml b/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.aio.FileSystemClient.yml
index 4a325f07ffa5..423e3f9a26ec 100644
--- a/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.aio.FileSystemClient.yml
+++ b/docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.aio.FileSystemClient.yml
@@ -42,10 +42,11 @@ examples:
- "Get a FileSystemClient from an existing DataLakeServiceClient.<!--[!code-python[Main](les\\\
datalake_samples_file_system_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_file_system_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n # Instantiate a DataLakeServiceClient\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_file_system_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # Instantiate a DataLakeServiceClient\
\ using a connection string\n from azure.storage.filedatalake.aio import DataLakeServiceClient\n\
\ datalake_service_client = DataLakeServiceClient.from_connection_string(self.connection_string)\n\
\n async with datalake_service_client:\n # Instantiate a FileSystemClient\n\
@@ -135,8 +136,9 @@ methods:
examples:
- "Acquiring a lease on the file_system.<!--[!code-python[Main](les\\datalake_samples_file_system_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Acquire a lease on the file system\n lease = await file_system_client.acquire_lease()\n\
@@ -303,8 +305,9 @@ methods:
examples:
- "Create directory in the file system.<!--[!code-python[Main](les\\datalake_samples_file_system_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n directory_client = await file_system_client.create_directory(\"mydirectory\"\
@@ -479,8 +482,9 @@ methods:
examples:
- "Create file in the file system.<!--[!code-python[Main](les\\datalake_samples_file_system_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n file_client = await file_system_client.create_file(\"myfile\")\n\n ````\n"
@@ -541,10 +545,11 @@ methods:
- "Creating a file system in the datalake service.<!--[!code-python[Main](les\\\
datalake_samples_file_system_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_file_system_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n await file_system_client.create_file_system()\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_file_system_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n await file_system_client.create_file_system()\n\
\n ````\n"
- uid: azure.storage.filedatalake.aio.FileSystemClient.delete_directory
name: delete_directory
@@ -621,8 +626,9 @@ methods:
examples:
- "Delete directory in the file system.<!--[!code-python[Main](les\\datalake_samples_file_system_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n await file_system_client.delete_directory(\"mydirectory\")\n\n ````\n"
@@ -631,10 +637,11 @@ methods:
summary: "Marks the specified file for deletion.\n\nDelete file in the file system.<!--[!code-python[Main](les\\\
datalake_samples_file_system_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_file_system_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n await file_system_client.delete_file(\"\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_file_system_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n await file_system_client.delete_file(\"\
myfile\")\n\n ````"
signature: 'async delete_file(file: FileProperties | str, **kwargs) -> DataLakeFileClient'
parameters:
@@ -778,10 +785,11 @@ methods:
- "Deleting a file system in the datalake service.<!--[!code-python[Main](les\\\
datalake_samples_file_system_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_file_system_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n await file_system_client.delete_file_system()\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_file_system_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n await file_system_client.delete_file_system()\n\
\n ````\n"
- uid: azure.storage.filedatalake.aio.FileSystemClient.exists
name: exists
@@ -850,8 +858,9 @@ methods:
examples:
- "Create FileSystemClient from connection string<!--[!code-python[Main](les\\datalake_samples_file_system.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.storage.filedatalake import FileSystemClient\n file_system_client\
@@ -882,12 +891,13 @@ methods:
- "Getting the directory client to interact with a specific directory.<!--[!code-python[Main](les\\\
datalake_samples_file_system_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_file_system_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n # Get the DataLakeDirectoryClient\
- \ from the FileSystemClient to interact with a specific file\n directory_client\
- \ = file_system_client.get_directory_client(\"mynewdirectory\")\n\n ````\n"
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_file_system_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # Get the DataLakeDirectoryClient from\
+ \ the FileSystemClient to interact with a specific file\n directory_client =\
+ \ file_system_client.get_directory_client(\"mynewdirectory\")\n\n ````\n"
- uid: azure.storage.filedatalake.aio.FileSystemClient.get_file_client
name: get_file_client
summary: 'Get a client to interact with the specified file.
@@ -913,11 +923,12 @@ methods:
- "Getting the file client to interact with a specific file.<!--[!code-python[Main](les\\\
datalake_samples_file_system_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\
- \\samples\\\\datalake_samples_file_system_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n # Get the FileClient from the\
- \ FileSystemClient to interact with a specific file\n file_client = file_system_client.get_file_client(\"\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\
+ \\datalake_samples_file_system_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # Get the FileClient from the FileSystemClient\
+ \ to interact with a specific file\n file_client = file_system_client.get_file_client(\"\
mynewfile\")\n\n ````\n"
- uid: azure.storage.filedatalake.aio.FileSystemClient.get_file_system_access_policy
name: get_file_system_access_policy
@@ -982,8 +993,9 @@ methods:
examples:
- "Getting properties on the file system.<!--[!code-python[Main](les\\datalake_samples_file_system_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n properties = await file_system_client.get_file_system_properties()\n\n \
@@ -1053,8 +1065,9 @@ methods:
examples:
- "List the blobs in the file system.<!--[!code-python[Main](les\\datalake_samples_file_system_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n path_list = file_system_client.get_paths()\n async for path in path_list:\n\
@@ -1255,8 +1268,9 @@ methods:
examples:
- "Setting metadata on the container.<!--[!code-python[Main](les\\datalake_samples_file_system_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\209\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 208\\\\azure-storage-file-datalake-12.13.1\\\\samples\\\\datalake_samples_file_system_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Create key, value pairs for metadata\n metadata = {'type': 'test'}\n\n\
diff --git a/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.ShareClient.yml b/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.ShareClient.yml
index c38d0e86dd97..6598de3068df 100644
--- a/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.ShareClient.yml
+++ b/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.ShareClient.yml
@@ -155,8 +155,9 @@ methods:
examples:
- "Acquiring a lease on a share.<!--[!code-python[Main](les\\file_samples_share.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n share.create_directory(\"mydir\")\n lease = share.acquire_lease()\n share.get_share_properties(lease=lease)\n\
@@ -283,12 +284,12 @@ methods:
examples:
- "Creates a file share.<!--[!code-python[Main](les\\file_samples_share.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # Create share with Access Tier set to Hot\n share.create_share(access_tier=ShareAccessTier(\"\
- Hot\"))\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\209\\\\azure-storage-file-share-12.14.1\\\
+ \\samples\\\\file_samples_share.py\", \"xml:space\": \"preserve\", \"force\":\
+ \ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # Create share with Access Tier set\
+ \ to Hot\n share.create_share(access_tier=ShareAccessTier(\"Hot\"))\n\n ````\n"
- uid: azure.storage.fileshare.ShareClient.create_snapshot
name: create_snapshot
summary: 'Creates a snapshot of the share.
@@ -331,8 +332,9 @@ methods:
examples:
- "Creates a snapshot of the file share.<!--[!code-python[Main](les\\file_samples_share.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n share.create_snapshot()\n\n ````\n"
@@ -401,8 +403,9 @@ methods:
examples:
- "Deletes the share and any snapshots.<!--[!code-python[Main](les\\file_samples_share.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n share.delete_share(delete_snapshots=True)\n\n ````\n"
@@ -460,8 +463,9 @@ methods:
examples:
- "Gets the share client from connection string.<!--[!code-python[Main](les\\file_samples_share.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.storage.fileshare import ShareClient\n share = ShareClient.from_connection_string(self.connection_string,\
@@ -645,8 +649,9 @@ methods:
examples:
- "Gets the share properties.<!--[!code-python[Main](les\\file_samples_hello_world.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_hello_world.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_hello_world.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n properties = share.get_share_properties()\n\n ````\n"
@@ -757,8 +762,9 @@ methods:
examples:
- "List directories and files in the share.<!--[!code-python[Main](les\\file_samples_share.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Create a directory in the share\n dir_client = share.create_directory(\"\
@@ -860,11 +866,11 @@ methods:
examples:
- "Sets the share metadata.<!--[!code-python[Main](les\\file_samples_share.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n data = {'category': 'test'}\n share.set_share_metadata(metadata=data)\n\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\209\\\\azure-storage-file-share-12.14.1\\\
+ \\samples\\\\file_samples_share.py\", \"xml:space\": \"preserve\", \"force\":\
+ \ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n data = {'category': 'test'}\n share.set_share_metadata(metadata=data)\n\
\n ````\n"
- uid: azure.storage.fileshare.ShareClient.set_share_properties
name: set_share_properties
@@ -919,8 +925,9 @@ methods:
examples:
- "Sets the share properties.<!--[!code-python[Main](les\\file_samples_share.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Set the tier for the first share to Hot\n share1.set_share_properties(access_tier=\"\
@@ -971,12 +978,12 @@ methods:
examples:
- "Sets the share quota.<!--[!code-python[Main](les\\file_samples_share.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # Set the quota for the share to 1GB\n share.set_share_quota(quota=1)\n\
- \n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\209\\\\azure-storage-file-share-12.14.1\\\
+ \\samples\\\\file_samples_share.py\", \"xml:space\": \"preserve\", \"force\":\
+ \ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # Set the quota for the share to 1GB\n\
+ \ share.set_share_quota(quota=1)\n\n ````\n"
attributes:
- uid: azure.storage.fileshare.ShareClient.api_version
name: api_version
diff --git a/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.ShareDirectoryClient.yml b/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.ShareDirectoryClient.yml
index 3f84ef3e3c66..887ff70d14b6 100644
--- a/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.ShareDirectoryClient.yml
+++ b/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.ShareDirectoryClient.yml
@@ -263,11 +263,12 @@ methods:
examples:
- "Creates a directory.<!--[!code-python[Main](les\\file_samples_directory.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n my_directory.create_directory()\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\209\\\\azure-storage-file-share-12.14.1\\\
+ \\samples\\\\file_samples_directory.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n my_directory.create_directory()\n\n\
+ \ ````\n"
- uid: azure.storage.fileshare.ShareDirectoryClient.create_subdirectory
name: create_subdirectory
summary: 'Creates a new subdirectory and returns a client to interact
@@ -303,8 +304,9 @@ methods:
examples:
- "Create a subdirectory.<!--[!code-python[Main](les\\file_samples_directory.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Create the directory\n parent_dir.create_directory()\n\n # Create a\
@@ -334,11 +336,12 @@ methods:
examples:
- "Deletes a directory.<!--[!code-python[Main](les\\file_samples_directory.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n my_directory.delete_directory()\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\209\\\\azure-storage-file-share-12.14.1\\\
+ \\samples\\\\file_samples_directory.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n my_directory.delete_directory()\n\n\
+ \ ````\n"
- uid: azure.storage.fileshare.ShareDirectoryClient.delete_file
name: delete_file
summary: 'Marks the specified file for deletion. The file is later
@@ -369,8 +372,9 @@ methods:
examples:
- "Delete a file in a directory.<!--[!code-python[Main](les\\file_samples_directory.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Delete the file in the directory\n my_directory.delete_file(file_name=\"\
@@ -403,8 +407,9 @@ methods:
examples:
- "Delete a subdirectory.<!--[!code-python[Main](les\\file_samples_directory.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n parent_dir.delete_subdirectory(\"subdir\")\n\n ````\n"
@@ -585,8 +590,9 @@ methods:
examples:
- "Gets the subdirectory client.<!--[!code-python[Main](les\\file_samples_directory.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Get a directory client and create the directory\n parent = share.get_directory_client(\"\
@@ -648,8 +654,9 @@ methods:
examples:
- "List directories and files.<!--[!code-python[Main](les\\file_samples_directory.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # List the directories and files under the parent directory\n my_list =\
@@ -910,8 +917,9 @@ methods:
examples:
- "Upload a file to a directory.<!--[!code-python[Main](les\\file_samples_directory.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Upload a file to the directory\n with open(SOURCE_FILE, \"rb\") as source:\n\
diff --git a/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.ShareFileClient.yml b/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.ShareFileClient.yml
index 8c9d762efe2a..8cb413c44620 100644
--- a/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.ShareFileClient.yml
+++ b/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.ShareFileClient.yml
@@ -188,8 +188,9 @@ methods:
examples:
- "Acquiring a lease on a file.<!--[!code-python[Main](les\\file_samples_client.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_client.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_client.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n source_file.create_file(1024)\n lease = source_file.acquire_lease()\n \
@@ -426,12 +427,13 @@ methods:
examples:
- "Create a file.<!--[!code-python[Main](les\\file_samples_client.py )]-->\n\n<!--\
\ literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [],\
- \ \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\\
- 210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_client.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # Create and allocate bytes for the file (no content added yet)\n my_allocated_file.create_file(size=100)\n\
- \n ````\n"
+ \ \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\209\\\\azure-storage-file-share-12.14.1\\\
+ \\samples\\\\file_samples_client.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # Create and allocate bytes for the\
+ \ file (no content added yet)\n my_allocated_file.create_file(size=100)\n\n\
+ \ ````\n"
- uid: azure.storage.fileshare.ShareFileClient.delete_file
name: delete_file
summary: 'Marks the specified file for deletion. The file is
@@ -468,11 +470,11 @@ methods:
examples:
- "Delete a file.<!--[!code-python[Main](les\\file_samples_client.py )]-->\n\n<!--\
\ literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [],\
- \ \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\\
- 210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_client.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n my_file.delete_file()\n\n ````\n"
+ \ \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\209\\\\azure-storage-file-share-12.14.1\\\
+ \\samples\\\\file_samples_client.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n my_file.delete_file()\n\n ````\n"
- uid: azure.storage.fileshare.ShareFileClient.download_file
name: download_file
summary: 'Downloads a file to the StorageStreamDownloader. The readall() method
@@ -562,12 +564,13 @@ methods:
examples:
- "Download a file.<!--[!code-python[Main](les\\file_samples_client.py )]-->\n\n\
<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_client.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n with open(DEST_FILE, \"wb\") as data:\n stream = my_file.download_file()\n\
- \ data.write(stream.readall())\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\209\\\\azure-storage-file-share-12.14.1\\\
+ \\samples\\\\file_samples_client.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n with open(DEST_FILE, \"wb\") as data:\n\
+ \ stream = my_file.download_file()\n data.write(stream.readall())\n\
+ \n ````\n"
- uid: azure.storage.fileshare.ShareFileClient.from_connection_string
name: from_connection_string
summary: Create ShareFileClient from a Connection String.
@@ -628,12 +631,13 @@ methods:
examples:
- "Creates the file client with connection string.<!--[!code-python[Main](les\\\
file_samples_hello_world.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\
- \\samples\\\\file_samples_hello_world.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.storage.fileshare import\
- \ ShareFileClient\n file = ShareFileClient.from_connection_string(\n self.connection_string,\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\209\\\\azure-storage-file-share-12.14.1\\\\samples\\\
+ \\file_samples_hello_world.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.storage.fileshare import ShareFileClient\n\
+ \ file = ShareFileClient.from_connection_string(\n self.connection_string,\n\
\ share_name=\"helloworld2\",\n file_path=\"myfile\")\n\n ````\n"
- uid: azure.storage.fileshare.ShareFileClient.from_file_url
name: from_file_url
@@ -1232,11 +1236,12 @@ methods:
examples:
- "Copy a file from a URL<!--[!code-python[Main](les\\file_samples_client.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_client.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n destination_file.start_copy_from_url(source_url=source_url)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\209\\\\azure-storage-file-share-12.14.1\\\
+ \\samples\\\\file_samples_client.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n destination_file.start_copy_from_url(source_url=source_url)\n\
+ \n ````\n"
- uid: azure.storage.fileshare.ShareFileClient.upload_file
name: upload_file
summary: "Uploads a new file.\n\n param data:\n Content of the file.\n\n\
@@ -1296,8 +1301,9 @@ methods:
\ property dict (Etag and last modified).\n\nrtype:\n dict(str, Any)\n\n\n\
\n## Example:Upload a file.<!--[!code-python[Main](les\\file_samples_client.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [],\
- \ \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\\
- s\\\\source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_client.py\"\
+ \ \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\\
+ windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_client.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n with open(SOURCE_FILE, \"rb\") as source:\n my_file.upload_file(source)\n\
diff --git a/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.ShareServiceClient.yml b/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.ShareServiceClient.yml
index 2b3432832c44..9af247fde384 100644
--- a/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.ShareServiceClient.yml
+++ b/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.ShareServiceClient.yml
@@ -96,13 +96,14 @@ constructor:
examples:
- "Create the share service client with url and credential.<!--[!code-python[Main](les\\\
file_samples_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\\
- samples\\\\file_samples_authentication.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.storage.fileshare import ShareServiceClient\n\
- \ share_service_client = ShareServiceClient(\n account_url=self.account_url,\n\
- \ credential=self.access_key\n )\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_authentication.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.storage.fileshare\
+ \ import ShareServiceClient\n share_service_client = ShareServiceClient(\n \
+ \ account_url=self.account_url,\n credential=self.access_key\n )\n\n\
+ \ ````\n"
methods:
- uid: azure.storage.fileshare.ShareServiceClient.close
name: close
@@ -153,8 +154,9 @@ methods:
examples:
- "Create a share in the file share service.<!--[!code-python[Main](les\\file_samples_service.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_service.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_service.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n file_service.create_share(share_name=\"fileshare1\")\n\n ````\n"
@@ -197,8 +199,9 @@ methods:
examples:
- "Delete a share in the file share service.<!--[!code-python[Main](les\\file_samples_service.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_service.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_service.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n file_service.delete_share(share_name=\"fileshare1\")\n\n ````\n"
@@ -243,12 +246,13 @@ methods:
examples:
- "Create the share service client with connection string.<!--[!code-python[Main](les\\\
file_samples_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\
- \\samples\\\\file_samples_authentication.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.storage.fileshare\
- \ import ShareServiceClient\n share_service_client = ShareServiceClient.from_connection_string(self.connection_string)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\209\\\\azure-storage-file-share-12.14.1\\\\samples\\\
+ \\file_samples_authentication.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.storage.fileshare import ShareServiceClient\n\
+ \ share_service_client = ShareServiceClient.from_connection_string(self.connection_string)\n\
\n ````\n"
- uid: azure.storage.fileshare.ShareServiceClient.get_service_properties
name: get_service_properties
@@ -278,8 +282,9 @@ methods:
examples:
- "Get file share service properties.<!--[!code-python[Main](les\\file_samples_service.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_service.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_service.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n properties = file_service.get_service_properties()\n\n ````\n"
@@ -314,13 +319,13 @@ methods:
examples:
- "Gets the share client.<!--[!code-python[Main](les\\file_samples_service.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_service.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.storage.fileshare import ShareServiceClient\n file_service =\
- \ ShareServiceClient.from_connection_string(self.connection_string)\n\n # Get\
- \ a share client to interact with a specific share\n share = file_service.get_share_client(\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\209\\\\azure-storage-file-share-12.14.1\\\
+ \\samples\\\\file_samples_service.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.storage.fileshare import\
+ \ ShareServiceClient\n file_service = ShareServiceClient.from_connection_string(self.connection_string)\n\
+ \n # Get a share client to interact with a specific share\n share = file_service.get_share_client(\"\
fileshare2\")\n\n ````\n"
- uid: azure.storage.fileshare.ShareServiceClient.list_shares
name: list_shares
@@ -375,8 +380,9 @@ methods:
examples:
- "List shares in the file share service.<!--[!code-python[Main](les\\file_samples_service.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_service.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_service.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # List the shares in the file service\n my_shares = list(file_service.list_shares())\n\
@@ -439,8 +445,9 @@ methods:
examples:
- "Sets file share service properties.<!--[!code-python[Main](les\\file_samples_service.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_service.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_service.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Create service properties\n from azure.storage.fileshare import Metrics,\
diff --git a/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.aio.ShareClient.yml b/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.aio.ShareClient.yml
index d60ec62f7500..494f8113ae7e 100644
--- a/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.aio.ShareClient.yml
+++ b/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.aio.ShareClient.yml
@@ -272,8 +272,9 @@ methods:
examples:
- "Creates a file share.<!--[!code-python[Main](les\\file_samples_share_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Create share with Access Tier set to Hot\n await share.create_share(access_tier=ShareAccessTier(\"\
@@ -320,8 +321,9 @@ methods:
examples:
- "Creates a snapshot of the file share.<!--[!code-python[Main](les\\file_samples_share_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n await share.create_snapshot()\n\n ````\n"
@@ -391,8 +393,9 @@ methods:
examples:
- "Deletes the share and any snapshots.<!--[!code-python[Main](les\\file_samples_share_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n await share.delete_share(delete_snapshots=True)\n\n ````\n"
@@ -450,8 +453,9 @@ methods:
examples:
- "Gets the share client from connection string.<!--[!code-python[Main](les\\file_samples_share.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.storage.fileshare import ShareClient\n share = ShareClient.from_connection_string(self.connection_string,\
@@ -636,8 +640,9 @@ methods:
examples:
- "Gets the share properties.<!--[!code-python[Main](les\\file_samples_hello_world_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_hello_world_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_hello_world_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n properties = await share.get_share_properties()\n\n ````\n"
@@ -748,8 +753,9 @@ methods:
examples:
- "List directories and files in the share.<!--[!code-python[Main](les\\file_samples_share_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Create a directory in the share\n dir_client = await share.create_directory(\"\
@@ -852,8 +858,9 @@ methods:
examples:
- "Sets the share metadata.<!--[!code-python[Main](les\\file_samples_share_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n data = {'category': 'test'}\n await share.set_share_metadata(metadata=data)\n\
@@ -911,8 +918,9 @@ methods:
examples:
- "Sets the share properties.<!--[!code-python[Main](les\\file_samples_share_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Set the tier for the first share to Hot\n await share1.set_share_properties(access_tier=\"\
@@ -964,8 +972,9 @@ methods:
examples:
- "Sets the share quota.<!--[!code-python[Main](les\\file_samples_share_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_share_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Set the quota for the share to 1GB\n await share.set_share_quota(quota=1)\n\
diff --git a/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.aio.ShareDirectoryClient.yml b/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.aio.ShareDirectoryClient.yml
index 8eced5b5c893..473e130586f7 100644
--- a/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.aio.ShareDirectoryClient.yml
+++ b/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.aio.ShareDirectoryClient.yml
@@ -260,8 +260,9 @@ methods:
examples:
- "Creates a directory.<!--[!code-python[Main](les\\file_samples_directory_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n await directory.create_directory()\n\n ````\n"
@@ -300,8 +301,9 @@ methods:
examples:
- "Create a subdirectory.<!--[!code-python[Main](les\\file_samples_directory_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Create the directory\n await parent_dir.create_directory()\n\n # Create\
@@ -332,8 +334,9 @@ methods:
examples:
- "Deletes a directory.<!--[!code-python[Main](les\\file_samples_directory_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n await directory.delete_directory()\n\n ````\n"
@@ -367,8 +370,9 @@ methods:
examples:
- "Delete a file in a directory.<!--[!code-python[Main](les\\file_samples_directory_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Delete the file in the directory\n await directory.delete_file(file_name=\"\
@@ -401,8 +405,9 @@ methods:
examples:
- "Delete a subdirectory.<!--[!code-python[Main](les\\file_samples_directory_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n await parent_dir.delete_subdirectory(\"subdir\")\n\n ````\n"
@@ -583,8 +588,9 @@ methods:
examples:
- "Gets the subdirectory client.<!--[!code-python[Main](les\\file_samples_directory_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Get a directory client and create the directory\n parent = share.get_directory_client(\"\
@@ -647,8 +653,9 @@ methods:
examples:
- "List directories and files.<!--[!code-python[Main](les\\file_samples_directory_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # List the directories and files under the parent directory\n my_list =\
@@ -910,8 +917,9 @@ methods:
examples:
- "Upload a file to a directory.<!--[!code-python[Main](les\\file_samples_directory_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_directory_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Upload a file to the directory\n with open(SOURCE_FILE, \"rb\") as source:\n\
diff --git a/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.aio.ShareFileClient.yml b/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.aio.ShareFileClient.yml
index b6b467c28f49..b0f3c803fa0c 100644
--- a/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.aio.ShareFileClient.yml
+++ b/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.aio.ShareFileClient.yml
@@ -414,12 +414,13 @@ methods:
examples:
- "Create a file.<!--[!code-python[Main](les\\file_samples_client_async.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_client_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # Create and allocate bytes for the file (no content added yet)\n await\
- \ my_allocated_file.create_file(size=100)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\209\\\\azure-storage-file-share-12.14.1\\\
+ \\samples\\\\file_samples_client_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # Create and allocate bytes for the\
+ \ file (no content added yet)\n await my_allocated_file.create_file(size=100)\n\
+ \n ````\n"
- uid: azure.storage.fileshare.aio.ShareFileClient.delete_file
name: delete_file
summary: 'Marks the specified file for deletion. The file is
@@ -456,11 +457,11 @@ methods:
examples:
- "Delete a file.<!--[!code-python[Main](les\\file_samples_client_async.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_client_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n await my_file.delete_file()\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\209\\\\azure-storage-file-share-12.14.1\\\
+ \\samples\\\\file_samples_client_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n await my_file.delete_file()\n\n ````\n"
- uid: azure.storage.fileshare.aio.ShareFileClient.download_file
name: download_file
summary: 'Downloads a file to the StorageStreamDownloader. The readall() method
@@ -550,12 +551,13 @@ methods:
examples:
- "Download a file.<!--[!code-python[Main](les\\file_samples_client_async.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_client_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n with open(DEST_FILE, \"wb\") as data:\n stream = await my_file.download_file()\n\
- \ data.write(await stream.readall())\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\209\\\\azure-storage-file-share-12.14.1\\\
+ \\samples\\\\file_samples_client_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n with open(DEST_FILE, \"wb\") as data:\n\
+ \ stream = await my_file.download_file()\n data.write(await stream.readall())\n\
+ \n ````\n"
- uid: azure.storage.fileshare.aio.ShareFileClient.from_connection_string
name: from_connection_string
summary: Create ShareFileClient from a Connection String.
@@ -616,12 +618,13 @@ methods:
examples:
- "Creates the file client with connection string.<!--[!code-python[Main](les\\\
file_samples_hello_world.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\
- \\samples\\\\file_samples_hello_world.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.storage.fileshare import\
- \ ShareFileClient\n file = ShareFileClient.from_connection_string(\n self.connection_string,\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\209\\\\azure-storage-file-share-12.14.1\\\\samples\\\
+ \\file_samples_hello_world.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.storage.fileshare import ShareFileClient\n\
+ \ file = ShareFileClient.from_connection_string(\n self.connection_string,\n\
\ share_name=\"helloworld2\",\n file_path=\"myfile\")\n\n ````\n"
- uid: azure.storage.fileshare.aio.ShareFileClient.from_file_url
name: from_file_url
@@ -1220,8 +1223,9 @@ methods:
examples:
- "Copy a file from a URL<!--[!code-python[Main](les\\file_samples_client_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_client_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_client_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n await destination_file.start_copy_from_url(source_url=source_url)\n\n ````\n"
@@ -1378,12 +1382,12 @@ methods:
examples:
- "Upload a file.<!--[!code-python[Main](les\\file_samples_client_async.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_client_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n with open(SOURCE_FILE, \"rb\") as source:\n await my_file.upload_file(source)\n\
- \n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\209\\\\azure-storage-file-share-12.14.1\\\
+ \\samples\\\\file_samples_client_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n with open(SOURCE_FILE, \"rb\") as source:\n\
+ \ await my_file.upload_file(source)\n\n ````\n"
- uid: azure.storage.fileshare.aio.ShareFileClient.upload_range
name: upload_range
summary: Upload a range of bytes to a file.
diff --git a/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.aio.ShareServiceClient.yml b/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.aio.ShareServiceClient.yml
index 0970bbc31c36..2c655de1f8c7 100644
--- a/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.aio.ShareServiceClient.yml
+++ b/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.aio.ShareServiceClient.yml
@@ -93,13 +93,13 @@ examples:
- "Create the share service client with url and credential.<!--[!code-python[Main](les\\\
file_samples_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"\
- D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\
- \\samples\\\\file_samples_authentication_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.storage.fileshare.aio\
- \ import ShareServiceClient\n share_service_client = ShareServiceClient(\n \
- \ account_url=self.account_url,\n credential=self.access_key\n )\n\n\
- \ ````\n"
+ C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\\
+ file_samples_authentication_async.py\", \"xml:space\": \"preserve\", \"force\":\
+ \ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.storage.fileshare.aio import\
+ \ ShareServiceClient\n share_service_client = ShareServiceClient(\n account_url=self.account_url,\n\
+ \ credential=self.access_key\n )\n\n ````\n"
methods:
- uid: azure.storage.fileshare.aio.ShareServiceClient.close
name: close
@@ -150,8 +150,9 @@ methods:
examples:
- "Create a share in the file share service.<!--[!code-python[Main](les\\file_samples_service_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_service_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_service_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n await file_service.create_share(share_name=\"fileshare1\")\n\n ````\n"
@@ -194,8 +195,9 @@ methods:
examples:
- "Delete a share in the file share service.<!--[!code-python[Main](les\\file_samples_service_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_service_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_service_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n await file_service.delete_share(share_name=\"fileshare1\")\n\n ````\n"
@@ -240,12 +242,13 @@ methods:
examples:
- "Create the share service client with connection string.<!--[!code-python[Main](les\\\
file_samples_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\
- \\samples\\\\file_samples_authentication.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.storage.fileshare\
- \ import ShareServiceClient\n share_service_client = ShareServiceClient.from_connection_string(self.connection_string)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\209\\\\azure-storage-file-share-12.14.1\\\\samples\\\
+ \\file_samples_authentication.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.storage.fileshare import ShareServiceClient\n\
+ \ share_service_client = ShareServiceClient.from_connection_string(self.connection_string)\n\
\n ````\n"
- uid: azure.storage.fileshare.aio.ShareServiceClient.get_service_properties
name: get_service_properties
@@ -275,8 +278,9 @@ methods:
examples:
- "Get file share service properties.<!--[!code-python[Main](les\\file_samples_service_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_service_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_service_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n properties = await file_service.get_service_properties()\n\n ````\n"
@@ -311,8 +315,9 @@ methods:
examples:
- "Gets the share client.<!--[!code-python[Main](les\\file_samples_service_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_service_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_service_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.storage.fileshare.aio import ShareServiceClient\n file_service\
@@ -372,8 +377,9 @@ methods:
examples:
- "List shares in the file share service.<!--[!code-python[Main](les\\file_samples_service_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_service_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_service_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # List the shares in the file service\n my_shares = []\n async for s\
@@ -436,8 +442,9 @@ methods:
examples:
- "Sets file share service properties.<!--[!code-python[Main](les\\file_samples_service_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_service_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_service_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Create service properties\n from azure.storage.fileshare import Metrics,\
diff --git a/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.yml b/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.yml
index 7161c3ecbe3c..4463e922699f 100644
--- a/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.yml
+++ b/docs-ref-autogen/azure-storage-file-share/azure.storage.fileshare.yml
@@ -103,8 +103,9 @@ functions:
examples:
- "Generate a sas token.<!--[!code-python[Main](les\\file_samples_authentication.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\210\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_authentication.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 209\\\\azure-storage-file-share-12.14.1\\\\samples\\\\file_samples_authentication.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.storage.fileshare import ShareServiceClient\n share_service_client\
diff --git a/docs-ref-autogen/azure-storage-queue/azure.storage.queue.QueueClient.yml b/docs-ref-autogen/azure-storage-queue/azure.storage.queue.QueueClient.yml
index f161df75a5a9..6e83f4c48a72 100644
--- a/docs-ref-autogen/azure-storage-queue/azure.storage.queue.QueueClient.yml
+++ b/docs-ref-autogen/azure-storage-queue/azure.storage.queue.QueueClient.yml
@@ -79,12 +79,12 @@ constructor:
examples:
- "Create the queue client with url and credential.<!--[!code-python[Main](les\\queue_samples_message.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n token_auth_queue\
- \ = QueueClient.from_queue_url(\n queue_url=queue.url,\n credential=sas_token\n\
- \ )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\210\\\\azure-storage-queue-12.7.1\\\
+ \\samples\\\\queue_samples_message.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n token_auth_queue = QueueClient.from_queue_url(\n\
+ \ queue_url=queue.url,\n credential=sas_token\n )\n\n ````\n"
methods:
- uid: azure.storage.queue.QueueClient.clear_messages
name: clear_messages
@@ -106,11 +106,11 @@ methods:
examples:
- "Clears all messages.<!--[!code-python[Main](les\\queue_samples_message.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n queue.clear_messages()\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\210\\\\azure-storage-queue-12.7.1\\\
+ \\samples\\\\queue_samples_message.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n queue.clear_messages()\n\n ````\n"
- uid: azure.storage.queue.QueueClient.close
name: close
summary: 'This method is to close the sockets opened by the client.
@@ -156,11 +156,11 @@ methods:
examples:
- "Create a queue.<!--[!code-python[Main](les\\queue_samples_hello_world.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_hello_world.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n queue.create_queue()\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\210\\\\azure-storage-queue-12.7.1\\\
+ \\samples\\\\queue_samples_hello_world.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n queue.create_queue()\n\n ````\n"
- uid: azure.storage.queue.QueueClient.delete_message
name: delete_message
summary: 'Deletes the specified message.
@@ -218,12 +218,13 @@ methods:
examples:
- "Delete a message.<!--[!code-python[Main](les\\queue_samples_message.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # Get the message at the front of the queue\n msg = next(queue.receive_messages())\n\
- \n # Delete the specified message\n queue.delete_message(msg)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\210\\\\azure-storage-queue-12.7.1\\\
+ \\samples\\\\queue_samples_message.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # Get the message at the front of the\
+ \ queue\n msg = next(queue.receive_messages())\n\n # Delete the specified\
+ \ message\n queue.delete_message(msg)\n\n ````\n"
- uid: azure.storage.queue.QueueClient.delete_queue
name: delete_queue
summary: 'Deletes the specified queue and any messages it contains.
@@ -261,11 +262,11 @@ methods:
examples:
- "Delete a queue.<!--[!code-python[Main](les\\queue_samples_hello_world.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_hello_world.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n queue.delete_queue()\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\210\\\\azure-storage-queue-12.7.1\\\
+ \\samples\\\\queue_samples_hello_world.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n queue.delete_queue()\n\n ````\n"
- uid: azure.storage.queue.QueueClient.from_connection_string
name: from_connection_string
summary: Create QueueClient from a Connection String.
@@ -311,13 +312,13 @@ methods:
examples:
- "Create the queue client from connection string.<!--[!code-python[Main](les\\\
queue_samples_message.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\
- \\queue_samples_message.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
- language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.storage.queue import QueueClient\n\
- \ queue = QueueClient.from_connection_string(self.connection_string, \"myqueue1\"\
- )\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.storage.queue import QueueClient\n queue = QueueClient.from_connection_string(self.connection_string,\
+ \ \"myqueue1\")\n\n ````\n"
- uid: azure.storage.queue.QueueClient.from_queue_url
name: from_queue_url
summary: A client to interact with a specific Queue.
@@ -397,11 +398,12 @@ methods:
examples:
- "Get the properties on the queue.<!--[!code-python[Main](les\\queue_samples_message.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n properties = queue.get_queue_properties().metadata\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n properties\
+ \ = queue.get_queue_properties().metadata\n\n ````\n"
- uid: azure.storage.queue.QueueClient.peek_messages
name: peek_messages
summary: 'Retrieves one or more messages from the front of the queue, but does
@@ -463,14 +465,14 @@ methods:
examples:
- "Peek messages.<!--[!code-python[Main](les\\queue_samples_message.py )]-->\n\n\
<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # Peek at one message at the front of the queue\n msg = queue.peek_messages()\n\
- \n # Peek at the last 5 messages\n messages = queue.peek_messages(max_messages=5)\n\
- \n # Print the last 5 messages\n for message in messages:\n print(message.content)\n\
- \n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\210\\\\azure-storage-queue-12.7.1\\\
+ \\samples\\\\queue_samples_message.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # Peek at one message at the front of\
+ \ the queue\n msg = queue.peek_messages()\n\n # Peek at the last 5 messages\n\
+ \ messages = queue.peek_messages(max_messages=5)\n\n # Print the last 5 messages\n\
+ \ for message in messages:\n print(message.content)\n\n ````\n"
- uid: azure.storage.queue.QueueClient.receive_message
name: receive_message
summary: 'Removes one message from the front of the queue.
@@ -527,11 +529,12 @@ methods:
examples:
- "Receive one message from the queue.<!--[!code-python[Main](les\\queue_samples_message.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # Pop two messages from the front of the queue\n message1 = queue.receive_message()\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # Pop two\
+ \ messages from the front of the queue\n message1 = queue.receive_message()\n\
\ message2 = queue.receive_message()\n # We should see message 3 if we peek\n\
\ message3 = queue.peek_messages()[0]\n\n print(message1.content)\n print(message2.content)\n\
\ print(message3.content)\n\n ````\n"
@@ -599,15 +602,15 @@ methods:
examples:
- "Receive messages from the queue.<!--[!code-python[Main](les\\queue_samples_message.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # Receive messages one-by-one\n messages = queue.receive_messages()\n \
- \ for msg in messages:\n print(msg.content)\n\n # Receive messages by\
- \ batch\n messages = queue.receive_messages(messages_per_page=5)\n for msg_batch\
- \ in messages.by_page():\n for msg in msg_batch:\n print(msg.content)\n\
- \ queue.delete_message(msg)\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # Receive\
+ \ messages one-by-one\n messages = queue.receive_messages()\n for msg in messages:\n\
+ \ print(msg.content)\n\n # Receive messages by batch\n messages = queue.receive_messages(messages_per_page=5)\n\
+ \ for msg_batch in messages.by_page():\n for msg in msg_batch:\n \
+ \ print(msg.content)\n queue.delete_message(msg)\n\n ````\n"
- uid: azure.storage.queue.QueueClient.send_message
name: send_message
summary: 'Adds a new message to the back of the message queue.
@@ -688,14 +691,14 @@ methods:
examples:
- "Send messages.<!--[!code-python[Main](les\\queue_samples_message.py )]-->\n\n\
<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n queue.send_message(\"message1\")\n queue.send_message(\"message2\", visibility_timeout=30)\
- \ # wait 30s before becoming visible\n queue.send_message(\"message3\")\n \
- \ queue.send_message(\"message4\")\n queue.send_message(\"message5\")\n\n \
- \ ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\210\\\\azure-storage-queue-12.7.1\\\
+ \\samples\\\\queue_samples_message.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n queue.send_message(\"message1\")\n \
+ \ queue.send_message(\"message2\", visibility_timeout=30) # wait 30s before\
+ \ becoming visible\n queue.send_message(\"message3\")\n queue.send_message(\"\
+ message4\")\n queue.send_message(\"message5\")\n\n ````\n"
- uid: azure.storage.queue.QueueClient.set_queue_access_policy
name: set_queue_access_policy
summary: 'Sets stored access policies for the queue that may be used with Shared
@@ -749,16 +752,17 @@ methods:
examples:
- "Set an access policy on the queue.<!--[!code-python[Main](les\\queue_samples_message.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # Create an access policy\n from azure.storage.queue import AccessPolicy,\
- \ QueueSasPermissions\n access_policy = AccessPolicy()\n access_policy.start\
- \ = datetime.utcnow() - timedelta(hours=1)\n access_policy.expiry = datetime.utcnow()\
- \ + timedelta(hours=1)\n access_policy.permission = QueueSasPermissions(read=True)\n\
- \ identifiers = {'my-access-policy-id': access_policy}\n\n # Set the access\
- \ policy\n queue.set_queue_access_policy(identifiers)\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # Create an\
+ \ access policy\n from azure.storage.queue import AccessPolicy, QueueSasPermissions\n\
+ \ access_policy = AccessPolicy()\n access_policy.start = datetime.utcnow()\
+ \ - timedelta(hours=1)\n access_policy.expiry = datetime.utcnow() + timedelta(hours=1)\n\
+ \ access_policy.permission = QueueSasPermissions(read=True)\n identifiers\
+ \ = {'my-access-policy-id': access_policy}\n\n # Set the access policy\n queue.set_queue_access_policy(identifiers)\n\
+ \n ````\n"
- uid: azure.storage.queue.QueueClient.set_queue_metadata
name: set_queue_metadata
summary: 'Sets user-defined metadata on the specified queue.
@@ -794,11 +798,12 @@ methods:
examples:
- "Set metadata on the queue.<!--[!code-python[Main](les\\queue_samples_message.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n metadata = {'foo': 'val1', 'bar': 'val2', 'baz': 'val3'}\n queue.set_queue_metadata(metadata=metadata)\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n metadata =\
+ \ {'foo': 'val1', 'bar': 'val2', 'baz': 'val3'}\n queue.set_queue_metadata(metadata=metadata)\n\
\n ````\n"
- uid: azure.storage.queue.QueueClient.update_message
name: update_message
@@ -886,15 +891,15 @@ methods:
examples:
- "Update a message.<!--[!code-python[Main](les\\queue_samples_message.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # Send a message\n queue.send_message(\"update me\")\n\n # Receive the\
- \ message\n messages = queue.receive_messages()\n\n # Update the message\n\
- \ list_result = next(messages)\n message = queue.update_message(\n list_result.id,\n\
- \ pop_receipt=list_result.pop_receipt,\n visibility_timeout=0,\n \
- \ content=\"updated\")\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\210\\\\azure-storage-queue-12.7.1\\\
+ \\samples\\\\queue_samples_message.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # Send a message\n queue.send_message(\"\
+ update me\")\n\n # Receive the message\n messages = queue.receive_messages()\n\
+ \n # Update the message\n list_result = next(messages)\n message = queue.update_message(\n\
+ \ list_result.id,\n pop_receipt=list_result.pop_receipt,\n visibility_timeout=0,\n\
+ \ content=\"updated\")\n\n ````\n"
attributes:
- uid: azure.storage.queue.QueueClient.api_version
name: api_version
diff --git a/docs-ref-autogen/azure-storage-queue/azure.storage.queue.QueueServiceClient.yml b/docs-ref-autogen/azure-storage-queue/azure.storage.queue.QueueServiceClient.yml
index 24aab9033eb6..5ac0d062aacf 100644
--- a/docs-ref-autogen/azure-storage-queue/azure.storage.queue.QueueServiceClient.yml
+++ b/docs-ref-autogen/azure-storage-queue/azure.storage.queue.QueueServiceClient.yml
@@ -73,20 +73,21 @@ constructor:
examples:
- "Creating the QueueServiceClient with an account url and credential.<!--[!code-python[Main](les\\\
queue_samples_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\
- \\queue_samples_authentication.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.storage.queue import QueueServiceClient\n\
- \ queue_service = QueueServiceClient(account_url=self.account_url, credential=self.access_key)\n\
- \n ````\n\nCreating the QueueServiceClient with Azure Identity credentials.<!--[!code-python[Main](les\\\
- queue_samples_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\
- \\queue_samples_authentication.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n # Get a token credential for authentication\n \
- \ from azure.identity import ClientSecretCredential\n token_credential = ClientSecretCredential(\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_authentication.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.storage.queue\
+ \ import QueueServiceClient\n queue_service = QueueServiceClient(account_url=self.account_url,\
+ \ credential=self.access_key)\n\n ````\n\nCreating the QueueServiceClient with\
+ \ Azure Identity credentials.<!--[!code-python[Main](les\\queue_samples_authentication.py\
+ \ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\210\\\\azure-storage-queue-12.7.1\\\
+ \\samples\\\\queue_samples_authentication.py\", \"xml:space\": \"preserve\", \"\
+ force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\":\
+ \ 1}, \"linenos\": false} -->\n\n````python\n\n # Get a token credential for authentication\n\
+ \ from azure.identity import ClientSecretCredential\n token_credential = ClientSecretCredential(\n\
\ self.active_directory_tenant_id,\n self.active_directory_application_id,\n\
\ self.active_directory_application_secret\n )\n\n # Instantiate a QueueServiceClient\
\ using a token credential\n from azure.storage.queue import QueueServiceClient\n\
@@ -133,11 +134,12 @@ methods:
examples:
- "Create a queue in the service.<!--[!code-python[Main](les\\queue_samples_service.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_service.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n queue_service.create_queue(\"myqueue1\")\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_service.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n queue_service.create_queue(\"\
+ myqueue1\")\n\n ````\n"
- uid: azure.storage.queue.QueueServiceClient.delete_queue
name: delete_queue
summary: 'Deletes the specified queue and any messages it contains.
@@ -175,11 +177,12 @@ methods:
examples:
- "Delete a queue in the service.<!--[!code-python[Main](les\\queue_samples_service.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_service.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n queue_service.delete_queue(\"myqueue1\")\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_service.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n queue_service.delete_queue(\"\
+ myqueue1\")\n\n ````\n"
- uid: azure.storage.queue.QueueServiceClient.from_connection_string
name: from_connection_string
summary: Create QueueServiceClient from a Connection String.
@@ -220,12 +223,12 @@ methods:
examples:
- "Creating the QueueServiceClient with a connection string.<!--[!code-python[Main](les\\\
queue_samples_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\
- \\queue_samples_authentication.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.storage.queue import QueueServiceClient\n\
- \ queue_service = QueueServiceClient.from_connection_string(conn_str=self.connection_string)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_authentication.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.storage.queue import QueueServiceClient\n queue_service = QueueServiceClient.from_connection_string(conn_str=self.connection_string)\n\
\n ````\n"
- uid: azure.storage.queue.QueueServiceClient.get_queue_client
name: get_queue_client
@@ -250,12 +253,13 @@ methods:
examples:
- "Get the queue client.<!--[!code-python[Main](les\\queue_samples_service.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_service.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # Get the queue client to interact with a specific queue\n queue = queue_service.get_queue_client(queue=\"\
- myqueue2\")\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\210\\\\azure-storage-queue-12.7.1\\\
+ \\samples\\\\queue_samples_service.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # Get the queue client to interact with\
+ \ a specific queue\n queue = queue_service.get_queue_client(queue=\"myqueue2\"\
+ )\n\n ````\n"
- uid: azure.storage.queue.QueueServiceClient.get_service_properties
name: get_service_properties
summary: 'Gets the properties of a storage account''s Queue service, including
@@ -276,11 +280,12 @@ methods:
examples:
- "Getting queue service properties.<!--[!code-python[Main](les\\queue_samples_service.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_service.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n properties = queue_service.get_service_properties()\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_service.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n properties\
+ \ = queue_service.get_service_properties()\n\n ````\n"
- uid: azure.storage.queue.QueueServiceClient.get_service_stats
name: get_service_stats
summary: 'Retrieves statistics related to replication for the Queue service.
@@ -377,13 +382,14 @@ methods:
examples:
- "List queues in the service.<!--[!code-python[Main](les\\queue_samples_service.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_service.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # List all the queues in the service\n list_queues = queue_service.list_queues()\n\
- \ for queue in list_queues:\n print(queue)\n\n # List the queues in\
- \ the service that start with the name \"my\"\n list_my_queues = queue_service.list_queues(name_starts_with=\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_service.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # List all\
+ \ the queues in the service\n list_queues = queue_service.list_queues()\n \
+ \ for queue in list_queues:\n print(queue)\n\n # List the queues in the\
+ \ service that start with the name \"my\"\n list_my_queues = queue_service.list_queues(name_starts_with=\"\
my\")\n for queue in list_my_queues:\n print(queue)\n\n ````\n"
- uid: azure.storage.queue.QueueServiceClient.set_service_properties
name: set_service_properties
@@ -434,14 +440,15 @@ methods:
examples:
- "Setting queue service properties.<!--[!code-python[Main](les\\queue_samples_service.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_service.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # Create service properties\n from azure.storage.queue import QueueAnalyticsLogging,\
- \ Metrics, CorsRule, RetentionPolicy\n\n # Create logging settings\n logging\
- \ = QueueAnalyticsLogging(read=True, write=True, delete=True, retention_policy=RetentionPolicy(enabled=True,\
- \ days=5))\n\n # Create metrics for requests statistics\n hour_metrics = Metrics(enabled=True,\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_service.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # Create service\
+ \ properties\n from azure.storage.queue import QueueAnalyticsLogging, Metrics,\
+ \ CorsRule, RetentionPolicy\n\n # Create logging settings\n logging = QueueAnalyticsLogging(read=True,\
+ \ write=True, delete=True, retention_policy=RetentionPolicy(enabled=True, days=5))\n\
+ \n # Create metrics for requests statistics\n hour_metrics = Metrics(enabled=True,\
\ include_apis=True, retention_policy=RetentionPolicy(enabled=True, days=5))\n\
\ minute_metrics = Metrics(enabled=True, include_apis=True, retention_policy=RetentionPolicy(enabled=True,\
\ days=5))\n\n # Create CORS rules\n cors_rule1 = CorsRule(['www.xyz.com'],\
diff --git a/docs-ref-autogen/azure-storage-queue/azure.storage.queue.aio.QueueClient.yml b/docs-ref-autogen/azure-storage-queue/azure.storage.queue.aio.QueueClient.yml
index ddf4688be8a1..4b5c424bc8e6 100644
--- a/docs-ref-autogen/azure-storage-queue/azure.storage.queue.aio.QueueClient.yml
+++ b/docs-ref-autogen/azure-storage-queue/azure.storage.queue.aio.QueueClient.yml
@@ -75,18 +75,19 @@ constructor:
examples:
- "Create the queue client with url and credential.<!--[!code-python[Main](les\\queue_samples_message_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n token_auth_queue\
- \ = QueueClient.from_queue_url(\n queue_url=queue.url,\n credential=sas_token\n\
- \ )\n\n ````\n\nCreate the queue client with a connection string.<!--[!code-python[Main](les\\\
- queue_samples_message_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\
- \\queue_samples_message_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.storage.queue.aio import QueueClient\n\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\210\\\\azure-storage-queue-12.7.1\\\
+ \\samples\\\\queue_samples_message_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n token_auth_queue = QueueClient.from_queue_url(\n\
+ \ queue_url=queue.url,\n credential=sas_token\n )\n\n ````\n\nCreate\
+ \ the queue client with a connection string.<!--[!code-python[Main](les\\queue_samples_message_async.py\
+ \ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\210\\\\azure-storage-queue-12.7.1\\\
+ \\samples\\\\queue_samples_message_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.storage.queue.aio import QueueClient\n\
\ queue = QueueClient.from_connection_string(self.connection_string, \"myqueue1\"\
)\n\n ````\n"
methods:
@@ -110,8 +111,9 @@ methods:
examples:
- "Clears all messages.<!--[!code-python[Main](les\\queue_samples_message_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n await queue.clear_messages()\n\n ````\n"
@@ -160,8 +162,9 @@ methods:
examples:
- "Create a queue.<!--[!code-python[Main](les\\queue_samples_hello_world_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_hello_world_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_hello_world_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n await queue.create_queue()\n\n ````\n"
@@ -222,8 +225,9 @@ methods:
examples:
- "Delete a message.<!--[!code-python[Main](les\\queue_samples_message_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Get the message at the front of the queue\n messages = queue.receive_messages()\n\
@@ -266,8 +270,9 @@ methods:
examples:
- "Delete a queue.<!--[!code-python[Main](les\\queue_samples_hello_world_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_hello_world_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_hello_world_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n await queue.delete_queue()\n\n ````\n"
@@ -316,13 +321,13 @@ methods:
examples:
- "Create the queue client from connection string.<!--[!code-python[Main](les\\\
queue_samples_message.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\
- \\queue_samples_message.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
- language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.storage.queue import QueueClient\n\
- \ queue = QueueClient.from_connection_string(self.connection_string, \"myqueue1\"\
- )\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.storage.queue import QueueClient\n queue = QueueClient.from_connection_string(self.connection_string,\
+ \ \"myqueue1\")\n\n ````\n"
- uid: azure.storage.queue.aio.QueueClient.from_queue_url
name: from_queue_url
summary: A client to interact with a specific Queue.
@@ -402,8 +407,9 @@ methods:
examples:
- "Get the properties on the queue.<!--[!code-python[Main](les\\queue_samples_message_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n properties = await queue.get_queue_properties()\n\n ````\n"
@@ -469,13 +475,14 @@ methods:
examples:
- "Peek messages.<!--[!code-python[Main](les\\queue_samples_message_async.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # Peek at one message at the front of the queue\n msg = await queue.peek_messages()\n\
- \n # Peek at the last 5 messages\n messages = await queue.peek_messages(max_messages=5)\n\
- \n # Print the last 5 messages\n for message in messages:\n print(message.content)\n\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\210\\\\azure-storage-queue-12.7.1\\\
+ \\samples\\\\queue_samples_message_async.py\", \"xml:space\": \"preserve\", \"\
+ force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n # Peek at one message at the\
+ \ front of the queue\n msg = await queue.peek_messages()\n\n # Peek at the\
+ \ last 5 messages\n messages = await queue.peek_messages(max_messages=5)\n\n\
+ \ # Print the last 5 messages\n for message in messages:\n print(message.content)\n\
\n ````\n"
- uid: azure.storage.queue.aio.QueueClient.receive_message
name: receive_message
@@ -533,8 +540,9 @@ methods:
examples:
- "Receive one message from the queue.<!--[!code-python[Main](les\\queue_samples_message_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Pop two messages from the front of the queue\n message1 = await\
@@ -621,8 +629,9 @@ methods:
examples:
- "Receive messages from the queue.<!--[!code-python[Main](les\\queue_samples_message_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Receive messages one-by-one\n messages = queue.receive_messages()\n \
@@ -710,14 +719,15 @@ methods:
examples:
- "Send messages.<!--[!code-python[Main](les\\queue_samples_message_async.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n await asyncio.gather(\n queue.send_message(\"message1\"),\n queue.send_message(\"\
- message2\", visibility_timeout=30), # wait 30s before becoming visible\n \
- \ queue.send_message(\"message3\"),\n queue.send_message(\"message4\"\
- ),\n queue.send_message(\"message5\")\n )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\210\\\\azure-storage-queue-12.7.1\\\
+ \\samples\\\\queue_samples_message_async.py\", \"xml:space\": \"preserve\", \"\
+ force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n await asyncio.gather(\n \
+ \ queue.send_message(\"message1\"),\n queue.send_message(\"message2\"\
+ , visibility_timeout=30), # wait 30s before becoming visible\n queue.send_message(\"\
+ message3\"),\n queue.send_message(\"message4\"),\n queue.send_message(\"\
+ message5\")\n )\n\n ````\n"
- uid: azure.storage.queue.aio.QueueClient.set_queue_access_policy
name: set_queue_access_policy
summary: 'Sets stored access policies for the queue that may be used with Shared
@@ -772,8 +782,9 @@ methods:
examples:
- "Set an access policy on the queue.<!--[!code-python[Main](les\\queue_samples_message_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Create an access policy\n from azure.storage.queue import AccessPolicy,\
@@ -817,8 +828,9 @@ methods:
examples:
- "Set metadata on the queue.<!--[!code-python[Main](les\\queue_samples_message_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n metadata = {'foo': 'val1', 'bar': 'val2', 'baz': 'val3'}\n await queue.set_queue_metadata(metadata=metadata)\n\
@@ -909,8 +921,9 @@ methods:
examples:
- "Update a message.<!--[!code-python[Main](les\\queue_samples_message_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Send a message\n await queue.send_message(\"update me\")\n\n # Receive\
diff --git a/docs-ref-autogen/azure-storage-queue/azure.storage.queue.aio.QueueServiceClient.yml b/docs-ref-autogen/azure-storage-queue/azure.storage.queue.aio.QueueServiceClient.yml
index f0e13fba13f7..9d5c317efc55 100644
--- a/docs-ref-autogen/azure-storage-queue/azure.storage.queue.aio.QueueServiceClient.yml
+++ b/docs-ref-autogen/azure-storage-queue/azure.storage.queue.aio.QueueServiceClient.yml
@@ -70,24 +70,25 @@ examples:
- "Creating the QueueServiceClient with an account url and credential.<!--[!code-python[Main](les\\\
queue_samples_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\211\\\\azure-storage-queue-12.7.1\\\
- \\samples\\\\queue_samples_authentication_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.storage.queue.aio import\
- \ QueueServiceClient\n queue_service = QueueServiceClient(account_url=self.account_url,\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_authentication_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.storage.queue.aio\
+ \ import QueueServiceClient\n queue_service = QueueServiceClient(account_url=self.account_url,\
\ credential=self.access_key)\n\n ````\n\nCreating the QueueServiceClient with\
\ Azure Identity credentials.<!--[!code-python[Main](les\\queue_samples_authentication_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_authentication_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # Get a token\
- \ credential for authentication\n from azure.identity.aio import ClientSecretCredential\n\
- \ token_credential = ClientSecretCredential(\n self.active_directory_tenant_id,\n\
- \ self.active_directory_application_id,\n self.active_directory_application_secret\n\
- \ )\n\n # Instantiate a QueueServiceClient using a token credential\n from\
- \ azure.storage.queue.aio import QueueServiceClient\n queue_service = QueueServiceClient(account_url=self.account_url,\
- \ credential=token_credential)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\210\\\\azure-storage-queue-12.7.1\\\
+ \\samples\\\\queue_samples_authentication_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n # Get a token credential for authentication\n\
+ \ from azure.identity.aio import ClientSecretCredential\n token_credential =\
+ \ ClientSecretCredential(\n self.active_directory_tenant_id,\n self.active_directory_application_id,\n\
+ \ self.active_directory_application_secret\n )\n\n # Instantiate a QueueServiceClient\
+ \ using a token credential\n from azure.storage.queue.aio import QueueServiceClient\n\
+ \ queue_service = QueueServiceClient(account_url=self.account_url, credential=token_credential)\n\
+ \n ````\n"
methods:
- uid: azure.storage.queue.aio.QueueServiceClient.close
name: close
@@ -129,8 +130,9 @@ methods:
examples:
- "Create a queue in the service.<!--[!code-python[Main](les\\queue_samples_service_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_service_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_service_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n await queue_service.create_queue(\"myqueue1\")\n\n ````\n"
@@ -171,8 +173,9 @@ methods:
examples:
- "Delete a queue in the service.<!--[!code-python[Main](les\\queue_samples_service_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_service_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_service_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n await queue_service.delete_queue(\"myqueue1\")\n\n ````\n"
@@ -216,12 +219,12 @@ methods:
examples:
- "Creating the QueueServiceClient with a connection string.<!--[!code-python[Main](les\\\
queue_samples_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\
- \\queue_samples_authentication.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.storage.queue import QueueServiceClient\n\
- \ queue_service = QueueServiceClient.from_connection_string(conn_str=self.connection_string)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_authentication.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.storage.queue import QueueServiceClient\n queue_service = QueueServiceClient.from_connection_string(conn_str=self.connection_string)\n\
\n ````\n"
- uid: azure.storage.queue.aio.QueueServiceClient.get_queue_client
name: get_queue_client
@@ -247,8 +250,9 @@ methods:
examples:
- "Get the queue client.<!--[!code-python[Main](les\\queue_samples_service_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_service_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_service_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Get the queue client to interact with a specific queue\n queue = queue_service.get_queue_client(queue=\"\
@@ -273,8 +277,9 @@ methods:
examples:
- "Getting queue service properties.<!--[!code-python[Main](les\\queue_samples_service_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_service_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_service_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n properties = await queue_service.get_service_properties()\n\n ````\n"
@@ -374,8 +379,9 @@ methods:
examples:
- "List queues in the service.<!--[!code-python[Main](les\\queue_samples_service_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_service_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_service_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # List all the queues in the service\n list_queues = queue_service.list_queues()\n\
@@ -431,8 +437,9 @@ methods:
examples:
- "Setting queue service properties.<!--[!code-python[Main](les\\queue_samples_service_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_service_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 210\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_service_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # Create service properties\n from azure.storage.queue import QueueAnalyticsLogging,\
diff --git a/docs-ref-autogen/azure-storage-queue/azure.storage.queue.yml b/docs-ref-autogen/azure-storage-queue/azure.storage.queue.yml
index 510c7bd7cbea..a9c81b43ab0d 100644
--- a/docs-ref-autogen/azure-storage-queue/azure.storage.queue.yml
+++ b/docs-ref-autogen/azure-storage-queue/azure.storage.queue.yml
@@ -199,13 +199,14 @@ functions:
examples:
- "Generate a sas token.<!--[!code-python[Main](les\\queue_samples_message.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\211\\\\azure-storage-queue-12.7.1\\\\samples\\\\queue_samples_message.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.storage.queue import generate_queue_sas\n sas_token = generate_queue_sas(\n\
- \ queue.account_name,\n queue.queue_name,\n queue.credential.account_key,\n\
- \ policy_id='my-access-policy-id'\n )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\210\\\\azure-storage-queue-12.7.1\\\
+ \\samples\\\\queue_samples_message.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.storage.queue import generate_queue_sas\n\
+ \ sas_token = generate_queue_sas(\n queue.account_name,\n queue.queue_name,\n\
+ \ queue.credential.account_key,\n policy_id='my-access-policy-id'\n\
+ \ )\n\n ````\n"
classes:
- azure.storage.queue.AccessPolicy
- azure.storage.queue.AccountSasPermissions
diff --git a/docs-ref-autogen/toc.yml b/docs-ref-autogen/toc.yml
index aed439389b10..0c8a4dcc7b5c 100644
--- a/docs-ref-autogen/toc.yml
+++ b/docs-ref-autogen/toc.yml
@@ -24,7 +24,6 @@
- name: adal
uid: adal
name: adal
-
- items:
- name: Overview
uid: project-azure-datalake-store
@@ -103,154 +102,6 @@
- name: azure.datalake.store
uid: azure.datalake.store
name: azure-datalake-store
-
-- items:
- - name: Overview
- uid: project-azure-functions
- - items:
- - name: Overview
- uid: azure.functions.blob
- - name: azure.functions.blob.BlobConverter
- uid: azure.functions.blob.BlobConverter
- - name: azure.functions.blob.InputStream
- uid: azure.functions.blob.InputStream
- name: azure.functions.blob
- - items:
- - name: Overview
- uid: azure.functions.cosmosdb
- - name: azure.functions.cosmosdb.CosmosDBConverter
- uid: azure.functions.cosmosdb.CosmosDBConverter
- - name: azure.functions.cosmosdb.CosmosDBTriggerConverter
- uid: azure.functions.cosmosdb.CosmosDBTriggerConverter
- name: azure.functions.cosmosdb
- - items:
- - name: Overview
- uid: azure.functions.durable_functions
- - name: azure.functions.durable_functions.ActivityTriggerConverter
- uid: azure.functions.durable_functions.ActivityTriggerConverter
- - name: azure.functions.durable_functions.EnitityTriggerConverter
- uid: azure.functions.durable_functions.EnitityTriggerConverter
- - name: azure.functions.durable_functions.OrchestrationTriggerConverter
- uid: azure.functions.durable_functions.OrchestrationTriggerConverter
- name: azure.functions.durable_functions
- - items:
- - name: Overview
- uid: azure.functions.eventgrid
- - name: azure.functions.eventgrid.EventGridEventInConverter
- uid: azure.functions.eventgrid.EventGridEventInConverter
- - name: azure.functions.eventgrid.EventGridEventOutConverter
- uid: azure.functions.eventgrid.EventGridEventOutConverter
- name: azure.functions.eventgrid
- - items:
- - name: Overview
- uid: azure.functions.eventhub
- - name: azure.functions.eventhub.EventHubConverter
- uid: azure.functions.eventhub.EventHubConverter
- - name: azure.functions.eventhub.EventHubTriggerConverter
- uid: azure.functions.eventhub.EventHubTriggerConverter
- name: azure.functions.eventhub
- - items:
- - name: Overview
- uid: azure.functions.http
- - name: azure.functions.http.HttpRequest
- uid: azure.functions.http.HttpRequest
- - name: azure.functions.http.HttpRequestConverter
- uid: azure.functions.http.HttpRequestConverter
- - name: azure.functions.http.HttpResponseConverter
- uid: azure.functions.http.HttpResponseConverter
- name: azure.functions.http
- - items:
- - name: Overview
- uid: azure.functions.kafka
- - name: azure.functions.kafka.KafkaConverter
- uid: azure.functions.kafka.KafkaConverter
- - name: azure.functions.kafka.KafkaEvent
- uid: azure.functions.kafka.KafkaEvent
- - name: azure.functions.kafka.KafkaTriggerConverter
- uid: azure.functions.kafka.KafkaTriggerConverter
- name: azure.functions.kafka
- - items:
- - name: Overview
- uid: azure.functions.meta
- - name: azure.functions.meta.Datum
- uid: azure.functions.meta.Datum
- - name: azure.functions.meta.InConverter
- uid: azure.functions.meta.InConverter
- - name: azure.functions.meta.OutConverter
- uid: azure.functions.meta.OutConverter
- name: azure.functions.meta
- - items:
- - name: Overview
- uid: azure.functions.queue
- - name: azure.functions.queue.QueueMessage
- uid: azure.functions.queue.QueueMessage
- - name: azure.functions.queue.QueueMessageInConverter
- uid: azure.functions.queue.QueueMessageInConverter
- - name: azure.functions.queue.QueueMessageOutConverter
- uid: azure.functions.queue.QueueMessageOutConverter
- name: azure.functions.queue
- - items:
- - name: Overview
- uid: azure.functions.servicebus
- - name: azure.functions.servicebus.ServiceBusMessage
- uid: azure.functions.servicebus.ServiceBusMessage
- - name: azure.functions.servicebus.ServiceBusMessageInConverter
- uid: azure.functions.servicebus.ServiceBusMessageInConverter
- - name: azure.functions.servicebus.ServiceBusMessageOutConverter
- uid: azure.functions.servicebus.ServiceBusMessageOutConverter
- name: azure.functions.servicebus
- - items:
- - name: Overview
- uid: azure.functions.timer
- - name: azure.functions.timer.TimerRequest
- uid: azure.functions.timer.TimerRequest
- - name: azure.functions.timer.TimerRequestConverter
- uid: azure.functions.timer.TimerRequestConverter
- name: azure.functions.timer
- - items:
- - name: Overview
- uid: azure.functions
- - name: azure.functions.Context
- uid: azure.functions.Context
- - name: azure.functions.Document
- uid: azure.functions.Document
- - name: azure.functions.DocumentList
- uid: azure.functions.DocumentList
- - name: azure.functions.EntityContext
- uid: azure.functions.EntityContext
- - name: azure.functions.EventGridEvent
- uid: azure.functions.EventGridEvent
- - name: azure.functions.EventGridOutputEvent
- uid: azure.functions.EventGridOutputEvent
- - name: azure.functions.EventHubEvent
- uid: azure.functions.EventHubEvent
- - name: azure.functions.HttpRequest
- uid: azure.functions.HttpRequest
- - name: azure.functions.HttpResponse
- uid: azure.functions.HttpResponse
- - name: azure.functions.InputStream
- uid: azure.functions.InputStream
- - name: azure.functions.KafkaConverter
- uid: azure.functions.KafkaConverter
- - name: azure.functions.KafkaEvent
- uid: azure.functions.KafkaEvent
- - name: azure.functions.KafkaTriggerConverter
- uid: azure.functions.KafkaTriggerConverter
- - name: azure.functions.OrchestrationContext
- uid: azure.functions.OrchestrationContext
- - name: azure.functions.Out
- uid: azure.functions.Out
- - name: azure.functions.QueueMessage
- uid: azure.functions.QueueMessage
- - name: azure.functions.ServiceBusMessage
- uid: azure.functions.ServiceBusMessage
- - name: azure.functions.TimerRequest
- uid: azure.functions.TimerRequest
- - name: azure.functions.WsgiMiddleware
- uid: azure.functions.WsgiMiddleware
- name: azure.functions
- name: azure-functions
-
- items:
- name: Overview
uid: project-azure-functions-durable
@@ -527,7 +378,6 @@
uid: azure.durable_functions.RetryOptions
name: azure.durable_functions
name: azure-functions-durable
-
- items:
- name: Overview
uid: project-azure-mgmt-mixedreality
@@ -612,7 +462,6 @@
uid: azure.mgmt.mixedreality.MixedRealityClientConfiguration
name: azure.mgmt.mixedreality
name: azure-mgmt-mixedreality
-
- items:
- name: Overview
uid: project-azure-storage-file
@@ -667,7 +516,6 @@
- name: azure.storage.file
uid: azure.storage.file
name: azure-storage-file
-
- items:
- name: Overview
uid: project-azure-ai-formrecognizer
@@ -828,7 +676,6 @@
uid: azure.ai.formrecognizer.TrainingStatus
name: azure.ai.formrecognizer
name: azure-ai-formrecognizer
-
- items:
- name: Overview
uid: project-azure-ai-language-conversations
@@ -857,7 +704,6 @@
uid: azure.ai.language.conversations.ConversationAnalysisClient
name: azure.ai.language.conversations
name: azure-ai-language-conversations
-
- items:
- name: Overview
uid: project-azure-ai-language-questionanswering
@@ -928,7 +774,6 @@
uid: azure.ai.language.questionanswering.QuestionAnsweringClient
name: azure.ai.language.questionanswering
name: azure-ai-language-questionanswering
-
- items:
- name: Overview
uid: project-azure-ai-metricsadvisor
@@ -1107,7 +952,6 @@
uid: azure.ai.metricsadvisor.MetricsAdvisorKeyCredential
name: azure.ai.metricsadvisor
name: azure-ai-metricsadvisor
-
- items:
- name: Overview
uid: project-azure-ai-ml
@@ -1902,7 +1746,6 @@
uid: azure.ai.ml.UserIdentityConfiguration
name: azure.ai.ml
name: azure-ai-ml
-
- items:
- name: Overview
uid: project-azure-ai-textanalytics
@@ -2045,7 +1888,6 @@
uid: azure.ai.textanalytics.TextDocumentStatistics
name: azure.ai.textanalytics
name: azure-ai-textanalytics
-
- items:
- name: Overview
uid: project-azure-ai-translation-document
@@ -2084,7 +1926,6 @@
uid: azure.ai.translation.document.TranslationTarget
name: azure.ai.translation.document
name: azure-ai-translation-document
-
- items:
- name: Overview
uid: project-azure-appconfiguration
@@ -2109,7 +1950,6 @@
uid: azure.appconfiguration.SecretReferenceConfigurationSetting
name: azure.appconfiguration
name: azure-appconfiguration
-
- items:
- name: Overview
uid: project-azure-appconfiguration-provider
@@ -2130,7 +1970,6 @@
uid: azure.appconfiguration.provider.SettingSelector
name: azure.appconfiguration.provider
name: azure-appconfiguration-provider
-
- items:
- name: Overview
uid: project-azure-batch
@@ -2759,7 +2598,6 @@
uid: azure.batch.BatchServiceClientConfiguration
name: azure.batch
name: azure-batch
-
- items:
- name: Overview
uid: project-azure-cognitiveservices-language-spellcheck
@@ -2814,7 +2652,6 @@
uid: azure.cognitiveservices.language.spellcheck.SpellCheckClientConfiguration
name: azure.cognitiveservices.language.spellcheck
name: azure-cognitiveservices-language-spellcheck
-
- items:
- name: Overview
uid: project-azure-cognitiveservices-search-entitysearch
@@ -2933,7 +2770,6 @@
uid: azure.cognitiveservices.search.entitysearch.EntitySearchClientConfiguration
name: azure.cognitiveservices.search.entitysearch
name: azure-cognitiveservices-search-entitysearch
-
- items:
- name: Overview
uid: project-azure-cognitiveservices-search-imagesearch
@@ -3076,7 +2912,6 @@
uid: azure.cognitiveservices.search.imagesearch.ImageSearchClientConfiguration
name: azure.cognitiveservices.search.imagesearch
name: azure-cognitiveservices-search-imagesearch
-
- items:
- name: Overview
uid: project-azure-cognitiveservices-search-newssearch
@@ -3151,7 +2986,6 @@
uid: azure.cognitiveservices.search.newssearch.NewsSearchClientConfiguration
name: azure.cognitiveservices.search.newssearch
name: azure-cognitiveservices-search-newssearch
-
- items:
- name: Overview
uid: project-azure-cognitiveservices-search-videosearch
@@ -3242,7 +3076,6 @@
uid: azure.cognitiveservices.search.videosearch.VideoSearchClientConfiguration
name: azure.cognitiveservices.search.videosearch
name: azure-cognitiveservices-search-videosearch
-
- items:
- name: Overview
uid: project-azure-cognitiveservices-search-websearch
@@ -3351,7 +3184,6 @@
uid: azure.cognitiveservices.search.websearch.WebSearchClientConfiguration
name: azure.cognitiveservices.search.websearch
name: azure-cognitiveservices-search-websearch
-
- items:
- name: Overview
uid: project-azure-cognitiveservices-speech
@@ -3626,7 +3458,6 @@
uid: azure.cognitiveservices.speech.VoiceInfo
name: azure.cognitiveservices.speech
name: azure-cognitiveservices-speech
-
- items:
- name: Overview
uid: project-azure-cognitiveservices-vision-contentmoderator
@@ -3827,7 +3658,6 @@
uid: azure.cognitiveservices.vision.contentmoderator.ContentModeratorClient
name: azure.cognitiveservices.vision.contentmoderator
name: azure-cognitiveservices-vision-contentmoderator
-
- items:
- name: Overview
uid: project-azure-cognitiveservices-vision-customvision
@@ -4026,7 +3856,6 @@
name: azure.cognitiveservices.vision.customvision.training
name: azure.cognitiveservices.vision.customvision
name: azure-cognitiveservices-vision-customvision
-
- items:
- name: Overview
uid: project-azure-communication-callautomation
@@ -4103,7 +3932,6 @@
uid: azure.communication.callautomation.UnknownIdentifier
name: azure.communication.callautomation
name: azure-communication-callautomation
-
- items:
- name: Overview
uid: project-azure-communication-chat
@@ -4166,7 +3994,6 @@
uid: azure.communication.chat.UnknownIdentifier
name: azure.communication.chat
name: azure-communication-chat
-
- items:
- name: Overview
uid: project-azure-communication-email
@@ -4183,7 +4010,6 @@
uid: azure.communication.email.EmailClient
name: azure.communication.email
name: azure-communication-email
-
- items:
- name: Overview
uid: project-azure-communication-identity
@@ -4222,7 +4048,6 @@
uid: azure.communication.identity.UnknownIdentifier
name: azure.communication.identity
name: azure-communication-identity
-
- items:
- name: Overview
uid: project-azure-communication-networktraversal
@@ -4237,7 +4062,6 @@
name: azure.communication.networktraversal.aio
name: azure.communication.networktraversal
name: azure-communication-networktraversal
-
- items:
- name: Overview
uid: project-azure-communication-phonenumbers
@@ -4296,7 +4120,6 @@
uid: azure.communication.phonenumbers.PurchasedPhoneNumber
name: azure.communication.phonenumbers
name: azure-communication-phonenumbers
-
- items:
- name: Overview
uid: project-azure-communication-rooms
@@ -4343,7 +4166,6 @@
uid: azure.communication.rooms.UnknownIdentifier
name: azure.communication.rooms
name: azure-communication-rooms
-
- items:
- name: Overview
uid: project-azure-communication-sms
@@ -4362,7 +4184,6 @@
uid: azure.communication.sms.SmsSendResult
name: azure.communication.sms
name: azure-communication-sms
-
- items:
- name: Overview
uid: project-azure-confidentialledger
@@ -4395,7 +4216,6 @@
uid: azure.confidentialledger.ConfidentialLedgerClient
name: azure.confidentialledger
name: azure-confidentialledger
-
- items:
- name: Overview
uid: project-azure-containerregistry
@@ -4434,7 +4254,6 @@
uid: azure.containerregistry.RepositoryProperties
name: azure.containerregistry
name: azure-containerregistry
-
- items:
- name: Overview
uid: project-azure-core
@@ -4721,7 +4540,6 @@
uid: azure.core.PipelineClient
name: azure.core
name: azure-core
-
- items:
- name: Overview
uid: project-azure-cosmos
@@ -4920,7 +4738,6 @@
uid: azure.cosmos.UserProxy
name: azure.cosmos
name: azure-cosmos
-
- items:
- name: Overview
uid: project-azure-cosmosdb-table
@@ -5041,7 +4858,6 @@
uid: azure.cosmosdb.table.common
name: azure.cosmosdb.table
name: azure-cosmosdb-table
-
- items:
- name: Overview
uid: project-azure-data-tables
@@ -5098,7 +4914,6 @@
uid: azure.data.tables.UpdateMode
name: azure.data.tables
name: azure-data-tables
-
- items:
- name: Overview
uid: project-azure-developer-loadtesting
@@ -5119,7 +4934,6 @@
uid: azure.developer.loadtesting.LoadTestRunClient
name: azure.developer.loadtesting
name: azure-developer-loadtesting
-
- items:
- name: Overview
uid: project-azure-digitaltwins-core
@@ -5142,7 +4956,6 @@
uid: azure.digitaltwins.core.IncomingRelationship
name: azure.digitaltwins.core
name: azure-digitaltwins-core
-
- items:
- name: Overview
uid: project-azure-eventgrid
@@ -5163,7 +4976,6 @@
uid: azure.eventgrid.SystemEventNames
name: azure.eventgrid
name: azure-eventgrid
-
- items:
- name: Overview
uid: project-azure-eventhub
@@ -5218,6 +5030,8 @@
- name: azure.eventhub.amqp.AmqpMessageProperties
uid: azure.eventhub.amqp.AmqpMessageProperties
name: azure.eventhub.amqp
+ - name: azure.eventhub.extensions
+ uid: azure.eventhub.extensions
- name: azure.eventhub.CheckpointStore
uid: azure.eventhub.CheckpointStore
- name: azure.eventhub.CloseReason
@@ -5242,29 +5056,34 @@
uid: azure.eventhub.TransportType
name: azure.eventhub
name: azure-eventhub
-
- items:
- name: Overview
uid: project-azure-eventhub-checkpointstoreblob
- items:
- name: Overview
- uid: azure.eventhub.extensions.checkpointstoreblob
- - name: azure.eventhub.extensions.checkpointstoreblob.BlobCheckpointStore
- uid: azure.eventhub.extensions.checkpointstoreblob.BlobCheckpointStore
- name: azure.eventhub.extensions.checkpointstoreblob
+ uid: azure.eventhub.extensions
+ - items:
+ - name: Overview
+ uid: azure.eventhub.extensions.checkpointstoreblob
+ - name: azure.eventhub.extensions.checkpointstoreblob.BlobCheckpointStore
+ uid: azure.eventhub.extensions.checkpointstoreblob.BlobCheckpointStore
+ name: azure.eventhub.extensions.checkpointstoreblob
+ name: azure.eventhub.extensions
name: azure-eventhub-checkpointstoreblob
-
- items:
- name: Overview
uid: project-azure-eventhub-checkpointstoreblob-aio
- items:
- name: Overview
- uid: azure.eventhub.extensions.checkpointstoreblobaio
- - name: azure.eventhub.extensions.checkpointstoreblobaio.BlobCheckpointStore
- uid: azure.eventhub.extensions.checkpointstoreblobaio.BlobCheckpointStore
- name: azure.eventhub.extensions.checkpointstoreblobaio
+ uid: azure.eventhub.extensions
+ - items:
+ - name: Overview
+ uid: azure.eventhub.extensions.checkpointstoreblobaio
+ - name: azure.eventhub.extensions.checkpointstoreblobaio.BlobCheckpointStore
+ uid: azure.eventhub.extensions.checkpointstoreblobaio.BlobCheckpointStore
+ name: azure.eventhub.extensions.checkpointstoreblobaio
+ name: azure.eventhub.extensions
name: azure-eventhub-checkpointstoreblob-aio
-
- items:
- name: Overview
uid: project-azure-functions
@@ -5411,7 +5230,6 @@
uid: azure.functions.WsgiMiddleware
name: azure.functions
name: azure-functions
-
- items:
- name: Overview
uid: project-azure-identity
@@ -5502,7 +5320,6 @@
uid: azure.identity.WorkloadIdentityCredential
name: azure.identity
name: azure-identity
-
- items:
- name: Overview
uid: project-azure-iot-device
@@ -5565,7 +5382,6 @@
uid: azure.iot.device.X509
name: azure.iot.device
name: azure-iot-device
-
- items:
- name: Overview
uid: project-azure-iot-deviceupdate
@@ -5598,7 +5414,6 @@
uid: azure.iot.deviceupdate.DeviceUpdateClient
name: azure.iot.deviceupdate
name: azure-iot-deviceupdate
-
- items:
- name: Overview
uid: project-azure-iot-hub
@@ -6201,7 +6016,6 @@
uid: azure.iot.hub.IoTHubRegistryManager
name: azure.iot.hub
name: azure-iot-hub
-
- items:
- name: Overview
uid: project-azure-keyvault-administration
@@ -6246,7 +6060,6 @@
uid: azure.keyvault.administration.KeyVaultSettingsClient
name: azure.keyvault.administration
name: azure-keyvault-administration
-
- items:
- name: Overview
uid: project-azure-keyvault-certificates
@@ -6301,7 +6114,6 @@
uid: azure.keyvault.certificates.WellKnownIssuerNames
name: azure.keyvault.certificates
name: azure-keyvault-certificates
-
- items:
- name: Overview
uid: project-azure-keyvault-keys
@@ -6390,7 +6202,6 @@
uid: azure.keyvault.keys.ReleaseKeyResult
name: azure.keyvault.keys
name: azure-keyvault-keys
-
- items:
- name: Overview
uid: project-azure-keyvault-secrets
@@ -6417,7 +6228,6 @@
uid: azure.keyvault.secrets.SecretProperties
name: azure.keyvault.secrets
name: azure-keyvault-secrets
-
- items:
- name: Overview
uid: project-azure-messaging-webpubsubservice
@@ -6434,7 +6244,6 @@
uid: azure.messaging.webpubsubservice.WebPubSubServiceClient
name: azure.messaging.webpubsubservice
name: azure-messaging-webpubsubservice
-
- items:
- name: Overview
uid: project-azure-mgmt-advisor
@@ -6533,7 +6342,6 @@
uid: azure.mgmt.advisor.AdvisorManagementClient
name: azure.mgmt.advisor
name: azure-mgmt-advisor
-
- items:
- name: Overview
uid: project-azure-mgmt-alertsmanagement
@@ -6726,7 +6534,6 @@
uid: azure.mgmt.alertsmanagement.AlertsManagementClient
name: azure.mgmt.alertsmanagement
name: azure-mgmt-alertsmanagement
-
- items:
- name: Overview
uid: project-azure-mgmt-appconfiguration
@@ -7173,7 +6980,6 @@
uid: azure.mgmt.appconfiguration.AppConfigurationManagementClient
name: azure.mgmt.appconfiguration
name: azure-mgmt-appconfiguration
-
- items:
- name: Overview
uid: project-azure-mgmt-appcontainers
@@ -7724,7 +7530,6 @@
uid: azure.mgmt.appcontainers.ContainerAppsAPIClient
name: azure.mgmt.appcontainers
name: azure-mgmt-appcontainers
-
- items:
- name: Overview
uid: project-azure-mgmt-applicationinsights
@@ -8753,7 +8558,6 @@
uid: azure.mgmt.applicationinsights.ApplicationInsightsManagementClient
name: azure.mgmt.applicationinsights
name: azure-mgmt-applicationinsights
-
- items:
- name: Overview
uid: project-azure-mgmt-appplatform
@@ -14204,7 +14008,6 @@
uid: azure.mgmt.appplatform.AppPlatformManagementClient
name: azure.mgmt.appplatform
name: azure-mgmt-appplatform
-
- items:
- name: Overview
uid: project-azure-mgmt-attestation
@@ -14269,7 +14072,6 @@
uid: azure.mgmt.attestation.AttestationManagementClient
name: azure.mgmt.attestation
name: azure-mgmt-attestation
-
- items:
- name: Overview
uid: project-azure-mgmt-authorization
@@ -16136,7 +15938,6 @@
uid: azure.mgmt.authorization.AuthorizationManagementClient
name: azure.mgmt.authorization
name: azure-mgmt-authorization
-
- items:
- name: Overview
uid: project-azure-mgmt-automanage
@@ -16269,7 +16070,6 @@
uid: azure.mgmt.automanage.AutomanageClient
name: azure.mgmt.automanage
name: azure-mgmt-automanage
-
- items:
- name: Overview
uid: project-azure-mgmt-automation
@@ -16840,7 +16640,6 @@
uid: azure.mgmt.automation.AutomationClient
name: azure.mgmt.automation
name: azure-mgmt-automation
-
- items:
- name: Overview
uid: project-azure-mgmt-avs
@@ -17239,7 +17038,6 @@
uid: azure.mgmt.avs.AVSClient
name: azure.mgmt.avs
name: azure-mgmt-avs
-
- items:
- name: Overview
uid: project-azure-mgmt-azurearcdata
@@ -17382,7 +17180,6 @@
uid: azure.mgmt.azurearcdata.AzureArcDataManagementClient
name: azure.mgmt.azurearcdata
name: azure-mgmt-azurearcdata
-
- items:
- name: Overview
uid: project-azure-mgmt-azurestack
@@ -17519,7 +17316,6 @@
uid: azure.mgmt.azurestack.AzureStackManagementClient
name: azure.mgmt.azurestack
name: azure-mgmt-azurestack
-
- items:
- name: Overview
uid: project-azure-mgmt-azurestackhci
@@ -17644,7 +17440,6 @@
uid: azure.mgmt.azurestackhci.AzureStackHCIClient
name: azure.mgmt.azurestackhci
name: azure-mgmt-azurestackhci
-
- items:
- name: Overview
uid: project-azure-mgmt-baremetalinfrastructure
@@ -17727,7 +17522,6 @@
uid: azure.mgmt.baremetalinfrastructure.BareMetalInfrastructureClient
name: azure.mgmt.baremetalinfrastructure
name: azure-mgmt-baremetalinfrastructure
-
- items:
- name: Overview
uid: project-azure-mgmt-batch
@@ -18066,7 +17860,6 @@
uid: azure.mgmt.batch.BatchManagementClient
name: azure.mgmt.batch
name: azure-mgmt-batch
-
- items:
- name: Overview
uid: project-azure-mgmt-billing
@@ -18399,7 +18192,6 @@
uid: azure.mgmt.billing.BillingManagementClient
name: azure.mgmt.billing
name: azure-mgmt-billing
-
- items:
- name: Overview
uid: project-azure-mgmt-botservice
@@ -18660,7 +18452,6 @@
uid: azure.mgmt.botservice.AzureBotService
name: azure.mgmt.botservice
name: azure-mgmt-botservice
-
- items:
- name: Overview
uid: project-azure-mgmt-cdn
@@ -19467,7 +19258,6 @@
uid: azure.mgmt.cdn.CdnManagementClient
name: azure.mgmt.cdn
name: azure-mgmt-cdn
-
- items:
- name: Overview
uid: project-azure-mgmt-changeanalysis
@@ -19538,7 +19328,6 @@
uid: azure.mgmt.changeanalysis.AzureChangeAnalysisManagementClient
name: azure.mgmt.changeanalysis
name: azure-mgmt-changeanalysis
-
- items:
- name: Overview
uid: project-azure-mgmt-cognitiveservices
@@ -19825,7 +19614,6 @@
uid: azure.mgmt.cognitiveservices.CognitiveServicesManagementClient
name: azure.mgmt.cognitiveservices
name: azure-mgmt-cognitiveservices
-
- items:
- name: Overview
uid: project-azure-mgmt-commerce
@@ -19888,7 +19676,6 @@
uid: azure.mgmt.commerce.UsageManagementClient
name: azure.mgmt.commerce
name: azure-mgmt-commerce
-
- items:
- name: Overview
uid: project-azure-mgmt-communication
@@ -20031,7 +19818,6 @@
uid: azure.mgmt.communication.CommunicationServiceManagementClient
name: azure.mgmt.communication
name: azure-mgmt-communication
-
- items:
- name: Overview
uid: project-azure-mgmt-compute
@@ -20040,8 +19826,6 @@
- items:
- name: Overview
uid: azure.mgmt.compute
- - name: azure.mgmt.compute.ComputeManagementClient
- uid: azure.mgmt.compute.ComputeManagementClient
- items:
- name: Overview
uid: azure.mgmt.compute.aio
@@ -35934,9 +35718,10 @@
- name: azure.mgmt.compute.v2023_03_01.ComputeManagementClient
uid: azure.mgmt.compute.v2023_03_01.ComputeManagementClient
name: azure.mgmt.compute.v2023_03_01
+ - name: azure.mgmt.compute.ComputeManagementClient
+ uid: azure.mgmt.compute.ComputeManagementClient
name: azure.mgmt.compute
name: azure-mgmt-compute
-
- items:
- name: Overview
uid: project-azure-mgmt-confidentialledger
@@ -36021,7 +35806,6 @@
uid: azure.mgmt.confidentialledger.ConfidentialLedger
name: azure.mgmt.confidentialledger
name: azure-mgmt-confidentialledger
-
- items:
- name: Overview
uid: project-azure-mgmt-confluent
@@ -36098,7 +35882,6 @@
uid: azure.mgmt.confluent.ConfluentManagementClient
name: azure.mgmt.confluent
name: azure-mgmt-confluent
-
- items:
- name: Overview
uid: project-azure-mgmt-consumption
@@ -36377,7 +36160,6 @@
uid: azure.mgmt.consumption.ConsumptionManagementClient
name: azure.mgmt.consumption
name: azure-mgmt-consumption
-
- items:
- name: Overview
uid: project-azure-mgmt-containerinstance
@@ -36564,7 +36346,6 @@
uid: azure.mgmt.containerinstance.ContainerInstanceManagementClient
name: azure.mgmt.containerinstance
name: azure-mgmt-containerinstance
-
- items:
- name: Overview
uid: project-azure-mgmt-containerregistry
@@ -36573,8 +36354,6 @@
- items:
- name: Overview
uid: azure.mgmt.containerregistry
- - name: azure.mgmt.containerregistry.ContainerRegistryManagementClient
- uid: azure.mgmt.containerregistry.ContainerRegistryManagementClient
- items:
- name: Overview
uid: azure.mgmt.containerregistry.aio
@@ -40583,9 +40362,10 @@
- name: azure.mgmt.containerregistry.v2023_01_01_preview.ContainerRegistryManagementClient
uid: azure.mgmt.containerregistry.v2023_01_01_preview.ContainerRegistryManagementClient
name: azure.mgmt.containerregistry.v2023_01_01_preview
+ - name: azure.mgmt.containerregistry.ContainerRegistryManagementClient
+ uid: azure.mgmt.containerregistry.ContainerRegistryManagementClient
name: azure.mgmt.containerregistry
name: azure-mgmt-containerregistry
-
- items:
- name: Overview
uid: project-azure-mgmt-containerservice
@@ -40594,8 +40374,6 @@
- items:
- name: Overview
uid: azure.mgmt.containerservice
- - name: azure.mgmt.containerservice.ContainerServiceClient
- uid: azure.mgmt.containerservice.ContainerServiceClient
- items:
- name: Overview
uid: azure.mgmt.containerservice.aio
@@ -57938,9 +57716,10 @@
- name: azure.mgmt.containerservice.v2023_07_01.ContainerServiceClient
uid: azure.mgmt.containerservice.v2023_07_01.ContainerServiceClient
name: azure.mgmt.containerservice.v2023_07_01
+ - name: azure.mgmt.containerservice.ContainerServiceClient
+ uid: azure.mgmt.containerservice.ContainerServiceClient
name: azure.mgmt.containerservice
name: azure-mgmt-containerservice
-
- items:
- name: Overview
uid: project-azure-mgmt-core
@@ -57999,7 +57778,6 @@
uid: azure.mgmt.core.AsyncARMPipelineClient
name: azure.mgmt.core
name: azure-mgmt-core
-
- items:
- name: Overview
uid: project-azure-mgmt-cosmosdb
@@ -58798,7 +58576,6 @@
uid: azure.mgmt.cosmosdb.CosmosDBManagementClient
name: azure.mgmt.cosmosdb
name: azure-mgmt-cosmosdb
-
- items:
- name: Overview
uid: project-azure-mgmt-costmanagement
@@ -59207,7 +58984,6 @@
uid: azure.mgmt.costmanagement.CostManagementClient
name: azure.mgmt.costmanagement
name: azure-mgmt-costmanagement
-
- items:
- name: Overview
uid: project-azure-mgmt-customproviders
@@ -59286,7 +59062,6 @@
uid: azure.mgmt.customproviders.Customproviders
name: azure.mgmt.customproviders
name: azure-mgmt-customproviders
-
- items:
- name: Overview
uid: project-azure-mgmt-dashboard
@@ -59403,7 +59178,6 @@
uid: azure.mgmt.dashboard.DashboardManagementClient
name: azure.mgmt.dashboard
name: azure-mgmt-dashboard
-
- items:
- name: Overview
uid: project-azure-mgmt-databox
@@ -63030,7 +62804,6 @@
uid: azure.mgmt.databox.DataBoxManagementClient
name: azure.mgmt.databox
name: azure-mgmt-databox
-
- items:
- name: Overview
uid: project-azure-mgmt-databoxedge
@@ -66051,7 +65824,6 @@
uid: azure.mgmt.databoxedge.DataBoxEdgeManagementClient
name: azure.mgmt.databoxedge
name: azure-mgmt-databoxedge
-
- items:
- name: Overview
uid: project-azure-mgmt-databricks
@@ -66232,7 +66004,6 @@
uid: azure.mgmt.databricks.AzureDatabricksManagementClient
name: azure.mgmt.databricks
name: azure-mgmt-databricks
-
- items:
- name: Overview
uid: project-azure-mgmt-datadog
@@ -66377,7 +66148,6 @@
uid: azure.mgmt.datadog.MicrosoftDatadogClient
name: azure.mgmt.datadog
name: azure-mgmt-datadog
-
- items:
- name: Overview
uid: project-azure-mgmt-datafactory
@@ -68174,7 +67944,6 @@
uid: azure.mgmt.datafactory.DataFactoryManagementClient
name: azure.mgmt.datafactory
name: azure-mgmt-datafactory
-
- items:
- name: Overview
uid: project-azure-mgmt-datamigration
@@ -68897,7 +68666,6 @@
uid: azure.mgmt.datamigration.DataMigrationManagementClient
name: azure.mgmt.datamigration
name: azure-mgmt-datamigration
-
- items:
- name: Overview
uid: project-azure-mgmt-dataprotection
@@ -69358,7 +69126,6 @@
uid: azure.mgmt.dataprotection.DataProtectionMgmtClient
name: azure.mgmt.dataprotection
name: azure-mgmt-dataprotection
-
- items:
- name: Overview
uid: project-azure-mgmt-datashare
@@ -69619,7 +69386,6 @@
uid: azure.mgmt.datashare.DataShareManagementClient
name: azure.mgmt.datashare
name: azure-mgmt-datashare
-
- items:
- name: Overview
uid: project-azure-mgmt-deploymentmanager
@@ -69788,7 +69554,6 @@
uid: azure.mgmt.deploymentmanager.AzureDeploymentManager
name: azure.mgmt.deploymentmanager
name: azure-mgmt-deploymentmanager
-
- items:
- name: Overview
uid: project-azure-mgmt-desktopvirtualization
@@ -70043,7 +69808,6 @@
uid: azure.mgmt.desktopvirtualization.DesktopVirtualizationMgmtClient
name: azure.mgmt.desktopvirtualization
name: azure-mgmt-desktopvirtualization
-
- items:
- name: Overview
uid: project-azure-mgmt-devcenter
@@ -70376,7 +70140,6 @@
uid: azure.mgmt.devcenter.DevCenterMgmtClient
name: azure.mgmt.devcenter
name: azure-mgmt-devcenter
-
- items:
- name: Overview
uid: project-azure-mgmt-deviceupdate
@@ -70545,7 +70308,6 @@
uid: azure.mgmt.deviceupdate.DeviceUpdateMgmtClient
name: azure.mgmt.deviceupdate
name: azure-mgmt-deviceupdate
-
- items:
- name: Overview
uid: project-azure-mgmt-devtestlabs
@@ -71052,7 +70814,6 @@
uid: azure.mgmt.devtestlabs.DevTestLabsClient
name: azure.mgmt.devtestlabs
name: azure-mgmt-devtestlabs
-
- items:
- name: Overview
uid: project-azure-mgmt-digitaltwins
@@ -71937,7 +71698,6 @@
uid: azure.mgmt.digitaltwins.AzureDigitalTwinsManagementClient
name: azure.mgmt.digitaltwins
name: azure-mgmt-digitaltwins
-
- items:
- name: Overview
uid: project-azure-mgmt-dns
@@ -72302,7 +72062,6 @@
uid: azure.mgmt.dns.DnsManagementClient
name: azure.mgmt.dns
name: azure-mgmt-dns
-
- items:
- name: Overview
uid: project-azure-mgmt-dnsresolver
@@ -72423,7 +72182,6 @@
uid: azure.mgmt.dnsresolver.DnsResolverManagementClient
name: azure.mgmt.dnsresolver
name: azure-mgmt-dnsresolver
-
- items:
- name: Overview
uid: project-azure-mgmt-dynatrace
@@ -72596,7 +72354,6 @@
uid: azure.mgmt.dynatrace.DynatraceObservabilityMgmtClient
name: azure.mgmt.dynatrace
name: azure-mgmt-dynatrace
-
- items:
- name: Overview
uid: project-azure-mgmt-edgeorder
@@ -73059,7 +72816,6 @@
uid: azure.mgmt.edgeorder.EdgeOrderManagementClient
name: azure.mgmt.edgeorder
name: azure-mgmt-edgeorder
-
- items:
- name: Overview
uid: project-azure-mgmt-elastic
@@ -73196,7 +72952,6 @@
uid: azure.mgmt.elastic.MicrosoftElastic
name: azure.mgmt.elastic
name: azure-mgmt-elastic
-
- items:
- name: Overview
uid: project-azure-mgmt-eventgrid
@@ -73593,7 +73348,6 @@
uid: azure.mgmt.eventgrid.EventGridManagementClient
name: azure.mgmt.eventgrid
name: azure-mgmt-eventgrid
-
- items:
- name: Overview
uid: project-azure-mgmt-eventhub
@@ -75126,7 +74880,6 @@
uid: azure.mgmt.eventhub.EventHubManagementClient
name: azure.mgmt.eventhub
name: azure-mgmt-eventhub
-
- items:
- name: Overview
uid: project-azure-mgmt-extendedlocation
@@ -75363,7 +75116,6 @@
uid: azure.mgmt.extendedlocation.CustomLocations
name: azure.mgmt.extendedlocation
name: azure-mgmt-extendedlocation
-
- items:
- name: Overview
uid: project-azure-mgmt-fluidrelay
@@ -75462,7 +75214,6 @@
uid: azure.mgmt.fluidrelay.FluidRelayManagementClient
name: azure.mgmt.fluidrelay
name: azure-mgmt-fluidrelay
-
- items:
- name: Overview
uid: project-azure-mgmt-frontdoor
@@ -75817,7 +75568,6 @@
uid: azure.mgmt.frontdoor.FrontDoorManagementClient
name: azure.mgmt.frontdoor
name: azure-mgmt-frontdoor
-
- items:
- name: Overview
uid: project-azure-mgmt-graphservices
@@ -75888,7 +75638,6 @@
uid: azure.mgmt.graphservices.GraphServicesMgmtClient
name: azure.mgmt.graphservices
name: azure-mgmt-graphservices
-
- items:
- name: Overview
uid: project-azure-mgmt-hanaonazure
@@ -75957,7 +75706,6 @@
uid: azure.mgmt.hanaonazure.HanaManagementClient
name: azure.mgmt.hanaonazure
name: azure-mgmt-hanaonazure
-
- items:
- name: Overview
uid: project-azure-mgmt-hdinsight
@@ -76282,7 +76030,6 @@
uid: azure.mgmt.hdinsight.HDInsightManagementClient
name: azure.mgmt.hdinsight
name: azure-mgmt-hdinsight
-
- items:
- name: Overview
uid: project-azure-mgmt-healthcareapis
@@ -76535,7 +76282,6 @@
uid: azure.mgmt.healthcareapis.HealthcareApisManagementClient
name: azure.mgmt.healthcareapis
name: azure-mgmt-healthcareapis
-
- items:
- name: Overview
uid: project-azure-mgmt-hybridcompute
@@ -76708,7 +76454,6 @@
uid: azure.mgmt.hybridcompute.HybridComputeManagementClient
name: azure.mgmt.hybridcompute
name: azure-mgmt-hybridcompute
-
- items:
- name: Overview
uid: project-azure-mgmt-hybridkubernetes
@@ -76791,7 +76536,6 @@
uid: azure.mgmt.hybridkubernetes.ConnectedKubernetesClient
name: azure.mgmt.hybridkubernetes
name: azure-mgmt-hybridkubernetes
-
- items:
- name: Overview
uid: project-azure-mgmt-hybridnetwork
@@ -76994,7 +76738,6 @@
uid: azure.mgmt.hybridnetwork.HybridNetworkManagementClient
name: azure.mgmt.hybridnetwork
name: azure-mgmt-hybridnetwork
-
- items:
- name: Overview
uid: project-azure-mgmt-imagebuilder
@@ -77151,7 +76894,6 @@
uid: azure.mgmt.imagebuilder.ImageBuilderClient
name: azure.mgmt.imagebuilder
name: azure-mgmt-imagebuilder
-
- items:
- name: Overview
uid: project-azure-mgmt-iotcentral
@@ -77224,7 +76966,6 @@
uid: azure.mgmt.iotcentral.IotCentralClient
name: azure.mgmt.iotcentral
name: azure-mgmt-iotcentral
-
- items:
- name: Overview
uid: project-azure-mgmt-iothub
@@ -80411,7 +80152,6 @@
uid: azure.mgmt.iothub.IotHubClient
name: azure.mgmt.iothub
name: azure-mgmt-iothub
-
- items:
- name: Overview
uid: project-azure-mgmt-iothubprovisioningservices
@@ -80544,7 +80284,6 @@
uid: azure.mgmt.iothubprovisioningservices.IotDpsClient
name: azure.mgmt.iothubprovisioningservices
name: azure-mgmt-iothubprovisioningservices
-
- items:
- name: Overview
uid: project-azure-mgmt-keyvault
@@ -82457,7 +82196,6 @@
uid: azure.mgmt.keyvault.KeyVaultManagementClient
name: azure.mgmt.keyvault
name: azure-mgmt-keyvault
-
- items:
- name: Overview
uid: project-azure-mgmt-kubernetesconfiguration
@@ -84076,7 +83814,6 @@
uid: azure.mgmt.kubernetesconfiguration.SourceControlConfigurationClient
name: azure.mgmt.kubernetesconfiguration
name: azure-mgmt-kubernetesconfiguration
-
- items:
- name: Overview
uid: project-azure-mgmt-kusto
@@ -84405,7 +84142,6 @@
uid: azure.mgmt.kusto.KustoManagementClient
name: azure.mgmt.kusto
name: azure-mgmt-kusto
-
- items:
- name: Overview
uid: project-azure-mgmt-labservices
@@ -84654,7 +84390,6 @@
uid: azure.mgmt.labservices.ManagedLabsClient
name: azure.mgmt.labservices
name: azure-mgmt-labservices
-
- items:
- name: Overview
uid: project-azure-mgmt-loadtesting
@@ -84757,7 +84492,6 @@
uid: azure.mgmt.loadtesting.LoadTestMgmtClient
name: azure.mgmt.loadtesting
name: azure-mgmt-loadtesting
-
- items:
- name: Overview
uid: project-azure-mgmt-loganalytics
@@ -85028,7 +84762,6 @@
uid: azure.mgmt.loganalytics.LogAnalyticsManagementClient
name: azure.mgmt.loganalytics
name: azure-mgmt-loganalytics
-
- items:
- name: Overview
uid: project-azure-mgmt-logic
@@ -85667,7 +85400,6 @@
uid: azure.mgmt.logic.LogicManagementClient
name: azure.mgmt.logic
name: azure-mgmt-logic
-
- items:
- name: Overview
uid: project-azure-mgmt-logz
@@ -85810,7 +85542,6 @@
uid: azure.mgmt.logz.MicrosoftLogz
name: azure.mgmt.logz
name: azure-mgmt-logz
-
- items:
- name: Overview
uid: project-azure-mgmt-machinelearningservices
@@ -86123,7 +85854,6 @@
uid: azure.mgmt.machinelearningservices.AzureMachineLearningWorkspaces
name: azure.mgmt.machinelearningservices
name: azure-mgmt-machinelearningservices
-
- items:
- name: Overview
uid: project-azure-mgmt-maintenance
@@ -86250,7 +85980,6 @@
uid: azure.mgmt.maintenance.MaintenanceManagementClient
name: azure.mgmt.maintenance
name: azure-mgmt-maintenance
-
- items:
- name: Overview
uid: project-azure-mgmt-managednetworkfabric
@@ -86901,7 +86630,6 @@
uid: azure.mgmt.managednetworkfabric.ManagedNetworkFabricMgmtClient
name: azure.mgmt.managednetworkfabric
name: azure-mgmt-managednetworkfabric
-
- items:
- name: Overview
uid: project-azure-mgmt-managedservices
@@ -86994,7 +86722,6 @@
uid: azure.mgmt.managedservices.ManagedServicesClient
name: azure.mgmt.managedservices
name: azure-mgmt-managedservices
-
- items:
- name: Overview
uid: project-azure-mgmt-managementgroups
@@ -87131,7 +86858,6 @@
uid: azure.mgmt.managementgroups.ManagementGroupsAPI
name: azure.mgmt.managementgroups
name: azure-mgmt-managementgroups
-
- items:
- name: Overview
uid: project-azure-mgmt-managementpartner
@@ -87188,7 +86914,6 @@
uid: azure.mgmt.managementpartner.ACEProvisioningManagementPartnerAPI
name: azure.mgmt.managementpartner
name: azure-mgmt-managementpartner
-
- items:
- name: Overview
uid: project-azure-mgmt-maps
@@ -87311,7 +87036,6 @@
uid: azure.mgmt.maps.AzureMapsManagementClient
name: azure.mgmt.maps
name: azure-mgmt-maps
-
- items:
- name: Overview
uid: project-azure-mgmt-marketplaceordering
@@ -87368,7 +87092,6 @@
uid: azure.mgmt.marketplaceordering.MarketplaceOrderingAgreements
name: azure.mgmt.marketplaceordering
name: azure-mgmt-marketplaceordering
-
- items:
- name: Overview
uid: project-azure-mgmt-media
@@ -88039,7 +87762,6 @@
uid: azure.mgmt.media.AzureMediaServices
name: azure.mgmt.media
name: azure-mgmt-media
-
- items:
- name: Overview
uid: project-azure-mgmt-mobilenetwork
@@ -88364,7 +88086,6 @@
uid: azure.mgmt.mobilenetwork.MobileNetworkManagementClient
name: azure.mgmt.mobilenetwork
name: azure-mgmt-mobilenetwork
-
- items:
- name: Overview
uid: project-azure-mgmt-monitor
@@ -91389,7 +91110,6 @@
uid: azure.mgmt.monitor.MonitorManagementClient
name: azure.mgmt.monitor
name: azure-mgmt-monitor
-
- items:
- name: Overview
uid: project-azure-mgmt-msi
@@ -91668,7 +91388,6 @@
uid: azure.mgmt.msi.ManagedServiceIdentityClient
name: azure.mgmt.msi
name: azure-mgmt-msi
-
- items:
- name: Overview
uid: project-azure-mgmt-netapp
@@ -92011,15 +91730,12 @@
uid: azure.mgmt.netapp.NetAppManagementClient
name: azure.mgmt.netapp
name: azure-mgmt-netapp
-
- items:
- name: Overview
uid: project-azure-mgmt-network
- items:
- name: Overview
uid: azure.mgmt.network
- - name: azure.mgmt.network.NetworkManagementClient
- uid: azure.mgmt.network.NetworkManagementClient
- items:
- name: Overview
uid: azure.mgmt.network.aio
@@ -94640,9 +94356,10 @@
- name: azure.mgmt.network.operations.WebCategoriesOperations
uid: azure.mgmt.network.operations.WebCategoriesOperations
name: azure.mgmt.network.operations
+ - name: azure.mgmt.network.NetworkManagementClient
+ uid: azure.mgmt.network.NetworkManagementClient
name: azure.mgmt.network
name: azure-mgmt-network
-
- items:
- name: Overview
uid: project-azure-mgmt-networkcloud
@@ -95185,7 +94902,6 @@
uid: azure.mgmt.networkcloud.NetworkCloudMgmtClient
name: azure.mgmt.networkcloud
name: azure-mgmt-networkcloud
-
- items:
- name: Overview
uid: project-azure-mgmt-newrelicobservability
@@ -95382,7 +95098,6 @@
uid: azure.mgmt.newrelicobservability.NewRelicObservabilityMgmtClient
name: azure.mgmt.newrelicobservability
name: azure-mgmt-newrelicobservability
-
- items:
- name: Overview
uid: project-azure-mgmt-nginx
@@ -95493,7 +95208,6 @@
uid: azure.mgmt.nginx.NginxManagementClient
name: azure.mgmt.nginx
name: azure-mgmt-nginx
-
- items:
- name: Overview
uid: project-azure-mgmt-notificationhubs
@@ -95602,7 +95316,6 @@
uid: azure.mgmt.notificationhubs.NotificationHubsManagementClient
name: azure.mgmt.notificationhubs
name: azure-mgmt-notificationhubs
-
- items:
- name: Overview
uid: project-azure-mgmt-operationsmanagement
@@ -95681,7 +95394,6 @@
uid: azure.mgmt.operationsmanagement.OperationsManagementClient
name: azure.mgmt.operationsmanagement
name: azure-mgmt-operationsmanagement
-
- items:
- name: Overview
uid: project-azure-mgmt-orbital
@@ -95854,7 +95566,6 @@
uid: azure.mgmt.orbital.AzureOrbital
name: azure.mgmt.orbital
name: azure-mgmt-orbital
-
- items:
- name: Overview
uid: project-azure-mgmt-paloaltonetworksngfw
@@ -96163,7 +95874,6 @@
uid: azure.mgmt.paloaltonetworksngfw.PaloAltoNetworksNgfwMgmtClient
name: azure.mgmt.paloaltonetworksngfw
name: azure-mgmt-paloaltonetworksngfw
-
- items:
- name: Overview
uid: project-azure-mgmt-peering
@@ -96340,7 +96050,6 @@
uid: azure.mgmt.peering.PeeringManagementClient
name: azure.mgmt.peering
name: azure-mgmt-peering
-
- items:
- name: Overview
uid: project-azure-mgmt-policyinsights
@@ -96505,7 +96214,6 @@
uid: azure.mgmt.policyinsights.PolicyInsightsClient
name: azure.mgmt.policyinsights
name: azure-mgmt-policyinsights
-
- items:
- name: Overview
uid: project-azure-mgmt-portal
@@ -96596,7 +96304,6 @@
uid: azure.mgmt.portal.Portal
name: azure.mgmt.portal
name: azure-mgmt-portal
-
- items:
- name: Overview
uid: project-azure-mgmt-powerbidedicated
@@ -96701,7 +96408,6 @@
uid: azure.mgmt.powerbidedicated.PowerBIDedicated
name: azure.mgmt.powerbidedicated
name: azure-mgmt-powerbidedicated
-
- items:
- name: Overview
uid: project-azure-mgmt-privatedns
@@ -96786,7 +96492,6 @@
uid: azure.mgmt.privatedns.PrivateDnsManagementClient
name: azure.mgmt.privatedns
name: azure-mgmt-privatedns
-
- items:
- name: Overview
uid: project-azure-mgmt-purview
@@ -96927,7 +96632,6 @@
uid: azure.mgmt.purview.PurviewManagementClient
name: azure.mgmt.purview
name: azure-mgmt-purview
-
- items:
- name: Overview
uid: project-azure-mgmt-qumulo
@@ -97012,7 +96716,6 @@
uid: azure.mgmt.qumulo.QumuloMgmtClient
name: azure.mgmt.qumulo
name: azure-mgmt-qumulo
-
- items:
- name: Overview
uid: project-azure-mgmt-rdbms
@@ -98195,7 +97898,6 @@
name: azure.mgmt.rdbms.postgresql_flexibleservers
name: azure.mgmt.rdbms
name: azure-mgmt-rdbms
-
- items:
- name: Overview
uid: project-azure-mgmt-recoveryservices
@@ -98436,7 +98138,6 @@
uid: azure.mgmt.recoveryservices.RecoveryServicesClient
name: azure.mgmt.recoveryservices
name: azure-mgmt-recoveryservices
-
- items:
- name: Overview
uid: project-azure-mgmt-recoveryservicesbackup
@@ -99779,7 +99480,6 @@
uid: azure.mgmt.recoveryservicesbackup.RecoveryServicesBackupPassiveClient
name: azure.mgmt.recoveryservicesbackup
name: azure-mgmt-recoveryservicesbackup
-
- items:
- name: Overview
uid: project-azure-mgmt-recoveryservicessiterecovery
@@ -101044,7 +100744,6 @@
uid: azure.mgmt.recoveryservicessiterecovery.SiteRecoveryManagementClient
name: azure.mgmt.recoveryservicessiterecovery
name: azure-mgmt-recoveryservicessiterecovery
-
- items:
- name: Overview
uid: project-azure-mgmt-redhatopenshift
@@ -101569,7 +101268,6 @@
uid: azure.mgmt.redhatopenshift.AzureRedHatOpenShiftClient
name: azure.mgmt.redhatopenshift
name: azure-mgmt-redhatopenshift
-
- items:
- name: Overview
uid: project-azure-mgmt-redis
@@ -101760,7 +101458,6 @@
uid: azure.mgmt.redis.RedisManagementClient
name: azure.mgmt.redis
name: azure-mgmt-redis
-
- items:
- name: Overview
uid: project-azure-mgmt-redisenterprise
@@ -101907,7 +101604,6 @@
uid: azure.mgmt.redisenterprise.RedisEnterpriseManagementClient
name: azure.mgmt.redisenterprise
name: azure-mgmt-redisenterprise
-
- items:
- name: Overview
uid: project-azure-mgmt-relay
@@ -102004,7 +101700,6 @@
uid: azure.mgmt.relay.RelayAPI
name: azure.mgmt.relay
name: azure-mgmt-relay
-
- items:
- name: Overview
uid: project-azure-mgmt-resource
@@ -107531,7 +107226,6 @@
uid: azure.mgmt.resource.SubscriptionClient
name: azure.mgmt.resource
name: azure-mgmt-resource
-
- items:
- name: Overview
uid: project-azure-mgmt-resourceconnector
@@ -107632,7 +107326,6 @@
uid: azure.mgmt.resourceconnector.ResourceConnectorMgmtClient
name: azure.mgmt.resourceconnector
name: azure-mgmt-resourceconnector
-
- items:
- name: Overview
uid: project-azure-mgmt-resourcegraph
@@ -107709,7 +107402,6 @@
uid: azure.mgmt.resourcegraph.ResourceGraphClient
name: azure.mgmt.resourcegraph
name: azure-mgmt-resourcegraph
-
- items:
- name: Overview
uid: project-azure-mgmt-resourcemover
@@ -107910,7 +107602,6 @@
uid: azure.mgmt.resourcemover.ResourceMoverServiceAPI
name: azure.mgmt.resourcemover
name: azure-mgmt-resourcemover
-
- items:
- name: Overview
uid: project-azure-mgmt-scheduler
@@ -108439,7 +108130,6 @@
uid: azure.mgmt.scheduler.SchedulerManagementClient
name: azure.mgmt.scheduler
name: azure-mgmt-scheduler
-
- items:
- name: Overview
uid: project-azure-mgmt-search
@@ -108600,7 +108290,6 @@
uid: azure.mgmt.search.SearchManagementClient
name: azure.mgmt.search
name: azure-mgmt-search
-
- items:
- name: Overview
uid: project-azure-mgmt-security
@@ -111225,7 +110914,6 @@
uid: azure.mgmt.security.SecurityCenter
name: azure.mgmt.security
name: azure-mgmt-security
-
- items:
- name: Overview
uid: project-azure-mgmt-securityinsight
@@ -111714,7 +111402,6 @@
uid: azure.mgmt.securityinsight.SecurityInsights
name: azure.mgmt.securityinsight
name: azure-mgmt-securityinsight
-
- items:
- name: Overview
uid: project-azure-mgmt-selfhelp
@@ -111803,7 +111490,6 @@
uid: azure.mgmt.selfhelp.SelfHelpMgmtClient
name: azure.mgmt.selfhelp
name: azure-mgmt-selfhelp
-
- items:
- name: Overview
uid: project-azure-mgmt-serialconsole
@@ -111868,7 +111554,6 @@
uid: azure.mgmt.serialconsole.MicrosoftSerialConsoleClient
name: azure.mgmt.serialconsole
name: azure-mgmt-serialconsole
-
- items:
- name: Overview
uid: project-azure-mgmt-servicebus
@@ -113483,7 +113168,6 @@
uid: azure.mgmt.servicebus.ServiceBusManagementClient
name: azure.mgmt.servicebus
name: azure-mgmt-servicebus
-
- items:
- name: Overview
uid: project-azure-mgmt-servicefabric
@@ -113732,7 +113416,6 @@
uid: azure.mgmt.servicefabric.ServiceFabricManagementClient
name: azure.mgmt.servicefabric
name: azure-mgmt-servicefabric
-
- items:
- name: Overview
uid: project-azure-mgmt-servicefabricmanagedclusters
@@ -113987,7 +113670,6 @@
uid: azure.mgmt.servicefabricmanagedclusters.ServiceFabricManagedClustersManagementClient
name: azure.mgmt.servicefabricmanagedclusters
name: azure-mgmt-servicefabricmanagedclusters
-
- items:
- name: Overview
uid: project-azure-mgmt-servicelinker
@@ -114112,7 +113794,6 @@
uid: azure.mgmt.servicelinker.ServiceLinkerManagementClient
name: azure.mgmt.servicelinker
name: azure-mgmt-servicelinker
-
- items:
- name: Overview
uid: project-azure-mgmt-sql
@@ -115577,7 +115258,6 @@
uid: azure.mgmt.sql.SqlManagementClient
name: azure.mgmt.sql
name: azure-mgmt-sql
-
- items:
- name: Overview
uid: project-azure-mgmt-storage
@@ -115586,8 +115266,6 @@
- items:
- name: Overview
uid: azure.mgmt.storage
- - name: azure.mgmt.storage.StorageManagementClient
- uid: azure.mgmt.storage.StorageManagementClient
- items:
- name: Overview
uid: azure.mgmt.storage.aio
@@ -122792,9 +122470,10 @@
- name: azure.mgmt.storage.v2023_01_01.StorageManagementClient
uid: azure.mgmt.storage.v2023_01_01.StorageManagementClient
name: azure.mgmt.storage.v2023_01_01
+ - name: azure.mgmt.storage.StorageManagementClient
+ uid: azure.mgmt.storage.StorageManagementClient
name: azure.mgmt.storage
name: azure-mgmt-storage
-
- items:
- name: Overview
uid: project-azure-mgmt-storagecache
@@ -123061,7 +122740,6 @@
uid: azure.mgmt.storagecache.StorageCacheManagementClient
name: azure.mgmt.storagecache
name: azure-mgmt-storagecache
-
- items:
- name: Overview
uid: project-azure-mgmt-storagemover
@@ -123210,7 +122888,6 @@
uid: azure.mgmt.storagemover.StorageMoverMgmtClient
name: azure.mgmt.storagemover
name: azure-mgmt-storagemover
-
- items:
- name: Overview
uid: project-azure-mgmt-storagepool
@@ -123343,7 +123020,6 @@
uid: azure.mgmt.storagepool.StoragePoolManagement
name: azure.mgmt.storagepool
name: azure-mgmt-storagepool
-
- items:
- name: Overview
uid: project-azure-mgmt-storagesync
@@ -123580,7 +123256,6 @@
uid: azure.mgmt.storagesync.MicrosoftStorageSync
name: azure.mgmt.storagesync
name: azure-mgmt-storagesync
-
- items:
- name: Overview
uid: project-azure-mgmt-streamanalytics
@@ -123877,7 +123552,6 @@
uid: azure.mgmt.streamanalytics.StreamAnalyticsManagementClient
name: azure.mgmt.streamanalytics
name: azure-mgmt-streamanalytics
-
- items:
- name: Overview
uid: project-azure-mgmt-subscription
@@ -124014,7 +123688,6 @@
uid: azure.mgmt.subscription.SubscriptionClient
name: azure.mgmt.subscription
name: azure-mgmt-subscription
-
- items:
- name: Overview
uid: project-azure-mgmt-support
@@ -124123,7 +123796,6 @@
uid: azure.mgmt.support.MicrosoftSupport
name: azure.mgmt.support
name: azure-mgmt-support
-
- items:
- name: Overview
uid: project-azure-mgmt-synapse
@@ -124896,7 +124568,6 @@
uid: azure.mgmt.synapse.SynapseManagementClient
name: azure.mgmt.synapse
name: azure-mgmt-synapse
-
- items:
- name: Overview
uid: project-azure-mgmt-timeseriesinsights
@@ -125105,7 +124776,6 @@
uid: azure.mgmt.timeseriesinsights.TimeSeriesInsightsClient
name: azure.mgmt.timeseriesinsights
name: azure-mgmt-timeseriesinsights
-
- items:
- name: Overview
uid: project-azure-mgmt-trafficmanager
@@ -125220,7 +124890,6 @@
uid: azure.mgmt.trafficmanager.TrafficManagerManagementClient
name: azure.mgmt.trafficmanager
name: azure-mgmt-trafficmanager
-
- items:
- name: Overview
uid: project-azure-mgmt-voiceservices
@@ -125327,7 +124996,6 @@
uid: azure.mgmt.voiceservices.VoiceServicesMgmtClient
name: azure.mgmt.voiceservices
name: azure-mgmt-voiceservices
-
- items:
- name: Overview
uid: project-azure-mgmt-web
@@ -125336,8 +125004,6 @@
- items:
- name: Overview
uid: azure.mgmt.web
- - name: azure.mgmt.web.WebSiteManagementClient
- uid: azure.mgmt.web.WebSiteManagementClient
- items:
- name: Overview
uid: azure.mgmt.web.aio
@@ -134668,9 +134334,10 @@
- name: azure.mgmt.web.v2022_09_01.WebSiteManagementClient
uid: azure.mgmt.web.v2022_09_01.WebSiteManagementClient
name: azure.mgmt.web.v2022_09_01
+ - name: azure.mgmt.web.WebSiteManagementClient
+ uid: azure.mgmt.web.WebSiteManagementClient
name: azure.mgmt.web
name: azure-mgmt-web
-
- items:
- name: Overview
uid: project-azure-mgmt-webpubsub
@@ -134889,7 +134556,6 @@
uid: azure.mgmt.webpubsub.WebPubSubManagementClient
name: azure.mgmt.webpubsub
name: azure-mgmt-webpubsub
-
- items:
- name: Overview
uid: project-azure-mgmt-workloads
@@ -135264,7 +134930,6 @@
uid: azure.mgmt.workloads.WorkloadsMgmtClient
name: azure.mgmt.workloads
name: azure-mgmt-workloads
-
- items:
- name: Overview
uid: project-azure-monitor-ingestion
@@ -135283,14 +134948,12 @@
uid: azure.monitor.ingestion.LogsUploadError
name: azure.monitor.ingestion
name: azure-monitor-ingestion
-
- items:
- name: Overview
uid: project-azure-monitor-opentelemetry
- name: azure.monitor.opentelemetry
uid: azure.monitor.opentelemetry
name: azure-monitor-opentelemetry
-
- items:
- name: Overview
uid: project-azure-monitor-query
@@ -135347,7 +135010,6 @@
uid: azure.monitor.query.TimeSeriesElement
name: azure.monitor.query
name: azure-monitor-query
-
- items:
- name: Overview
uid: project-azure-schemaregistry
@@ -135372,7 +135034,6 @@
uid: azure.schemaregistry.SchemaRegistryClient
name: azure.schemaregistry
name: azure-schemaregistry
-
- items:
- name: Overview
uid: project-azure-schemaregistry-avroencoder
@@ -135397,7 +135058,6 @@
uid: azure.schemaregistry.encoder.avroencoder.MessageType
name: azure.schemaregistry.encoder.avroencoder
name: azure-schemaregistry-avroencoder
-
- items:
- name: Overview
uid: project-azure-search-documents
@@ -135724,7 +135384,6 @@
uid: azure.search.documents.SearchItemPaged
name: azure.search.documents
name: azure-search-documents
-
- items:
- name: Overview
uid: project-azure-security-attestation
@@ -135765,7 +135424,6 @@
uid: azure.security.attestation.PolicyModification
name: azure.security.attestation
name: azure-security-attestation
-
- items:
- name: Overview
uid: project-azure-servicebus
@@ -135924,7 +135582,6 @@
uid: azure.servicebus.TransportType
name: azure.servicebus
name: azure-servicebus
-
- items:
- name: Overview
uid: project-azure-servicefabric
@@ -137239,7 +136896,6 @@
uid: azure.servicefabric.ServiceFabricClientAPIsConfiguration
name: azure.servicefabric
name: azure-servicefabric
-
- items:
- name: Overview
uid: project-azure-storage-blob
@@ -137368,7 +137024,6 @@
uid: azure.storage.blob.UserDelegationKey
name: azure.storage.blob
name: azure-storage-blob
-
- items:
- name: Overview
uid: project-azure-storage-file-datalake
@@ -137483,7 +137138,6 @@
uid: azure.storage.filedatalake.UserDelegationKey
name: azure.storage.filedatalake
name: azure-storage-file-datalake
-
- items:
- name: Overview
uid: project-azure-storage-file-share
@@ -137564,7 +137218,6 @@
uid: azure.storage.fileshare.StorageErrorCode
name: azure.storage.fileshare
name: azure-storage-file-share
-
- items:
- name: Overview
uid: project-azure-storage-queue
@@ -137621,7 +137274,6 @@
uid: azure.storage.queue.TextBase64EncodePolicy
name: azure.storage.queue
name: azure-storage-queue
-
- items:
- name: Overview
uid: project-uamqp
@@ -138036,4 +137688,3 @@
uid: uamqp.authentication
name: uamqp
name: uamqp
-
diff --git a/preview/docs-ref-autogen/azure-ai-ml/azure.ai.ml.operations.ModelOperations.yml b/preview/docs-ref-autogen/azure-ai-ml/azure.ai.ml.operations.ModelOperations.yml
index cce7025db6ea..92f13571e27e 100644
--- a/preview/docs-ref-autogen/azure-ai-ml/azure.ai.ml.operations.ModelOperations.yml
+++ b/preview/docs-ref-autogen/azure-ai-ml/azure.ai.ml.operations.ModelOperations.yml
@@ -71,7 +71,7 @@ methods:
- uid: azure.ai.ml.operations.ModelOperations.download
name: download
summary: Download files related to a model.
- signature: 'download(name: str, version: str, download_path: PathLike | str = ''D:\\a\\_work\\1\\s\\dist_temp\\8\\azure-ai-ml-0.1.0b8\\doc'')
+ signature: 'download(name: str, version: str, download_path: PathLike | str = ''C:\\hostedtoolcache\\windows\\Python\\3.11.5\\x64\\Lib\\site-packages\\py2docfx'')
-> None'
parameters:
- name: name
diff --git a/preview/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.AnalyzeHealthcareEntitiesLROPoller.yml b/preview/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.AnalyzeHealthcareEntitiesLROPoller.yml
index 3a3d4354d028..bddabc7219f3 100644
--- a/preview/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.AnalyzeHealthcareEntitiesLROPoller.yml
+++ b/preview/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.AnalyzeHealthcareEntitiesLROPoller.yml
@@ -36,8 +36,9 @@ methods:
examples:
- "Cancel an existing health operation.<!--[!code-python[Main](les\\sample_analyze_healthcare_entities_with_cancellation.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\sample_analyze_healthcare_entities_with_cancellation.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\sample_analyze_healthcare_entities_with_cancellation.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n import os\n from azure.core.exceptions import HttpResponseError\n from\
diff --git a/preview/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.TextAnalyticsClient.yml b/preview/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.TextAnalyticsClient.yml
index cb647926022d..56f616120e3a 100644
--- a/preview/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.TextAnalyticsClient.yml
+++ b/preview/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.TextAnalyticsClient.yml
@@ -67,24 +67,26 @@ constructor:
examples:
- "Creating the TextAnalyticsClient with endpoint and API key.<!--[!code-python[Main](les\\\
sample_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\":\
- \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\
- \\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
- language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false}\
- \ -->\n\n````python\n\n import os\n from azure.core.credentials import AzureKeyCredential\n\
- \ from azure.ai.textanalytics import TextAnalyticsClient\n endpoint = os.environ[\"\
- AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client\
- \ = TextAnalyticsClient(endpoint, AzureKeyCredential(key))\n\n ````\n\nCreating\
- \ the TextAnalyticsClient with endpoint and token credential from Azure Active Directory.<!--[!code-python[Main](les\\\
+ \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\sample_authentication.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
+ \ from azure.core.credentials import AzureKeyCredential\n from azure.ai.textanalytics\
+ \ import TextAnalyticsClient\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"\
+ ]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(endpoint,\
+ \ AzureKeyCredential(key))\n\n ````\n\nCreating the TextAnalyticsClient with endpoint\
+ \ and token credential from Azure Active Directory.<!--[!code-python[Main](les\\\
sample_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\":\
- \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\
- \\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
- language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false}\
- \ -->\n\n````python\n\n import os\n from azure.ai.textanalytics import TextAnalyticsClient\n\
- \ from azure.identity import DefaultAzureCredential\n\n endpoint = os.environ[\"\
- AZURE_LANGUAGE_ENDPOINT\"]\n credential = DefaultAzureCredential()\n\n text_analytics_client\
- \ = TextAnalyticsClient(endpoint, credential=credential)\n\n ````\n"
+ \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\sample_authentication.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
+ \ from azure.ai.textanalytics import TextAnalyticsClient\n from azure.identity\
+ \ import DefaultAzureCredential\n\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"\
+ ]\n credential = DefaultAzureCredential()\n\n text_analytics_client = TextAnalyticsClient(endpoint,\
+ \ credential=credential)\n\n ````\n"
methods:
- uid: azure.ai.textanalytics.TextAnalyticsClient.analyze_sentiment
name: analyze_sentiment
@@ -223,8 +225,9 @@ methods:
examples:
- "Analyze sentiment in a batch of documents.<!--[!code-python[Main](les\\sample_analyze_sentiment.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\sample_analyze_sentiment.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\sample_analyze_sentiment.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n import os\n from azure.core.credentials import AzureKeyCredential\n from\
@@ -385,12 +388,13 @@ methods:
examples:
- "Perform abstractive summarization on a batch of documents.<!--[!code-python[Main](les\\\
sample_abstractive_summary.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\\
- samples\\\\sample_abstractive_summary.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\\
+ sample_abstractive_summary.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.core.credentials import\
+ \ AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(\n \
\ endpoint=endpoint,\n credential=AzureKeyCredential(key),\n )\n\n\
@@ -614,8 +618,9 @@ methods:
- "Start a long-running operation to perform a variety of text analysis\nactions\
\ over a batch of documents.<!--[!code-python[Main](les\\sample_analyze_actions.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\sample_analyze_actions.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\sample_analyze_actions.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n import os\n from azure.core.credentials import AzureKeyCredential\n from\
@@ -851,11 +856,12 @@ methods:
- "Recognize healthcare entities in a batch of documents.<!--[!code-python[Main](les\\\
sample_analyze_healthcare_entities.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
- \\samples\\\\sample_analyze_healthcare_entities.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n import typing\n\
- \ from azure.core.credentials import AzureKeyCredential\n from azure.ai.textanalytics\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\\
+ sample_analyze_healthcare_entities.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n import os\n import typing\n from\
+ \ azure.core.credentials import AzureKeyCredential\n from azure.ai.textanalytics\
\ import TextAnalyticsClient, HealthcareEntityRelation\n\n endpoint = os.environ[\"\
AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"]\n\n \
\ text_analytics_client = TextAnalyticsClient(\n endpoint=endpoint,\n \
@@ -1016,12 +1022,13 @@ methods:
examples:
- "Perform extractive summarization on a batch of documents.<!--[!code-python[Main](les\\\
sample_extract_summary.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\\
- samples\\\\sample_extract_summary.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\\
+ sample_extract_summary.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.core.credentials import\
+ \ AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(\n \
\ endpoint=endpoint,\n credential=AzureKeyCredential(key),\n )\n\n\
@@ -1179,12 +1186,13 @@ methods:
examples:
- "Perform multi label classification on a batch of documents.<!--[!code-python[Main](les\\\
sample_multi_label_classify.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\\
- samples\\\\sample_multi_label_classify.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\\
+ sample_multi_label_classify.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.core.credentials import\
+ \ AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
AZURE_LANGUAGE_KEY\"]\n project_name = os.environ[\"MULTI_LABEL_CLASSIFY_PROJECT_NAME\"\
]\n deployment_name = os.environ[\"MULTI_LABEL_CLASSIFY_DEPLOYMENT_NAME\"]\n\
@@ -1340,10 +1348,11 @@ methods:
- "Recognize custom entities in a batch of documents.<!--[!code-python[Main](les\\\
sample_recognize_custom_entities.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
- \\samples\\\\sample_recognize_custom_entities.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\\
+ sample_recognize_custom_entities.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
\ import AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
AZURE_LANGUAGE_KEY\"]\n project_name = os.environ[\"CUSTOM_ENTITIES_PROJECT_NAME\"\
@@ -1487,12 +1496,13 @@ methods:
examples:
- "Perform single label classification on a batch of documents.<!--[!code-python[Main](les\\\
sample_single_label_classify.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\\
- samples\\\\sample_single_label_classify.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\\
+ sample_single_label_classify.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.core.credentials import\
+ \ AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
AZURE_LANGUAGE_KEY\"]\n project_name = os.environ[\"SINGLE_LABEL_CLASSIFY_PROJECT_NAME\"\
]\n deployment_name = os.environ[\"SINGLE_LABEL_CLASSIFY_DEPLOYMENT_NAME\"]\n\
@@ -1617,8 +1627,9 @@ methods:
examples:
- "Detecting language in a batch of documents.<!--[!code-python[Main](les\\sample_detect_language.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\sample_detect_language.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\sample_detect_language.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n import os\n from azure.core.credentials import AzureKeyCredential\n from\
@@ -1775,11 +1786,12 @@ methods:
- "Perform dynamic classification on a batch of documents.<!--[!code-python[Main](les\\\
sample_dynamic_classification.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
- \\samples\\\\sample_dynamic_classification.py\", \"xml:space\": \"preserve\",\
- \ \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\\
+ sample_dynamic_classification.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.core.credentials import\
+ \ AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(\n \
\ endpoint=endpoint,\n credential=AzureKeyCredential(key),\n )\n \
@@ -1906,12 +1918,13 @@ methods:
examples:
- "Extract the key phrases in a batch of documents.<!--[!code-python[Main](les\\\
sample_extract_key_phrases.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\\
- samples\\\\sample_extract_key_phrases.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\\
+ sample_extract_key_phrases.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.core.credentials import\
+ \ AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(endpoint=endpoint,\
\ credential=AzureKeyCredential(key))\n articles = [\n \"\"\"\n \
@@ -2046,8 +2059,9 @@ methods:
examples:
- "Recognize entities in a batch of documents.<!--[!code-python[Main](les\\sample_recognize_entities.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\sample_recognize_entities.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\sample_recognize_entities.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n import os\n import typing\n from azure.core.credentials import AzureKeyCredential\n\
@@ -2197,10 +2211,11 @@ methods:
- "Recognize linked entities in a batch of documents.<!--[!code-python[Main](les\\\
sample_recognize_linked_entities.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
- \\samples\\\\sample_recognize_linked_entities.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\\
+ sample_recognize_linked_entities.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
\ import AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(endpoint=endpoint,\
@@ -2360,11 +2375,12 @@ methods:
- "Recognize personally identifiable information entities in a batch of documents.<!--[!code-python[Main](les\\\
sample_recognize_pii_entities.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
- \\samples\\\\sample_recognize_pii_entities.py\", \"xml:space\": \"preserve\",\
- \ \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\\
+ sample_recognize_pii_entities.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.core.credentials import\
+ \ AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(\n \
\ endpoint=endpoint, credential=AzureKeyCredential(key)\n )\n documents\
diff --git a/preview/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.aio.AsyncAnalyzeHealthcareEntitiesLROPoller.yml b/preview/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.aio.AsyncAnalyzeHealthcareEntitiesLROPoller.yml
index 7d2b50496bfd..d21abb28b6f0 100644
--- a/preview/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.aio.AsyncAnalyzeHealthcareEntitiesLROPoller.yml
+++ b/preview/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.aio.AsyncAnalyzeHealthcareEntitiesLROPoller.yml
@@ -37,7 +37,8 @@ methods:
- "Cancel an existing health operation.<!--[!code-python[Main](les\\async_samples\\\
sample_analyze_healthcare_entities_with_cancellation_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
\\samples\\\\async_samples\\\\sample_analyze_healthcare_entities_with_cancellation_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
diff --git a/preview/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.aio.TextAnalyticsClient.yml b/preview/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.aio.TextAnalyticsClient.yml
index 3b6f073e0e9f..856f78acb0a4 100644
--- a/preview/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.aio.TextAnalyticsClient.yml
+++ b/preview/docs-ref-autogen/azure-ai-textanalytics/azure.ai.textanalytics.aio.TextAnalyticsClient.yml
@@ -68,18 +68,19 @@ examples:
- "Creating the TextAnalyticsClient with endpoint and API key.<!--[!code-python[Main](les\\\
async_samples\\sample_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
- \\samples\\\\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from\
- \ azure.core.credentials import AzureKeyCredential\n from azure.ai.textanalytics.aio\
- \ import TextAnalyticsClient\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"\
- ]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(endpoint,\
- \ AzureKeyCredential(key))\n\n ````\n\nCreating the TextAnalyticsClient with endpoint\
- \ and token credential from Azure Active Directory.<!--[!code-python[Main](les\\\
- async_samples\\sample_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\"\
- : [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\async_samples\\\
+ \\sample_authentication_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.core.credentials import\
+ \ AzureKeyCredential\n from azure.ai.textanalytics.aio import TextAnalyticsClient\n\
+ \ endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"\
+ ]\n\n text_analytics_client = TextAnalyticsClient(endpoint, AzureKeyCredential(key))\n\
+ \n ````\n\nCreating the TextAnalyticsClient with endpoint and token credential\
+ \ from Azure Active Directory.<!--[!code-python[Main](les\\async_samples\\sample_authentication_async.py\
+ \ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
\\samples\\\\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"\
preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from\
@@ -226,13 +227,14 @@ methods:
- "Analyze sentiment in a batch of documents.<!--[!code-python[Main](les\\async_samples\\\
sample_analyze_sentiment_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
- \\samples\\\\async_samples\\\\sample_analyze_sentiment_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
- \ from azure.core.credentials import AzureKeyCredential\n from azure.ai.textanalytics.aio\
- \ import TextAnalyticsClient\n\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"\
- ]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(endpoint=endpoint,\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\\
+ async_samples\\\\sample_analyze_sentiment_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
+ \ import AzureKeyCredential\n from azure.ai.textanalytics.aio import TextAnalyticsClient\n\
+ \n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
+ AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(endpoint=endpoint,\
\ credential=AzureKeyCredential(key))\n\n documents = [\n \"\"\"I had\
\ the best day of my life. I decided to go sky-diving and it made me appreciate\
\ my whole life so much more.\n I developed a deep-connection with my instructor\
@@ -389,7 +391,8 @@ methods:
- "Perform abstractive summarization on a batch of documents.<!--[!code-python[Main](les\\\
async_samples\\sample_abstractive_summary_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
\\samples\\\\async_samples\\\\sample_abstractive_summary_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -619,77 +622,77 @@ methods:
- "Start a long-running operation to perform a variety of text analysis actions\
\ over\na batch of documents.<!--[!code-python[Main](les\\async_samples\\sample_analyze_actions_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\async_samples\\\
- \\sample_analyze_actions_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n import os\n from azure.core.credentials import\
- \ AzureKeyCredential\n from azure.ai.textanalytics.aio import TextAnalyticsClient\n\
- \ from azure.ai.textanalytics import (\n RecognizeEntitiesAction,\n \
- \ RecognizeLinkedEntitiesAction,\n RecognizePiiEntitiesAction,\n \
- \ ExtractKeyPhrasesAction,\n AnalyzeSentimentAction,\n )\n\n endpoint\
- \ = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"\
- ]\n\n text_analytics_client = TextAnalyticsClient(\n endpoint=endpoint,\n\
- \ credential=AzureKeyCredential(key),\n )\n\n documents = [\n \
- \ 'We went to Contoso Steakhouse located at midtown NYC last week for a dinner\
- \ party, and we adore the spot! '\n 'They provide marvelous food and they\
- \ have a great menu. The chief cook happens to be the owner (I think his name\
- \ is John Doe) '\n 'and he is super nice, coming out of the kitchen and\
- \ greeted us all.'\n ,\n\n 'We enjoyed very much dining in the place!\
- \ '\n 'The Sirloin steak I ordered was tender and juicy, and the place was\
- \ impeccably clean. You can even pre-order from their '\n 'online menu at\
- \ www.contososteakhouse.com, call 312-555-0176 or send email to order@contososteakhouse.com!\
- \ '\n 'The only complaint I have is the food didn\\'t come fast enough.\
- \ Overall I highly recommend it!'\n ]\n\n async with text_analytics_client:\n\
- \ poller = await text_analytics_client.begin_analyze_actions(\n \
- \ documents,\n display_name=\"Sample Text Analysis\",\n \
- \ actions=[\n RecognizeEntitiesAction(),\n RecognizePiiEntitiesAction(),\n\
- \ ExtractKeyPhrasesAction(),\n RecognizeLinkedEntitiesAction(),\n\
- \ AnalyzeSentimentAction(),\n ]\n )\n\n pages\
- \ = await poller.result()\n\n # To enumerate / zip for async, unless you\
- \ install a third party library,\n # you have to read in all of the elements\
- \ into memory first.\n # If you're not looking to enumerate / zip, we recommend\
- \ you just asynchronously\n # loop over it immediately, without going through\
- \ this step of reading them into memory\n document_results = []\n \
- \ async for page in pages:\n document_results.append(page)\n\n for\
- \ doc, action_results in zip(documents, document_results):\n print(f\"\\\
- nDocument text: {doc}\")\n for result in action_results:\n if\
- \ result.kind == \"EntityRecognition\":\n print(\"...Results of\
- \ Recognize Entities Action:\")\n for entity in result.entities:\n\
- \ print(f\"......Entity: {entity.text}\")\n \
- \ print(f\".........Category: {entity.category}\")\n print(f\"\
- .........Confidence Score: {entity.confidence_score}\")\n print(f\"\
- .........Offset: {entity.offset}\")\n\n elif result.kind == \"PiiEntityRecognition\"\
- :\n print(\"...Results of Recognize PII Entities action:\")\n \
- \ for pii_entity in result.entities:\n print(f\"\
- ......Entity: {pii_entity.text}\")\n print(f\".........Category:\
- \ {pii_entity.category}\")\n print(f\".........Confidence Score:\
- \ {pii_entity.confidence_score}\")\n\n elif result.kind == \"KeyPhraseExtraction\"\
- :\n print(\"...Results of Extract Key Phrases action:\")\n \
- \ print(f\"......Key Phrases: {result.key_phrases}\")\n\n elif\
- \ result.kind == \"EntityLinking\":\n print(\"...Results of Recognize\
- \ Linked Entities action:\")\n for linked_entity in result.entities:\n\
- \ print(f\"......Entity name: {linked_entity.name}\")\n \
- \ print(f\".........Data source: {linked_entity.data_source}\")\n\
- \ print(f\".........Data source language: {linked_entity.language}\"\
- )\n print(\n f\".........Data source entity\
- \ ID: {linked_entity.data_source_entity_id}\"\n )\n \
- \ print(f\".........Data source URL: {linked_entity.url}\")\n \
- \ print(\".........Document matches:\")\n for match\
- \ in linked_entity.matches:\n print(f\"............Match\
- \ text: {match.text}\")\n print(f\"............Confidence\
- \ Score: {match.confidence_score}\")\n print(f\"............Offset:\
- \ {match.offset}\")\n print(f\"............Length: {match.length}\"\
- )\n\n elif result.kind == \"SentimentAnalysis\":\n print(\"\
- ...Results of Analyze Sentiment action:\")\n print(f\"......Overall\
- \ sentiment: {result.sentiment}\")\n print(\n \
- \ f\"......Scores: positive={result.confidence_scores.positive}; \\\n \
- \ neutral={result.confidence_scores.neutral}; \\\n \
- \ negative={result.confidence_scores.negative} \\n\"\n )\n\n \
- \ elif result.is_error is True:\n print(\n \
- \ f\"...Is an error with code '{result.error.code}' and message '{result.error.message}'\"\
- \n )\n\n print(\"------------------------------------------\"\
- )\n\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\async_samples\\\\sample_analyze_actions_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n import os\n from azure.core.credentials import AzureKeyCredential\n from\
+ \ azure.ai.textanalytics.aio import TextAnalyticsClient\n from azure.ai.textanalytics\
+ \ import (\n RecognizeEntitiesAction,\n RecognizeLinkedEntitiesAction,\n\
+ \ RecognizePiiEntitiesAction,\n ExtractKeyPhrasesAction,\n AnalyzeSentimentAction,\n\
+ \ )\n\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
+ AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(\n \
+ \ endpoint=endpoint,\n credential=AzureKeyCredential(key),\n )\n\n\
+ \ documents = [\n 'We went to Contoso Steakhouse located at midtown NYC\
+ \ last week for a dinner party, and we adore the spot! '\n 'They provide\
+ \ marvelous food and they have a great menu. The chief cook happens to be the\
+ \ owner (I think his name is John Doe) '\n 'and he is super nice, coming\
+ \ out of the kitchen and greeted us all.'\n ,\n\n 'We enjoyed very\
+ \ much dining in the place! '\n 'The Sirloin steak I ordered was tender\
+ \ and juicy, and the place was impeccably clean. You can even pre-order from their\
+ \ '\n 'online menu at www.contososteakhouse.com, call 312-555-0176 or send\
+ \ email to order@contososteakhouse.com! '\n 'The only complaint I have is\
+ \ the food didn\\'t come fast enough. Overall I highly recommend it!'\n ]\n\n\
+ \ async with text_analytics_client:\n poller = await text_analytics_client.begin_analyze_actions(\n\
+ \ documents,\n display_name=\"Sample Text Analysis\",\n \
+ \ actions=[\n RecognizeEntitiesAction(),\n \
+ \ RecognizePiiEntitiesAction(),\n ExtractKeyPhrasesAction(),\n\
+ \ RecognizeLinkedEntitiesAction(),\n AnalyzeSentimentAction(),\n\
+ \ ]\n )\n\n pages = await poller.result()\n\n # To\
+ \ enumerate / zip for async, unless you install a third party library,\n \
+ \ # you have to read in all of the elements into memory first.\n # If you're\
+ \ not looking to enumerate / zip, we recommend you just asynchronously\n \
+ \ # loop over it immediately, without going through this step of reading them\
+ \ into memory\n document_results = []\n async for page in pages:\n\
+ \ document_results.append(page)\n\n for doc, action_results in zip(documents,\
+ \ document_results):\n print(f\"\\nDocument text: {doc}\")\n for result\
+ \ in action_results:\n if result.kind == \"EntityRecognition\":\n \
+ \ print(\"...Results of Recognize Entities Action:\")\n \
+ \ for entity in result.entities:\n print(f\"......Entity:\
+ \ {entity.text}\")\n print(f\".........Category: {entity.category}\"\
+ )\n print(f\".........Confidence Score: {entity.confidence_score}\"\
+ )\n print(f\".........Offset: {entity.offset}\")\n\n \
+ \ elif result.kind == \"PiiEntityRecognition\":\n print(\"...Results\
+ \ of Recognize PII Entities action:\")\n for pii_entity in result.entities:\n\
+ \ print(f\"......Entity: {pii_entity.text}\")\n \
+ \ print(f\".........Category: {pii_entity.category}\")\n \
+ \ print(f\".........Confidence Score: {pii_entity.confidence_score}\")\n\n\
+ \ elif result.kind == \"KeyPhraseExtraction\":\n print(\"\
+ ...Results of Extract Key Phrases action:\")\n print(f\"......Key\
+ \ Phrases: {result.key_phrases}\")\n\n elif result.kind == \"EntityLinking\"\
+ :\n print(\"...Results of Recognize Linked Entities action:\")\n\
+ \ for linked_entity in result.entities:\n print(f\"\
+ ......Entity name: {linked_entity.name}\")\n print(f\".........Data\
+ \ source: {linked_entity.data_source}\")\n print(f\".........Data\
+ \ source language: {linked_entity.language}\")\n print(\n \
+ \ f\".........Data source entity ID: {linked_entity.data_source_entity_id}\"\
+ \n )\n print(f\".........Data source URL:\
+ \ {linked_entity.url}\")\n print(\".........Document matches:\"\
+ )\n for match in linked_entity.matches:\n \
+ \ print(f\"............Match text: {match.text}\")\n \
+ \ print(f\"............Confidence Score: {match.confidence_score}\")\n \
+ \ print(f\"............Offset: {match.offset}\")\n \
+ \ print(f\"............Length: {match.length}\")\n\n elif\
+ \ result.kind == \"SentimentAnalysis\":\n print(\"...Results of\
+ \ Analyze Sentiment action:\")\n print(f\"......Overall sentiment:\
+ \ {result.sentiment}\")\n print(\n f\"......Scores:\
+ \ positive={result.confidence_scores.positive}; \\\n neutral={result.confidence_scores.neutral};\
+ \ \\\n negative={result.confidence_scores.negative} \\n\"\n\
+ \ )\n\n elif result.is_error is True:\n \
+ \ print(\n f\"...Is an error with code '{result.error.code}'\
+ \ and message '{result.error.message}'\"\n )\n\n print(\"\
+ ------------------------------------------\")\n\n\n ````\n"
- uid: azure.ai.textanalytics.aio.TextAnalyticsClient.begin_analyze_healthcare_entities
name: begin_analyze_healthcare_entities
summary: 'Analyze healthcare entities and identify relationships between these entities
@@ -861,7 +864,8 @@ methods:
- "Analyze healthcare entities in a batch of documents.<!--[!code-python[Main](les\\\
async_samples\\sample_analyze_healthcare_entities_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
\\samples\\\\async_samples\\\\sample_analyze_healthcare_entities_async.py\", \"\
xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -1028,7 +1032,8 @@ methods:
- "Perform extractive summarization on a batch of documents.<!--[!code-python[Main](les\\\
async_samples\\sample_extract_summary_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
\\samples\\\\async_samples\\\\sample_extract_summary_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -1193,7 +1198,8 @@ methods:
- "Perform multi label classification on a batch of documents.<!--[!code-python[Main](les\\\
async_samples\\sample_multi_label_classify_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
\\samples\\\\async_samples\\\\sample_multi_label_classify_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -1358,7 +1364,8 @@ methods:
- "Recognize custom entities in a batch of documents.<!--[!code-python[Main](les\\\
async_samples\\sample_recognize_custom_entities_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
\\samples\\\\async_samples\\\\sample_recognize_custom_entities_async.py\", \"\
xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -1509,7 +1516,8 @@ methods:
- "Perform single label classification on a batch of documents.<!--[!code-python[Main](les\\\
async_samples\\sample_single_label_classify_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
\\samples\\\\async_samples\\\\sample_single_label_classify_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -1640,14 +1648,15 @@ methods:
examples:
- "Detecting language in a batch of documents.<!--[!code-python[Main](les\\async_samples\\\
sample_detect_language_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\\
- samples\\\\async_samples\\\\sample_detect_language_async.py\", \"xml:space\":\
- \ \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
- \ from azure.core.credentials import AzureKeyCredential\n from azure.ai.textanalytics.aio\
- \ import TextAnalyticsClient\n\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"\
- ]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(endpoint=endpoint,\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\\
+ async_samples\\\\sample_detect_language_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
+ \ import AzureKeyCredential\n from azure.ai.textanalytics.aio import TextAnalyticsClient\n\
+ \n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
+ AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(endpoint=endpoint,\
\ credential=AzureKeyCredential(key))\n documents = [\n \"\"\"\n \
\ The concierge Paulette was extremely helpful. Sadly when we arrived the elevator\
\ was broken, but with Paulette's help we barely noticed this inconvenience.\n\
@@ -1798,7 +1807,8 @@ methods:
- "Perform dynamic classification on a batch of documents.<!--[!code-python[Main](les\\\
async_samples\\sample_dynamic_classification_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
\\samples\\\\async_samples\\\\sample_dynamic_classification_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -1931,7 +1941,8 @@ methods:
- "Extract the key phrases in a batch of documents.<!--[!code-python[Main](les\\\
async_samples\\sample_extract_key_phrases_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
\\samples\\\\async_samples\\\\sample_extract_key_phrases_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -2075,24 +2086,25 @@ methods:
- "Recognize entities in a batch of documents.<!--[!code-python[Main](les\\async_samples\\\
sample_recognize_entities_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
- \\samples\\\\async_samples\\\\sample_recognize_entities_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
- \ import typing\n from azure.core.credentials import AzureKeyCredential\n\
- \ from azure.ai.textanalytics.aio import TextAnalyticsClient\n\n endpoint\
- \ = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"\
- ]\n\n text_analytics_client = TextAnalyticsClient(endpoint=endpoint, credential=AzureKeyCredential(key))\n\
- \ reviews = [\n \"\"\"I work for Foo Company, and we hired Contoso for\
- \ our annual founding ceremony. The food\n was amazing and we all can't\
- \ say enough good words about the quality and the level of service.\"\"\",\n \
- \ \"\"\"We at the Foo Company re-hired Contoso after all of our past successes\
- \ with the company.\n Though the food was still great, I feel there has\
- \ been a quality drop since their last time\n catering for us. Is anyone\
- \ else running into the same problem?\"\"\",\n \"\"\"Bar Company is over\
- \ the moon about the service we received from Contoso, the best sliders ever!!!!\"\
- \"\"\n ]\n\n async with text_analytics_client:\n result = await text_analytics_client.recognize_entities(reviews)\n\
- \n result = [review for review in result if not review.is_error]\n organization_to_reviews:\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\\
+ async_samples\\\\sample_recognize_entities_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n import typing\n\
+ \ from azure.core.credentials import AzureKeyCredential\n from azure.ai.textanalytics.aio\
+ \ import TextAnalyticsClient\n\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"\
+ ]\n key = os.environ[\"AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(endpoint=endpoint,\
+ \ credential=AzureKeyCredential(key))\n reviews = [\n \"\"\"I work for\
+ \ Foo Company, and we hired Contoso for our annual founding ceremony. The food\n\
+ \ was amazing and we all can't say enough good words about the quality and\
+ \ the level of service.\"\"\",\n \"\"\"We at the Foo Company re-hired Contoso\
+ \ after all of our past successes with the company.\n Though the food was\
+ \ still great, I feel there has been a quality drop since their last time\n \
+ \ catering for us. Is anyone else running into the same problem?\"\"\",\n\
+ \ \"\"\"Bar Company is over the moon about the service we received from\
+ \ Contoso, the best sliders ever!!!!\"\"\"\n ]\n\n async with text_analytics_client:\n\
+ \ result = await text_analytics_client.recognize_entities(reviews)\n\n \
+ \ result = [review for review in result if not review.is_error]\n organization_to_reviews:\
\ typing.Dict[str, typing.List[str]] = {}\n\n for idx, review in enumerate(result):\n\
\ for entity in review.entities:\n print(f\"Entity '{entity.text}'\
\ has category '{entity.category}'\")\n\n if entity.category == 'Organization':\n\
@@ -2226,7 +2238,8 @@ methods:
- "Recognize linked entities in a batch of documents.<!--[!code-python[Main](les\\\
async_samples\\sample_recognize_linked_entities_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
\\samples\\\\async_samples\\\\sample_recognize_linked_entities_async.py\", \"\
xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -2390,11 +2403,12 @@ methods:
- "Recognize personally identifiable information entities in a batch of documents.<!--[!code-python[Main](les\\\
sample_recognize_pii_entities.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\
- \\samples\\\\sample_recognize_pii_entities.py\", \"xml:space\": \"preserve\",\
- \ \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\10\\\\azure-ai-textanalytics-5.3.0b2\\\\samples\\\\\
+ sample_recognize_pii_entities.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.core.credentials import\
+ \ AzureKeyCredential\n from azure.ai.textanalytics import TextAnalyticsClient\n\
\n endpoint = os.environ[\"AZURE_LANGUAGE_ENDPOINT\"]\n key = os.environ[\"\
AZURE_LANGUAGE_KEY\"]\n\n text_analytics_client = TextAnalyticsClient(\n \
\ endpoint=endpoint, credential=AzureKeyCredential(key)\n )\n documents\
diff --git a/preview/docs-ref-autogen/azure-ai-translation-document/azure.ai.translation.document.DocumentTranslationClient.yml b/preview/docs-ref-autogen/azure-ai-translation-document/azure.ai.translation.document.DocumentTranslationClient.yml
index 1174669575d8..8053629386ce 100644
--- a/preview/docs-ref-autogen/azure-ai-translation-document/azure.ai.translation.document.DocumentTranslationClient.yml
+++ b/preview/docs-ref-autogen/azure-ai-translation-document/azure.ai.translation.document.DocumentTranslationClient.yml
@@ -44,22 +44,23 @@ constructor:
examples:
- "Creating the DocumentTranslationClient with an endpoint and API key.<!--[!code-python[Main](les\\\
sample_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\":\
- \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0b6\\\\\
- samples\\\\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
- \ from azure.ai.translation.document import DocumentTranslationClient\n\n endpoint\
- \ = os.environ[\"AZURE_DOCUMENT_TRANSLATION_ENDPOINT\"]\n key = os.environ[\"\
+ \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\11\\\\azure-ai-translation-document-1.0.0b6\\\\samples\\\\sample_authentication.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
+ \ import AzureKeyCredential\n from azure.ai.translation.document import DocumentTranslationClient\n\
+ \n endpoint = os.environ[\"AZURE_DOCUMENT_TRANSLATION_ENDPOINT\"]\n key = os.environ[\"\
AZURE_DOCUMENT_TRANSLATION_KEY\"]\n\n document_translation_client = DocumentTranslationClient(endpoint,\
\ AzureKeyCredential(key))\n\n ````\n\nCreating the DocumentTranslationClient\
\ with a token credential.<!--[!code-python[Main](les\\sample_authentication.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 11\\\\azure-ai-translation-document-1.0.0b6\\\\samples\\\\sample_authentication.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n \"\"\"DefaultAzureCredential\
- \ will use the values from these environment\n variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0b6\\\
+ \\samples\\\\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n \"\"\"DefaultAzureCredential will use\
+ \ the values from these environment\n variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,\
\ AZURE_CLIENT_SECRET\n \"\"\"\n from azure.identity import DefaultAzureCredential\n\
\ from azure.ai.translation.document import DocumentTranslationClient\n\n endpoint\
\ = os.environ[\"AZURE_DOCUMENT_TRANSLATION_ENDPOINT\"]\n credential = DefaultAzureCredential()\n\
@@ -199,12 +200,13 @@ methods:
examples:
- "Translate the documents in your storage container.<!--[!code-python[Main](les\\\
sample_begin_translation.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0b6\\\
- \\samples\\\\sample_begin_translation.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n import os\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.translation.document import DocumentTranslationClient\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0b6\\\\samples\\\
+ \\sample_begin_translation.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.core.credentials import\
+ \ AzureKeyCredential\n from azure.ai.translation.document import DocumentTranslationClient\n\
\n endpoint = os.environ[\"AZURE_DOCUMENT_TRANSLATION_ENDPOINT\"]\n key =\
\ os.environ[\"AZURE_DOCUMENT_TRANSLATION_KEY\"]\n source_container_url = os.environ[\"\
AZURE_SOURCE_CONTAINER_URL\"]\n target_container_url = os.environ[\"AZURE_TARGET_CONTAINER_URL\"\
@@ -391,21 +393,22 @@ methods:
- "List all the document statuses as they are being translated.<!--[!code-python[Main](les\\\
sample_check_document_statuses.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0b6\\\
- \\samples\\\\sample_check_document_statuses.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n import time\n\
- \ from azure.core.credentials import AzureKeyCredential\n from azure.ai.translation.document\
- \ import DocumentTranslationClient\n\n endpoint = os.environ[\"AZURE_DOCUMENT_TRANSLATION_ENDPOINT\"\
- ]\n key = os.environ[\"AZURE_DOCUMENT_TRANSLATION_KEY\"]\n source_container_url\
- \ = os.environ[\"AZURE_SOURCE_CONTAINER_URL\"]\n target_container_url = os.environ[\"\
- AZURE_TARGET_CONTAINER_URL\"]\n\n client = DocumentTranslationClient(endpoint,\
- \ AzureKeyCredential(key))\n\n poller = client.begin_translation(source_container_url,\
- \ target_container_url, \"es\")\n\n completed_docs = []\n while not poller.done():\n\
- \ time.sleep(30)\n\n doc_statuses = client.list_document_statuses(poller.id)\n\
- \ for document in doc_statuses:\n if document.id not in completed_docs:\n\
- \ if document.status == \"Succeeded\":\n print(f\"\
- Document at {document.source_document_url} was translated to {document.translated_to}\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0b6\\\\samples\\\
+ \\sample_check_document_statuses.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n import os\n import time\n from azure.core.credentials\
+ \ import AzureKeyCredential\n from azure.ai.translation.document import DocumentTranslationClient\n\
+ \n endpoint = os.environ[\"AZURE_DOCUMENT_TRANSLATION_ENDPOINT\"]\n key =\
+ \ os.environ[\"AZURE_DOCUMENT_TRANSLATION_KEY\"]\n source_container_url = os.environ[\"\
+ AZURE_SOURCE_CONTAINER_URL\"]\n target_container_url = os.environ[\"AZURE_TARGET_CONTAINER_URL\"\
+ ]\n\n client = DocumentTranslationClient(endpoint, AzureKeyCredential(key))\n\
+ \n poller = client.begin_translation(source_container_url, target_container_url,\
+ \ \"es\")\n\n completed_docs = []\n while not poller.done():\n time.sleep(30)\n\
+ \n doc_statuses = client.list_document_statuses(poller.id)\n for document\
+ \ in doc_statuses:\n if document.id not in completed_docs:\n \
+ \ if document.status == \"Succeeded\":\n print(f\"Document\
+ \ at {document.source_document_url} was translated to {document.translated_to}\
\ \"\n f\"language. You can find translated document at\
\ {document.translated_document_url}\")\n completed_docs.append(document.id)\n\
\ if document.status == \"Failed\":\n print(f\"\
@@ -483,11 +486,12 @@ methods:
examples:
- "List all submitted translations under the resource.<!--[!code-python[Main](les\\\
sample_list_translations.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0b6\\\
- \\samples\\\\sample_list_translations.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0b6\\\\samples\\\
+ \\sample_list_translations.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
\ from azure.ai.translation.document import DocumentTranslationClient\n\n\n\
\ endpoint = os.environ[\"AZURE_DOCUMENT_TRANSLATION_ENDPOINT\"]\n key = os.environ[\"\
AZURE_DOCUMENT_TRANSLATION_KEY\"]\n\n client = DocumentTranslationClient(endpoint,\
diff --git a/preview/docs-ref-autogen/azure-ai-translation-document/azure.ai.translation.document.aio.DocumentTranslationClient.yml b/preview/docs-ref-autogen/azure-ai-translation-document/azure.ai.translation.document.aio.DocumentTranslationClient.yml
index f057537d7a2d..56af037be0f5 100644
--- a/preview/docs-ref-autogen/azure-ai-translation-document/azure.ai.translation.document.aio.DocumentTranslationClient.yml
+++ b/preview/docs-ref-autogen/azure-ai-translation-document/azure.ai.translation.document.aio.DocumentTranslationClient.yml
@@ -45,20 +45,22 @@ examples:
- "Creating the DocumentTranslationClient with an endpoint and API key.<!--[!code-python[Main](les\\\
async_samples\\sample_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0b6\\\
- \\samples\\\\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.ai.translation.document.aio import DocumentTranslationClient\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0b6\\\\samples\\\
+ \\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials import\
+ \ AzureKeyCredential\n from azure.ai.translation.document.aio import DocumentTranslationClient\n\
\n endpoint = os.environ[\"AZURE_DOCUMENT_TRANSLATION_ENDPOINT\"]\n key = os.environ[\"\
AZURE_DOCUMENT_TRANSLATION_KEY\"]\n\n document_translation_client = DocumentTranslationClient(endpoint,\
\ AzureKeyCredential(key))\n\n ````\n\nCreating the DocumentTranslationClient\
\ with a token credential.<!--[!code-python[Main](les\\async_samples\\sample_authentication_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 11\\\\azure-ai-translation-document-1.0.0b6\\\\samples\\\\async_samples\\\\sample_authentication_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n \"\"\"DefaultAzureCredential\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0b6\\\
+ \\samples\\\\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"\
+ preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
+ linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n \"\"\"DefaultAzureCredential\
\ will use the values from these environment\n variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,\
\ AZURE_CLIENT_SECRET\n \"\"\"\n from azure.identity.aio import DefaultAzureCredential\n\
\ from azure.ai.translation.document.aio import DocumentTranslationClient\n\n\
@@ -200,7 +202,8 @@ methods:
- "Translate the documents in your storage container.<!--[!code-python[Main](les\\\
async_samples\\sample_begin_translation_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0b6\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0b6\\\
\\samples\\\\async_samples\\\\sample_begin_translation_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -392,7 +395,8 @@ methods:
- "List all the document statuses as they are being translated.<!--[!code-python[Main](les\\\
async_samples\\sample_check_document_statuses_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0b6\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0b6\\\
\\samples\\\\async_samples\\\\sample_check_document_statuses_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -487,7 +491,8 @@ methods:
- "List all submitted translations under the resource.<!--[!code-python[Main](les\\\
async_samples\\sample_list_translations_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0b6\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\11\\\\azure-ai-translation-document-1.0.0b6\\\
\\samples\\\\async_samples\\\\sample_list_translations_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
diff --git a/preview/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.yml b/preview/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.yml
new file mode 100644
index 000000000000..b8c1b24c3781
--- /dev/null
+++ b/preview/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: import
+packages:
+- azure.cognitiveservices.language.luis.authoring
+- azure.cognitiveservices.language.luis.runtime
+modules:
+- azure.cognitiveservices.language.luis.version
diff --git a/preview/docs-ref-autogen/azure-cognitiveservices-language-luis/index.yml b/preview/docs-ref-autogen/azure-cognitiveservices-language-luis/index.yml
index 175420804025..fd1db6153390 100644
--- a/preview/docs-ref-autogen/azure-cognitiveservices-language-luis/index.yml
+++ b/preview/docs-ref-autogen/azure-cognitiveservices-language-luis/index.yml
@@ -4,8 +4,7 @@ name: azure-cognitiveservices-language-luis
fullName: azure-cognitiveservices-language-luis
type: distribution
packages:
-- azure.cognitiveservices.language.luis.authoring
-- azure.cognitiveservices.language.luis.runtime
+- azure.cognitiveservices.language.luis
modules:
- azure.cognitiveservices.language.luis.authoring.version
- azure.cognitiveservices.language.luis.runtime.version
diff --git a/preview/docs-ref-autogen/azure-communication-administration/azure.communication.administration.CommunicationIdentityClient.yml b/preview/docs-ref-autogen/azure-communication-administration/azure.communication.administration.CommunicationIdentityClient.yml
index 25712220b55b..f1f5fb7d1cb7 100644
--- a/preview/docs-ref-autogen/azure-communication-administration/azure.communication.administration.CommunicationIdentityClient.yml
+++ b/preview/docs-ref-autogen/azure-communication-administration/azure.communication.administration.CommunicationIdentityClient.yml
@@ -22,7 +22,8 @@ constructor:
examples:
- "<!--[!code-python[Main](les\\identity_samples.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"\
- source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\24\\\\azure-communication-administration-1.0.0b4\\\
+ source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\
+ \\site-packages\\\\py2docfx\\\\dist_temp\\\\24\\\\azure-communication-administration-1.0.0b4\\\
\\samples\\\\identity_samples.py\", \"xml:space\": \"preserve\", \"force\": false,\
\ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
: false} -->\n\n````python\n\n : utf-8\n\n -------------------------------------------------------------------\n\
diff --git a/preview/docs-ref-autogen/azure-communication-identity/azure.communication.identity.CommunicationIdentityClient.yml b/preview/docs-ref-autogen/azure-communication-identity/azure.communication.identity.CommunicationIdentityClient.yml
index f284f8755fa3..58d81854313f 100644
--- a/preview/docs-ref-autogen/azure-communication-identity/azure.communication.identity.CommunicationIdentityClient.yml
+++ b/preview/docs-ref-autogen/azure-communication-identity/azure.communication.identity.CommunicationIdentityClient.yml
@@ -30,7 +30,8 @@ constructor:
examples:
- "<!--[!code-python[Main](les\\identity_samples.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"\
- source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\27\\\\azure-communication-identity-1.4.0b1\\\
+ source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\
+ \\site-packages\\\\py2docfx\\\\dist_temp\\\\27\\\\azure-communication-identity-1.4.0b1\\\
\\samples\\\\identity_samples.py\", \"xml:space\": \"preserve\", \"force\": false,\
\ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
: false} -->\n\n````python\n\n : utf-8\n\n -------------------------------------------------------------------\n\
diff --git a/preview/docs-ref-autogen/azure-communication-jobrouter/azure.communication.jobrouter.JobRouterAdministrationClient.yml b/preview/docs-ref-autogen/azure-communication-jobrouter/azure.communication.jobrouter.JobRouterAdministrationClient.yml
index 7259d4bf1c7f..760deb06a8da 100644
--- a/preview/docs-ref-autogen/azure-communication-jobrouter/azure.communication.jobrouter.JobRouterAdministrationClient.yml
+++ b/preview/docs-ref-autogen/azure-communication-jobrouter/azure.communication.jobrouter.JobRouterAdministrationClient.yml
@@ -62,12 +62,13 @@ methods:
- "Use a JobRouterAdministrationClient to create a classification policy<!--[!code-python[Main](les\\\
classification_policy_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\classification_policy_crud_ops.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter\
- \ import (\n JobRouterAdministrationClient,\n ClassificationPolicy,\n\
- \ StaticRouterRule,\n ExpressionRouterRule,\n StaticQueueSelectorAttachment,\n\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\classification_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter import\
+ \ (\n JobRouterAdministrationClient,\n ClassificationPolicy,\n \
+ \ StaticRouterRule,\n ExpressionRouterRule,\n StaticQueueSelectorAttachment,\n\
\ ConditionalQueueSelectorAttachment,\n RouterQueueSelector,\n \
\ ConditionalWorkerSelectorAttachment,\n RouterWorkerSelector,\n \
\ LabelOperator\n )\n\n # set `connection_string` to an existing ACS endpoint\n\
@@ -127,17 +128,18 @@ methods:
examples:
- "Use a JobRouterAdministrationClient to create a distribution policy<!--[!code-python[Main](les\\\
distribution_policy_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\distribution_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter\
- \ import (\n JobRouterAdministrationClient,\n DistributionPolicy,\n\
- \ LongestIdleMode,\n )\n\n # set `connection_string` to an existing\
- \ ACS endpoint\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
- \ = connection_string)\n print(\"JobRouterAdministrationClient created successfully!\"\
- )\n\n distribution_policy: DistributionPolicy = router_admin_client.create_distribution_policy(\n\
- \ distribution_policy_id = policy_id,\n distribution_policy = DistributionPolicy(\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\distribution_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter import (\n\
+ \ JobRouterAdministrationClient,\n DistributionPolicy,\n LongestIdleMode,\n\
+ \ )\n\n # set `connection_string` to an existing ACS endpoint\n router_admin_client\
+ \ = JobRouterAdministrationClient.from_connection_string(conn_str = connection_string)\n\
+ \ print(\"JobRouterAdministrationClient created successfully!\")\n\n distribution_policy:\
+ \ DistributionPolicy = router_admin_client.create_distribution_policy(\n \
+ \ distribution_policy_id = policy_id,\n distribution_policy = DistributionPolicy(\n\
\ offer_expires_after_seconds = 1 * 60,\n mode = LongestIdleMode(\n\
\ min_concurrent_offers = 1,\n max_concurrent_offers\
\ = 1\n )\n )\n )\n\n print(f\"Distribution Policy successfully\
@@ -167,15 +169,16 @@ methods:
examples:
- "Using a JobRouterAdministrationClient to create an exception policy<!--[!code-python[Main](les\\\
exception_policy_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\exception_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter import\
- \ (\n JobRouterAdministrationClient,\n WaitTimeExceptionTrigger,\n\
- \ QueueLengthExceptionTrigger,\n ReclassifyExceptionAction,\n \
- \ ExceptionRule,\n ExceptionPolicy\n )\n\n # set `connection_string`\
- \ to an existing ACS endpoint\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\exception_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter import (\n\
+ \ JobRouterAdministrationClient,\n WaitTimeExceptionTrigger,\n \
+ \ QueueLengthExceptionTrigger,\n ReclassifyExceptionAction,\n ExceptionRule,\n\
+ \ ExceptionPolicy\n )\n\n # set `connection_string` to an existing ACS\
+ \ endpoint\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n print(\"JobRouterAdministrationClient created successfully!\"\
)\n\n # we are going to create 2 rules:\n # 1. EscalateJobOnQueueOverFlowTrigger:\
\ triggers when queue has more than 10 jobs already en-queued,\n # \
@@ -233,13 +236,14 @@ methods:
examples:
- "Use a JobRouterAdministrationClient to create a queue<!--[!code-python[Main](les\\\
job_queue_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
- \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\\
- _work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\\
- samples\\\\job_queue_crud_ops.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.communication.jobrouter import (\n\
- \ JobRouterAdministrationClient,\n RouterQueue,\n )\n\n # set\
- \ `connection_string` to an existing ACS endpoint\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
+ \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\job_queue_crud_ops.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.communication.jobrouter import (\n JobRouterAdministrationClient,\n\
+ \ RouterQueue,\n )\n\n # set `connection_string` to an existing ACS\
+ \ endpoint\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n print(\"JobRouterAdministrationClient created successfully!\"\
)\n\n job_queue: RouterQueue = router_admin_client.create_queue(\n queue_id\
\ = job_queue_id,\n queue = RouterQueue(\n distribution_policy_id\
@@ -267,11 +271,12 @@ methods:
- "Use a JobRouterAdministrationClient to delete a classification policy<!--[!code-python[Main](les\\\
classification_policy_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\classification_policy_crud_ops.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter\
- \ import JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\classification_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter import\
+ \ JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n router_admin_client.delete_classification_policy(classification_policy_id\
\ = policy_id)\n\n\n ````\n"
- uid: azure.communication.jobrouter.JobRouterAdministrationClient.delete_distribution_policy
@@ -294,12 +299,13 @@ methods:
examples:
- "Use a JobRouterAdministrationClient to delete a distribution policy<!--[!code-python[Main](les\\\
distribution_policy_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\distribution_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter\
- \ import JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\distribution_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter import JobRouterAdministrationClient\n\
+ \n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n router_admin_client.delete_distribution_policy(distribution_policy_id\
\ = policy_id)\n\n\n ````\n"
- uid: azure.communication.jobrouter.JobRouterAdministrationClient.delete_exception_policy
@@ -322,12 +328,13 @@ methods:
examples:
- "Using a JobRouterAdministrationClient to delete an exception policy<!--[!code-python[Main](les\\\
exception_policy_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\exception_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter import\
- \ JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\exception_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter import JobRouterAdministrationClient\n\
+ \n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n router_admin_client.delete_exception_policy(exception_policy_id\
\ = policy_id)\n\n\n ````\n"
- uid: azure.communication.jobrouter.JobRouterAdministrationClient.delete_queue
@@ -349,11 +356,12 @@ methods:
examples:
- "Use a JobRouterAdministrationClient to delete a queue<!--[!code-python[Main](les\\\
job_queue_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
- \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\\
- _work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\\
- samples\\\\job_queue_crud_ops.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.communication.jobrouter import JobRouterAdministrationClient\n\
+ \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\job_queue_crud_ops.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.communication.jobrouter import JobRouterAdministrationClient\n\
\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n router_admin_client.delete_queue(queue_id = job_queue_id)\n\
\n\n ````\n"
@@ -374,15 +382,15 @@ methods:
examples:
- "Authenticating a JobRouterAdministrationClient from a connection_string<!--[!code-python[Main](les\\\
sample_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter import\
- \ JobRouterAdministrationClient\n\n # set `connection_string` to an existing\
- \ ACS endpoint\n router_client = JobRouterAdministrationClient.from_connection_string(conn_str\
- \ = connection_string)\n print(\"JobRouterAdministrationClient created successfully!\"\
- )\n\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter import JobRouterAdministrationClient\n\
+ \n # set `connection_string` to an existing ACS endpoint\n router_client =\
+ \ JobRouterAdministrationClient.from_connection_string(conn_str = connection_string)\n\
+ \ print(\"JobRouterAdministrationClient created successfully!\")\n\n\n ````\n"
- uid: azure.communication.jobrouter.JobRouterAdministrationClient.get_classification_policy
name: get_classification_policy
summary: Retrieves an existing classification policy by Id.
@@ -404,11 +412,12 @@ methods:
- "Use a JobRouterAdministrationClient to get a classification policy<!--[!code-python[Main](les\\\
classification_policy_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\classification_policy_crud_ops.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter\
- \ import JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\classification_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter import\
+ \ JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n classification_policy = router_admin_client.get_classification_policy(classification_policy_id\
\ = policy_id)\n\n print(f\"Successfully fetched classification policy with\
\ id: {classification_policy.id}\")\n\n ````\n"
@@ -432,12 +441,13 @@ methods:
examples:
- "Use a JobRouterAdministrationClient to get a distribution policy<!--[!code-python[Main](les\\\
distribution_policy_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\distribution_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter\
- \ import JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\distribution_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter import JobRouterAdministrationClient\n\
+ \n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n distribution_policy = router_admin_client.get_distribution_policy(distribution_policy_id\
\ = policy_id)\n\n print(f\"Successfully fetched distribution policy with id:\
\ {distribution_policy.id}\")\n\n ````\n"
@@ -460,12 +470,13 @@ methods:
examples:
- "Using a JobRouterAdministrationClient to get an exception policy<!--[!code-python[Main](les\\\
exception_policy_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\exception_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter import\
- \ JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\exception_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter import JobRouterAdministrationClient\n\
+ \n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n exception_policy = router_admin_client.get_exception_policy(exception_policy_id\
\ = policy_id)\n\n print(f\"Successfully fetched exception policy with id: {exception_policy.id}\"\
)\n\n ````\n"
@@ -488,11 +499,12 @@ methods:
examples:
- "Use a JobRouterAdministrationClient to get a queue<!--[!code-python[Main](les\\\
job_queue_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
- \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\\
- _work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\\
- samples\\\\job_queue_crud_ops.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.communication.jobrouter import JobRouterAdministrationClient\n\
+ \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\job_queue_crud_ops.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.communication.jobrouter import JobRouterAdministrationClient\n\
\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n job_queue = router_admin_client.get_queue(queue_id\
\ = job_queue_id)\n\n print(f\"Successfully fetched router queue with id: {job_queue.id}\"\
@@ -517,11 +529,12 @@ methods:
- "Use a JobRouterAdministrationClient to list classification policies in batches<!--[!code-python[Main](les\\\
classification_policy_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\classification_policy_crud_ops.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter\
- \ import JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\classification_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter import\
+ \ JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n classification_policy_iterator = router_admin_client.list_classification_policies(results_per_page\
\ = 10)\n\n for policy_page in classification_policy_iterator.by_page():\n \
\ policies_in_page = list(policy_page)\n print(f\"Retrieved {len(policies_in_page)}\
@@ -548,12 +561,13 @@ methods:
examples:
- "Use a JobRouterAdministrationClient to list distribution policies in batches<!--[!code-python[Main](les\\\
distribution_policy_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\distribution_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter\
- \ import JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\distribution_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter import JobRouterAdministrationClient\n\
+ \n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n distribution_policy_iterator = router_admin_client.list_distribution_policies(results_per_page\
\ = 10)\n\n for policy_page in distribution_policy_iterator.by_page():\n \
\ policies_in_page = list(policy_page)\n print(f\"Retrieved {len(policies_in_page)}\
@@ -580,12 +594,13 @@ methods:
examples:
- "Using a JobRouterAdministrationClient to list exception policies in batches<!--[!code-python[Main](les\\\
exception_policy_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\exception_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter import\
- \ JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\exception_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter import JobRouterAdministrationClient\n\
+ \n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n exception_policy_iterator = router_admin_client.list_exception_policies(results_per_page\
\ = 10)\n\n for policy_page in exception_policy_iterator.by_page():\n \
\ policies_in_page = list(policy_page)\n print(f\"Retrieved {len(policies_in_page)}\
@@ -611,11 +626,12 @@ methods:
examples:
- "Use a JobRouterAdministrationClient to list queues in batches<!--[!code-python[Main](les\\\
job_queue_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
- \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\\
- _work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\\
- samples\\\\job_queue_crud_ops.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.communication.jobrouter import JobRouterAdministrationClient\n\
+ \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\job_queue_crud_ops.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.communication.jobrouter import JobRouterAdministrationClient\n\
\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n job_queue_iterator = router_admin_client.list_queues(results_per_page\
\ = 10)\n\n for queue_page in job_queue_iterator.by_page():\n job_queues_in_page\
@@ -678,12 +694,13 @@ methods:
- "Use a JobRouterAdministrationClient to update a classification policy<!--[!code-python[Main](les\\\
classification_policy_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\classification_policy_crud_ops.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter\
- \ import (\n JobRouterAdministrationClient,\n ClassificationPolicy,\n\
- \ ExpressionRouterRule,\n )\n\n # set `connection_string` to an existing\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\classification_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter import\
+ \ (\n JobRouterAdministrationClient,\n ClassificationPolicy,\n \
+ \ ExpressionRouterRule,\n )\n\n # set `connection_string` to an existing\
\ ACS endpoint\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n print(\"JobRouterAdministrationClient created successfully!\"\
)\n\n updated_classification_policy: ClassificationPolicy = router_admin_client.update_classification_policy(\n\
@@ -733,20 +750,21 @@ methods:
examples:
- "Use a JobRouterAdministrationClient to update a distribution policy<!--[!code-python[Main](les\\\
distribution_policy_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\distribution_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter\
- \ import (\n JobRouterAdministrationClient,\n DistributionPolicy,\n\
- \ RoundRobinMode,\n )\n\n # set `connection_string` to an existing ACS\
- \ endpoint\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
- \ = connection_string)\n print(\"JobRouterAdministrationClient created successfully!\"\
- )\n\n updated_distribution_policy: DistributionPolicy = router_admin_client.update_distribution_policy(\n\
- \ distribution_policy_id = policy_id,\n mode = RoundRobinMode(\n \
- \ min_concurrent_offers = 1,\n max_concurrent_offers = 1\n\
- \ )\n )\n\n print(f\"Distribution policy successfully update with new\
- \ distribution mode\")\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\distribution_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter import (\n\
+ \ JobRouterAdministrationClient,\n DistributionPolicy,\n RoundRobinMode,\n\
+ \ )\n\n # set `connection_string` to an existing ACS endpoint\n router_admin_client\
+ \ = JobRouterAdministrationClient.from_connection_string(conn_str = connection_string)\n\
+ \ print(\"JobRouterAdministrationClient created successfully!\")\n\n updated_distribution_policy:\
+ \ DistributionPolicy = router_admin_client.update_distribution_policy(\n \
+ \ distribution_policy_id = policy_id,\n mode = RoundRobinMode(\n \
+ \ min_concurrent_offers = 1,\n max_concurrent_offers = 1\n \
+ \ )\n )\n\n print(f\"Distribution policy successfully update with new distribution\
+ \ mode\")\n\n ````\n"
- uid: azure.communication.jobrouter.JobRouterAdministrationClient.update_exception_policy
name: update_exception_policy
summary: Update an exception policy.
@@ -784,13 +802,14 @@ methods:
examples:
- "Using a JobRouterAdministrationClient to update an exception policy<!--[!code-python[Main](les\\\
exception_policy_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\exception_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter import\
- \ (\n JobRouterAdministrationClient,\n WaitTimeExceptionTrigger,\n\
- \ ReclassifyExceptionAction,\n ExceptionPolicy,\n ExceptionRule,\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\exception_policy_crud_ops.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter import (\n\
+ \ JobRouterAdministrationClient,\n WaitTimeExceptionTrigger,\n \
+ \ ReclassifyExceptionAction,\n ExceptionPolicy,\n ExceptionRule,\n\
\ QueueLengthExceptionTrigger,\n )\n\n # set `connection_string` to\
\ an existing ACS endpoint\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n print(\"JobRouterAdministrationClient created successfully!\"\
@@ -872,13 +891,14 @@ methods:
examples:
- "Use a JobRouterAdministrationClient to update a queue<!--[!code-python[Main](les\\\
job_queue_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
- \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\\
- _work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\\
- samples\\\\job_queue_crud_ops.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.communication.jobrouter import (\n\
- \ JobRouterAdministrationClient,\n RouterQueue,\n )\n\n # set\
- \ `connection_string` to an existing ACS endpoint\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
+ \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\job_queue_crud_ops.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.communication.jobrouter import (\n JobRouterAdministrationClient,\n\
+ \ RouterQueue,\n )\n\n # set `connection_string` to an existing ACS\
+ \ endpoint\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n print(\"JobRouterAdministrationClient created successfully!\"\
)\n\n updated_job_queue: RouterQueue = router_admin_client.update_queue(\n \
\ queue_id = job_queue_id,\n labels = {\n \"Additional-Queue-Label\"\
diff --git a/preview/docs-ref-autogen/azure-communication-jobrouter/azure.communication.jobrouter.JobRouterClient.yml b/preview/docs-ref-autogen/azure-communication-jobrouter/azure.communication.jobrouter.JobRouterClient.yml
index b65153f1d873..9d7f81dc633a 100644
--- a/preview/docs-ref-autogen/azure-communication-jobrouter/azure.communication.jobrouter.JobRouterClient.yml
+++ b/preview/docs-ref-autogen/azure-communication-jobrouter/azure.communication.jobrouter.JobRouterClient.yml
@@ -57,8 +57,9 @@ methods:
examples:
- "Use a JobRouterClient to accept a job offer<!--[!code-python[Main](les\\router_job_crud_ops.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.communication.jobrouter import (\n RouterJob,\n AcceptJobOfferResult\n\
@@ -105,8 +106,9 @@ methods:
examples:
- "Use a JobRouterClient to cancel a job<!--[!code-python[Main](les\\router_job_crud_ops.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.communication.jobrouter import JobRouterClient\n\n router_client\
@@ -165,8 +167,9 @@ methods:
examples:
- "Use a JobRouterClient to close a job<!--[!code-python[Main](les\\router_job_crud_ops.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n router_client.close_job(\n job_id = job_id,\n assignment_id =\
@@ -205,8 +208,9 @@ methods:
examples:
- "Use a JobRouterClient to complete a job<!--[!code-python[Main](les\\router_job_crud_ops.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.communication.jobrouter import (\n JobRouterClient,\n \
@@ -241,8 +245,9 @@ methods:
examples:
- "Use a JobRouterClient to create a job<!--[!code-python[Main](les\\router_job_crud_ops.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from datetime import datetime, timedelta\n from azure.communication.jobrouter\
@@ -296,8 +301,9 @@ methods:
examples:
- "Use a JobRouterClient to create a worker<!--[!code-python[Main](les\\router_worker_crud_ops.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_worker_crud_ops.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_worker_crud_ops.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.communication.jobrouter import (\n JobRouterClient,\n \
@@ -355,8 +361,9 @@ methods:
examples:
- "Use a JobRouterClient to decline a job offer<!--[!code-python[Main](les\\router_job_crud_ops.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n router_client.decline_job_offer(\n worker_id = worker_id,\n\
@@ -381,8 +388,9 @@ methods:
examples:
- "Use a JobRouterClient to delete a job<!--[!code-python[Main](les\\router_job_crud_ops.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.communication.jobrouter import JobRouterClient\n\n router_client\
@@ -407,14 +415,14 @@ methods:
examples:
- "Use a JobRouterClient to delete an existing worker<!--[!code-python[Main](les\\\
router_worker_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\router_worker_crud_ops.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter import\
- \ JobRouterClient\n\n router_client = JobRouterClient.from_connection_string(conn_str\
- \ = connection_string)\n\n router_client.delete_worker(worker_id = worker_id)\n\
- \n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\router_worker_crud_ops.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter import JobRouterClient\n\
+ \n router_client = JobRouterClient.from_connection_string(conn_str = connection_string)\n\
+ \n router_client.delete_worker(worker_id = worker_id)\n\n\n ````\n"
- uid: azure.communication.jobrouter.JobRouterClient.from_connection_string
name: from_connection_string
summary: Create JobRouterClient from a Connection String.
@@ -432,14 +440,15 @@ methods:
examples:
- "Authenticating a JobRouterClient from a connection_string<!--[!code-python[Main](les\\\
sample_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter import\
- \ JobRouterClient\n\n # set `connection_string` to an existing ACS endpoint\n\
- \ router_client = JobRouterClient.from_connection_string(conn_str = connection_string)\n\
- \ print(\"JobRouterClient created successfully!\")\n\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter import JobRouterClient\n\
+ \n # set `connection_string` to an existing ACS endpoint\n router_client =\
+ \ JobRouterClient.from_connection_string(conn_str = connection_string)\n print(\"\
+ JobRouterClient created successfully!\")\n\n\n ````\n"
- uid: azure.communication.jobrouter.JobRouterClient.get_job
name: get_job
summary: Retrieves an existing worker by Id.
@@ -459,8 +468,9 @@ methods:
examples:
- "Use a JobRouterClient to get a job<!--[!code-python[Main](les\\router_job_crud_ops.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.communication.jobrouter import JobRouterClient\n\n router_client\
@@ -486,14 +496,15 @@ methods:
examples:
- "Use a JobRouterClient to get a job position in queue<!--[!code-python[Main](les\\\
router_job_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\":\
- \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\router_job_crud_ops.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter import\
- \ JobRouterClient\n\n router_client = JobRouterClient.from_connection_string(conn_str\
- \ = connection_string)\n\n router_job_position = router_client.get_queue_position(job_id\
- \ = job_id)\n\n print(f\"Successfully fetched router job position: {router_job_position.position}\"\
+ \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\router_job_crud_ops.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter import JobRouterClient\n\
+ \n router_client = JobRouterClient.from_connection_string(conn_str = connection_string)\n\
+ \n router_job_position = router_client.get_queue_position(job_id = job_id)\n\
+ \n print(f\"Successfully fetched router job position: {router_job_position.position}\"\
)\n\n ````\n"
- uid: azure.communication.jobrouter.JobRouterClient.get_queue_statistics
name: get_queue_statistics
@@ -514,14 +525,14 @@ methods:
examples:
- "Use a JobRouterClient to fetch queue statistics<!--[!code-python[Main](les\\\
job_queue_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
- \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\\
- _work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\\
- samples\\\\job_queue_crud_ops.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.communication.jobrouter import (\n\
- \ JobRouterClient,\n RouterQueueStatistics\n )\n\n router_client:\
- \ JobRouterClient = JobRouterClient.from_connection_string(conn_str = connection_string)\n\
- \n job_queue_statistics: RouterQueueStatistics = router_client.get_queue_statistics(queue_id\
+ \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\job_queue_crud_ops.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.communication.jobrouter import (\n JobRouterClient,\n \
+ \ RouterQueueStatistics\n )\n\n router_client: JobRouterClient = JobRouterClient.from_connection_string(conn_str\
+ \ = connection_string)\n\n job_queue_statistics: RouterQueueStatistics = router_client.get_queue_statistics(queue_id\
\ = job_queue_id)\n\n print(f\"Successfully fetched queue statistics router\
\ queue: {job_queue_statistics}\")\n\n ````\n"
- uid: azure.communication.jobrouter.JobRouterClient.get_worker
@@ -543,8 +554,9 @@ methods:
examples:
- "Use a JobRouterClient to get a worker<!--[!code-python[Main](les\\router_worker_crud_ops.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_worker_crud_ops.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_worker_crud_ops.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.communication.jobrouter import JobRouterClient\n\n router_client\
@@ -608,12 +620,13 @@ methods:
examples:
- "Use a JobRouterClient to retrieve scheduled jobs<!--[!code-python[Main](les\\\
router_job_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\":\
- \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\router_job_crud_ops.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from datetime import datetime\n from\
- \ azure.communication.jobrouter import JobRouterClient\n\n router_client = JobRouterClient.from_connection_string(conn_str\
+ \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\router_job_crud_ops.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from datetime import datetime\n from azure.communication.jobrouter\
+ \ import JobRouterClient\n\n router_client = JobRouterClient.from_connection_string(conn_str\
\ = connection_string)\n\n scheduled_before = datetime.utcnow()\n\n router_job_iterator\
\ = router_client.list_jobs(scheduled_before = scheduled_before, results_per_page\
\ = 10)\n\n for job_page in router_job_iterator.by_page():\n jobs_in_page\
@@ -667,14 +680,15 @@ methods:
examples:
- "Use a JobRouterClient to retrieve workers in batches<!--[!code-python[Main](les\\\
router_worker_crud_ops.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\router_worker_crud_ops.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter import\
- \ JobRouterClient\n\n router_client = JobRouterClient.from_connection_string(conn_str\
- \ = connection_string)\n\n router_worker_iterator = router_client.list_workers(results_per_page\
- \ = 10)\n\n for worker_page in router_worker_iterator.by_page():\n workers_in_page\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\router_worker_crud_ops.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter import JobRouterClient\n\
+ \n router_client = JobRouterClient.from_connection_string(conn_str = connection_string)\n\
+ \n router_worker_iterator = router_client.list_workers(results_per_page = 10)\n\
+ \n for worker_page in router_worker_iterator.by_page():\n workers_in_page\
\ = list(worker_page)\n print(f\"Retrieved {len(workers_in_page)} workers\
\ in current page\")\n\n for w in workers_in_page:\n print(f\"\
Retrieved worker with id: {w.worker.id}\")\n\n print(f\"Successfully completed\
@@ -698,8 +712,9 @@ methods:
examples:
- "Use a JobRouterClient to re-classify a job<!--[!code-python[Main](les\\router_job_crud_ops.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.communication.jobrouter import JobRouterClient\n\n router_client\
@@ -737,8 +752,9 @@ methods:
examples:
- "Use a JobRouterClient to unassign a job<!--[!code-python[Main](les\\router_job_crud_ops.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.communication.jobrouter import JobRouterClient\n\n router_client\
@@ -825,8 +841,9 @@ methods:
examples:
- "Use a JobRouterClient to update a job<!--[!code-python[Main](les\\router_job_crud_ops.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.communication.jobrouter import (\n JobRouterClient,\n \
@@ -898,8 +915,9 @@ methods:
examples:
- "Use a JobRouterClient to de-register a worker<!--[!code-python[Main](les\\router_worker_crud_ops.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_worker_crud_ops.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_worker_crud_ops.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.communication.jobrouter import JobRouterClient\n\n router_client\
diff --git a/preview/docs-ref-autogen/azure-communication-jobrouter/azure.communication.jobrouter.aio.JobRouterAdministrationClient.yml b/preview/docs-ref-autogen/azure-communication-jobrouter/azure.communication.jobrouter.aio.JobRouterAdministrationClient.yml
index f0f184648d32..29e29935efea 100644
--- a/preview/docs-ref-autogen/azure-communication-jobrouter/azure.communication.jobrouter.aio.JobRouterAdministrationClient.yml
+++ b/preview/docs-ref-autogen/azure-communication-jobrouter/azure.communication.jobrouter.aio.JobRouterAdministrationClient.yml
@@ -62,10 +62,11 @@ methods:
- "Use a JobRouterAdministrationClient to create a classification policy<!--[!code-python[Main](les\\\
classification_policy_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\classification_policy_crud_ops_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\classification_policy_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
\ import JobRouterAdministrationClient\n from azure.communication.jobrouter\
\ import (\n ClassificationPolicy,\n StaticRouterRule,\n ExpressionRouterRule,\n\
\ StaticQueueSelectorAttachment,\n ConditionalQueueSelectorAttachment,\n\
@@ -131,10 +132,11 @@ methods:
- "Use a JobRouterAdministrationClient to create a distribution policy<!--[!code-python[Main](les\\\
distribution_policy_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\distribution_policy_crud_ops_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\distribution_policy_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
\ import JobRouterAdministrationClient\n from azure.communication.jobrouter\
\ import (\n DistributionPolicy,\n LongestIdleMode,\n )\n\n #\
\ set `connection_string` to an existing ACS endpoint\n router_admin_client\
@@ -173,10 +175,11 @@ methods:
- "Use a JobRouterAdministrationClient to create an exception policy<!--[!code-python[Main](les\\\
exception_policy_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\exception_policy_crud_ops_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\exception_policy_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
\ import JobRouterAdministrationClient\n from azure.communication.jobrouter\
\ import (\n WaitTimeExceptionTrigger,\n QueueLengthExceptionTrigger,\n\
\ ReclassifyExceptionAction,\n ExceptionRule,\n ExceptionPolicy\n\
@@ -240,13 +243,14 @@ methods:
examples:
- "Use a JobRouterAdministrationClient to create a queue<!--[!code-python[Main](les\\\
job_queue_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\job_queue_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
- \ import JobRouterAdministrationClient\n from azure.communication.jobrouter\
- \ import (\n RouterQueue,\n )\n\n # set `connection_string` to an existing\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\job_queue_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter.aio import\
+ \ JobRouterAdministrationClient\n from azure.communication.jobrouter import\
+ \ (\n RouterQueue,\n )\n\n # set `connection_string` to an existing\
\ ACS endpoint\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n print(\"JobRouterAdministrationClient created successfully!\"\
)\n\n async with router_admin_client:\n job_queue: RouterQueue = await\
@@ -275,10 +279,11 @@ methods:
- "Use a JobRouterAdministrationClient to delete a classification policy<!--[!code-python[Main](les\\\
classification_policy_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\classification_policy_crud_ops_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\classification_policy_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
\ import JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n async with router_admin_client:\n await router_admin_client.delete_classification_policy(classification_policy_id\
\ = policy_id)\n\n\n ````\n"
@@ -303,10 +308,11 @@ methods:
- "Use a JobRouterAdministrationClient to delete a distribution policy<!--[!code-python[Main](les\\\
distribution_policy_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\distribution_policy_crud_ops_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\distribution_policy_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
\ import JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n async with router_admin_client:\n await router_admin_client.delete_distribution_policy(distribution_policy_id\
\ = policy_id)\n\n\n ````\n"
@@ -331,10 +337,11 @@ methods:
- "Use a JobRouterAdministrationClient to delete an exception policy<!--[!code-python[Main](les\\\
exception_policy_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\exception_policy_crud_ops_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\exception_policy_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
\ import JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n async with router_admin_client:\n await router_admin_client.delete_exception_policy(exception_policy_id\
\ = policy_id)\n\n\n ````\n"
@@ -357,12 +364,13 @@ methods:
examples:
- "Use a JobRouterAdministrationClient to delete a queue<!--[!code-python[Main](les\\\
job_queue_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\job_queue_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
- \ import JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\job_queue_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter.aio import\
+ \ JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n async with router_admin_client:\n await router_admin_client.delete_queue(queue_id\
\ = job_queue_id)\n\n\n ````\n"
- uid: azure.communication.jobrouter.aio.JobRouterAdministrationClient.from_connection_string
@@ -382,12 +390,13 @@ methods:
examples:
- "Authenticating a JobRouterAdministrationClient from a connection_string<!--[!code-python[Main](les\\\
sample_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\sample_authentication_async.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
- \ import JobRouterAdministrationClient\n\n # set `connection_string` to an existing\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\sample_authentication_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter.aio import\
+ \ JobRouterAdministrationClient\n\n # set `connection_string` to an existing\
\ ACS endpoint\n router_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n print(\"JobRouterAdministrationClient created successfully!\"\
)\n\n\n ````\n"
@@ -412,10 +421,11 @@ methods:
- "Use a JobRouterAdministrationClient to get a classification policy<!--[!code-python[Main](les\\\
classification_policy_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\classification_policy_crud_ops_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\classification_policy_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
\ import JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n async with router_admin_client:\n classification_policy\
\ = await router_admin_client.get_classification_policy(\n classification_policy_id\
@@ -442,10 +452,11 @@ methods:
- "Use a JobRouterAdministrationClient to get a distribution policy<!--[!code-python[Main](les\\\
distribution_policy_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\distribution_policy_crud_ops_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\distribution_policy_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
\ import JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n async with router_admin_client:\n distribution_policy\
\ = await router_admin_client.get_distribution_policy(distribution_policy_id =\
@@ -472,10 +483,11 @@ methods:
- "Use a JobRouterAdministrationClient to get an exception policy<!--[!code-python[Main](les\\\
exception_policy_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\exception_policy_crud_ops_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\exception_policy_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
\ import JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n async with router_admin_client:\n exception_policy\
\ = await router_admin_client.get_exception_policy(exception_policy_id = policy_id)\n\
@@ -500,12 +512,13 @@ methods:
examples:
- "Use a JobRouterAdministrationClient to get a queue<!--[!code-python[Main](les\\\
job_queue_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\job_queue_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
- \ import JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\job_queue_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter.aio import\
+ \ JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n async with router_admin_client:\n job_queue\
\ = await router_admin_client.get_queue(queue_id = job_queue_id)\n\n print(f\"\
Successfully fetched router queue with id: {job_queue.id}\")\n\n ````\n"
@@ -529,10 +542,11 @@ methods:
- "Use a JobRouterAdministrationClient to list classification policies in batches<!--[!code-python[Main](les\\\
classification_policy_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\classification_policy_crud_ops_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\classification_policy_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
\ import JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n async with router_admin_client:\n classification_policy_iterator\
\ = router_admin_client.list_classification_policies(results_per_page = 10)\n\n\
@@ -562,10 +576,11 @@ methods:
- "Use a JobRouterAdministrationClient to list distribution policies in batches<!--[!code-python[Main](les\\\
distribution_policy_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\distribution_policy_crud_ops_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\distribution_policy_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
\ import JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n async with router_admin_client:\n distribution_policy_iterator\
\ = router_admin_client.list_distribution_policies(results_per_page = 10)\n\n\
@@ -595,10 +610,11 @@ methods:
- "Use a JobRouterAdministrationClient to list exception policies in batches<!--[!code-python[Main](les\\\
exception_policy_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\exception_policy_crud_ops_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\exception_policy_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
\ import JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n async with router_admin_client:\n exception_policy_iterator\
\ = router_admin_client.list_exception_policies(results_per_page = 10)\n\n \
@@ -627,12 +643,13 @@ methods:
examples:
- "Use a JobRouterAdministrationClient to list queues in batches<!--[!code-python[Main](les\\\
job_queue_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\job_queue_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
- \ import JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\job_queue_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter.aio import\
+ \ JobRouterAdministrationClient\n\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n\n async with router_admin_client:\n job_queue_iterator\
\ = router_admin_client.list_queues(results_per_page = 10)\n\n async for\
\ queue_page in job_queue_iterator.by_page():\n job_queues_in_page =\
@@ -695,10 +712,11 @@ methods:
- "Use a JobRouterAdministrationClient to update a classification policy<!--[!code-python[Main](les\\\
classification_policy_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\classification_policy_crud_ops_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\classification_policy_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
\ import JobRouterAdministrationClient\n from azure.communication.jobrouter\
\ import (\n ClassificationPolicy,\n ExpressionRouterRule,\n )\n\
\n # set `connection_string` to an existing ACS endpoint\n router_admin_client\
@@ -761,10 +779,11 @@ methods:
- "Use a JobRouterAdministrationClient to update a distribution policy<!--[!code-python[Main](les\\\
distribution_policy_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\distribution_policy_crud_ops_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\distribution_policy_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
\ import JobRouterAdministrationClient\n from azure.communication.jobrouter\
\ import (\n DistributionPolicy,\n RoundRobinMode,\n )\n\n # set\
\ `connection_string` to an existing ACS endpoint\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
@@ -820,10 +839,11 @@ methods:
- "Use a JobRouterAdministrationClient to update an exception policy<!--[!code-python[Main](les\\\
exception_policy_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\exception_policy_crud_ops_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\exception_policy_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
\ import JobRouterAdministrationClient\n from azure.communication.jobrouter\
\ import (\n WaitTimeExceptionTrigger,\n ReclassifyExceptionAction,\n\
\ ExceptionPolicy,\n ExceptionRule,\n QueueLengthExceptionTrigger,\n\
@@ -910,13 +930,14 @@ methods:
examples:
- "Use a JobRouterAdministrationClient to update a queue<!--[!code-python[Main](les\\\
job_queue_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\job_queue_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
- \ import JobRouterAdministrationClient\n from azure.communication.jobrouter\
- \ import (\n RouterQueue,\n )\n\n # set `connection_string` to an existing\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\job_queue_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter.aio import\
+ \ JobRouterAdministrationClient\n from azure.communication.jobrouter import\
+ \ (\n RouterQueue,\n )\n\n # set `connection_string` to an existing\
\ ACS endpoint\n router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str\
\ = connection_string)\n print(\"JobRouterAdministrationClient created successfully!\"\
)\n\n async with router_admin_client:\n updated_job_queue: RouterQueue\
diff --git a/preview/docs-ref-autogen/azure-communication-jobrouter/azure.communication.jobrouter.aio.JobRouterClient.yml b/preview/docs-ref-autogen/azure-communication-jobrouter/azure.communication.jobrouter.aio.JobRouterClient.yml
index 9415b3a15ee5..734fffa10133 100644
--- a/preview/docs-ref-autogen/azure-communication-jobrouter/azure.communication.jobrouter.aio.JobRouterClient.yml
+++ b/preview/docs-ref-autogen/azure-communication-jobrouter/azure.communication.jobrouter.aio.JobRouterClient.yml
@@ -58,8 +58,9 @@ methods:
examples:
- "Use a JobRouterClient to accept a job offer<!--[!code-python[Main](les\\router_job_crud_ops_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.communication.jobrouter import (\n RouterJob,\n\
@@ -107,8 +108,9 @@ methods:
examples:
- "Use a JobRouterClient to cancel a job<!--[!code-python[Main](les\\router_job_crud_ops_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.communication.jobrouter.aio import JobRouterClient\n\n router_client\
@@ -168,8 +170,9 @@ methods:
examples:
- "Use a JobRouterClient to close a job<!--[!code-python[Main](les\\router_job_crud_ops_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n await router_client.close_job(\n job_id = job_id,\n \
@@ -208,8 +211,9 @@ methods:
examples:
- "Use a JobRouterClient to complete a job<!--[!code-python[Main](les\\router_job_crud_ops_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.communication.jobrouter.aio import JobRouterClient\n from azure.communication.jobrouter\
@@ -246,8 +250,9 @@ methods:
examples:
- "Use a JobRouterClient to create a job<!--[!code-python[Main](les\\router_job_crud_ops_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from datetime import datetime, timedelta\n from azure.communication.jobrouter\
@@ -305,8 +310,9 @@ methods:
examples:
- "Use a JobRouterClient to create a worker<!--[!code-python[Main](les\\router_worker_crud_ops_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_worker_crud_ops_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_worker_crud_ops_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.communication.jobrouter.aio import JobRouterClient\n from azure.communication.jobrouter\
@@ -366,8 +372,9 @@ methods:
examples:
- "Use a JobRouterClient to decline a job offer<!--[!code-python[Main](les\\router_job_crud_ops_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n await router_client.decline_job_offer(\n worker_id\
@@ -391,8 +398,9 @@ methods:
examples:
- "Use a JobRouterClient to delete a job<!--[!code-python[Main](les\\router_job_crud_ops_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.communication.jobrouter.aio import JobRouterClient\n\n router_client\
@@ -418,12 +426,13 @@ methods:
examples:
- "Use a JobRouterClient to delete an existing worker<!--[!code-python[Main](les\\\
router_worker_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\router_worker_crud_ops_async.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
- \ import JobRouterClient\n\n router_client = JobRouterClient.from_connection_string(conn_str\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\router_worker_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter.aio import\
+ \ JobRouterClient\n\n router_client = JobRouterClient.from_connection_string(conn_str\
\ = connection_string)\n\n async with router_client:\n await router_client.delete_worker(worker_id\
\ = worker_id)\n\n\n ````\n"
- uid: azure.communication.jobrouter.aio.JobRouterClient.from_connection_string
@@ -443,12 +452,13 @@ methods:
examples:
- "Authenticating a JobRouterClient from a connection_string<!--[!code-python[Main](les\\\
sample_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\sample_authentication_async.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
- \ import JobRouterClient\n\n # set `connection_string` to an existing ACS endpoint\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\sample_authentication_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter.aio import\
+ \ JobRouterClient\n\n # set `connection_string` to an existing ACS endpoint\n\
\ router_client = JobRouterClient.from_connection_string(conn_str = connection_string)\n\
\ print(\"JobRouterClient created successfully!\")\n\n\n ````\n"
- uid: azure.communication.jobrouter.aio.JobRouterClient.get_job
@@ -470,8 +480,9 @@ methods:
examples:
- "Use a JobRouterClient to get a job<!--[!code-python[Main](les\\router_job_crud_ops_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.communication.jobrouter.aio import JobRouterClient\n\n router_client\
@@ -498,12 +509,13 @@ methods:
examples:
- "Use a JobRouterClient to get a job position in queue<!--[!code-python[Main](les\\\
router_job_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\router_job_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
- \ import JobRouterClient\n\n router_client = JobRouterClient.from_connection_string(conn_str\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\router_job_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter.aio import\
+ \ JobRouterClient\n\n router_client = JobRouterClient.from_connection_string(conn_str\
\ = connection_string)\n\n async with router_client:\n router_job_position\
\ = await router_client.get_queue_position(job_id = job_id)\n\n print(f\"\
Successfully fetched router job position: {router_job_position.position}\")\n\n\
@@ -527,13 +539,14 @@ methods:
examples:
- "Use a JobRouterClient to fetch queue statistics<!--[!code-python[Main](les\\\
job_queue_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\job_queue_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
- \ import JobRouterClient\n from azure.communication.jobrouter import (\n \
- \ RouterQueueStatistics\n )\n\n router_client: JobRouterClient = JobRouterClient.from_connection_string(conn_str\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\job_queue_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter.aio import\
+ \ JobRouterClient\n from azure.communication.jobrouter import (\n RouterQueueStatistics\n\
+ \ )\n\n router_client: JobRouterClient = JobRouterClient.from_connection_string(conn_str\
\ = connection_string)\n\n async with router_client:\n job_queue_statistics:\
\ RouterQueueStatistics = await router_client.get_queue_statistics(queue_id =\
\ job_queue_id)\n\n print(f\"Successfully fetched queue statistics router\
@@ -557,8 +570,9 @@ methods:
examples:
- "Use a JobRouterClient to get a worker<!--[!code-python[Main](les\\router_worker_crud_ops_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_worker_crud_ops_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_worker_crud_ops_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.communication.jobrouter.aio import JobRouterClient\n\n router_client\
@@ -623,16 +637,16 @@ methods:
examples:
- "Use a JobRouterClient to retrieve scheduled jobs<!--[!code-python[Main](les\\\
router_job_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\router_job_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from datetime import datetime\n from\
- \ azure.communication.jobrouter.aio import JobRouterClient\n\n router_client\
- \ = JobRouterClient.from_connection_string(conn_str = connection_string)\n\n \
- \ scheduled_before = datetime.utcnow()\n\n async with router_client:\n \
- \ router_job_iterator = router_client.list_jobs(scheduled_before = scheduled_before,\
- \ results_per_page = 10)\n\n async for job_page in router_job_iterator.by_page():\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\router_job_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from datetime import datetime\n from azure.communication.jobrouter.aio\
+ \ import JobRouterClient\n\n router_client = JobRouterClient.from_connection_string(conn_str\
+ \ = connection_string)\n\n scheduled_before = datetime.utcnow()\n\n async\
+ \ with router_client:\n router_job_iterator = router_client.list_jobs(scheduled_before\
+ \ = scheduled_before, results_per_page = 10)\n\n async for job_page in router_job_iterator.by_page():\n\
\ jobs_in_page = [i async for i in job_page]\n print(f\"Retrieved\
\ {len(jobs_in_page)} jobs in current page\")\n\n for j in jobs_in_page:\n\
\ print(f\"Retrieved job with id: {j.job.id}\")\n\n print(f\"\
@@ -683,12 +697,13 @@ methods:
examples:
- "Use a JobRouterClient to retrieve workers in batches<!--[!code-python[Main](les\\\
router_worker_crud_ops_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\
- \\samples\\\\router_worker_crud_ops_async.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.communication.jobrouter.aio\
- \ import JobRouterClient\n\n router_client = JobRouterClient.from_connection_string(conn_str\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\
+ \\router_worker_crud_ops_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.communication.jobrouter.aio import\
+ \ JobRouterClient\n\n router_client = JobRouterClient.from_connection_string(conn_str\
\ = connection_string)\n\n async with router_client:\n router_worker_iterator\
\ = router_client.list_workers(results_per_page = 10)\n\n async for worker_page\
\ in router_worker_iterator.by_page():\n workers_in_page = [i async\
@@ -715,8 +730,9 @@ methods:
examples:
- "Use a JobRouterClient to re-classify a job<!--[!code-python[Main](les\\router_job_crud_ops_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.communication.jobrouter.aio import JobRouterClient\n\n router_client\
@@ -754,8 +770,9 @@ methods:
examples:
- "Use a JobRouterClient to unassign a job<!--[!code-python[Main](les\\router_job_crud_ops_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.communication.jobrouter.aio import JobRouterClient\n\n router_client\
@@ -843,8 +860,9 @@ methods:
examples:
- "Use a JobRouterClient to update a job<!--[!code-python[Main](les\\router_job_crud_ops_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_job_crud_ops_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.communication.jobrouter.aio import (\n JobRouterClient,\n\
@@ -924,8 +942,9 @@ methods:
examples:
- "Use a JobRouterClient to de-register a worker<!--[!code-python[Main](les\\router_worker_crud_ops_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_worker_crud_ops_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 28\\\\azure-communication-jobrouter-1.0.0b1\\\\samples\\\\router_worker_crud_ops_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.communication.jobrouter.aio import JobRouterClient\n\n router_client\
diff --git a/preview/docs-ref-autogen/azure-communication-networktraversal/azure.communication.networktraversal.aio.CommunicationRelayClient.yml b/preview/docs-ref-autogen/azure-communication-networktraversal/azure.communication.networktraversal.aio.CommunicationRelayClient.yml
index 328c08b10d1b..f62ba64922dc 100644
--- a/preview/docs-ref-autogen/azure-communication-networktraversal/azure.communication.networktraversal.aio.CommunicationRelayClient.yml
+++ b/preview/docs-ref-autogen/azure-communication-networktraversal/azure.communication.networktraversal.aio.CommunicationRelayClient.yml
@@ -23,7 +23,8 @@ constructor:
examples:
- "<!--[!code-python[Main](les\\network_traversal_samples_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\":\
- \ [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\29\\\\azure-communication-networktraversal-1.1.0b1\\\
+ \ [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\29\\\\azure-communication-networktraversal-1.1.0b1\\\
\\samples\\\\network_traversal_samples_async.py\", \"xml:space\": \"preserve\",\
\ \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
: 1}, \"linenos\": false} -->\n\n````python\n\n : utf-8\n\n -------------------------------------------------------------------\n\
diff --git a/preview/docs-ref-autogen/azure-containerregistry/azure.containerregistry.ContainerRegistryClient.yml b/preview/docs-ref-autogen/azure-containerregistry/azure.containerregistry.ContainerRegistryClient.yml
index bbb044a8528d..3addd46470cc 100644
--- a/preview/docs-ref-autogen/azure-containerregistry/azure.containerregistry.ContainerRegistryClient.yml
+++ b/preview/docs-ref-autogen/azure-containerregistry/azure.containerregistry.ContainerRegistryClient.yml
@@ -44,9 +44,10 @@ constructor:
examples:
- "Instantiate an instance of *ContainerRegistryClient*<!--[!code-python[Main](les\\\
sample_hello_world.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
- \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\
- \\1\\\\s\\\\dist_temp\\\\32\\\\azure-containerregistry-1.1.0b4\\\\samples\\\\sample_hello_world.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\32\\\\azure-containerregistry-1.1.0b4\\\\samples\\\\sample_hello_world.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n with ContainerRegistryClient(self.endpoint,\
\ self.credential, audience=self.audience) as client:\n\n ````\n"
methods:
@@ -124,12 +125,12 @@ methods:
examples:
- "Delete a repository from the *ContainerRegistryClient*<!--[!code-python[Main](les\\\
sample_hello_world.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
- \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\\
- _work\\\\1\\\\s\\\\dist_temp\\\\32\\\\azure-containerregistry-1.1.0b4\\\\samples\\\
- \\sample_hello_world.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
- : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
- \n````python\n\n client.delete_repository(repository_name)\n\n \
- \ ````\n"
+ \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\32\\\\azure-containerregistry-1.1.0b4\\\\samples\\\\sample_hello_world.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n client.delete_repository(repository_name)\n\n ````\n"
- uid: azure.containerregistry.ContainerRegistryClient.delete_tag
name: delete_tag
summary: "Delete a tag from a repository. If the tag cannot be found or a response\
@@ -326,12 +327,13 @@ methods:
examples:
- "List repositories in a container registry account<!--[!code-python[Main](les\\\
sample_delete_tags.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
- \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\\
- _work\\\\1\\\\s\\\\dist_temp\\\\32\\\\azure-containerregistry-1.1.0b4\\\\samples\\\
- \\sample_delete_tags.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
- : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
- \n````python\n\n for repository in client.list_repository_names():\n \
- \ print(repository)\n\n ````\n"
+ \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\32\\\\azure-containerregistry-1.1.0b4\\\\samples\\\\sample_delete_tags.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n for repository in client.list_repository_names():\n print(repository)\n\
+ \n ````\n"
- uid: azure.containerregistry.ContainerRegistryClient.list_tag_properties
name: list_tag_properties
summary: "List the tags for a repository\n\nExample\n\n<!-- literal_block {\"ids\"\
diff --git a/preview/docs-ref-autogen/azure-core-tracing-opencensus/azure.core.tracing.ext.yml b/preview/docs-ref-autogen/azure-core-tracing-opencensus/azure.core.tracing.ext.yml
new file mode 100644
index 000000000000..d1036abd0263
--- /dev/null
+++ b/preview/docs-ref-autogen/azure-core-tracing-opencensus/azure.core.tracing.ext.yml
@@ -0,0 +1,7 @@
+### YamlMime:PythonPackage
+uid: azure.core.tracing.ext
+name: ext
+fullName: azure.core.tracing.ext
+type: import
+packages:
+- azure.core.tracing.ext.opencensus_span
diff --git a/preview/docs-ref-autogen/azure-core-tracing-opencensus/index.yml b/preview/docs-ref-autogen/azure-core-tracing-opencensus/index.yml
index 4980f04d3f41..a02612342b47 100644
--- a/preview/docs-ref-autogen/azure-core-tracing-opencensus/index.yml
+++ b/preview/docs-ref-autogen/azure-core-tracing-opencensus/index.yml
@@ -4,4 +4,4 @@ name: azure-core-tracing-opencensus
fullName: azure-core-tracing-opencensus
type: distribution
packages:
-- azure.core.tracing.ext.opencensus_span
+- azure.core.tracing.ext
diff --git a/preview/docs-ref-autogen/azure-core-tracing-opentelemetry/azure.core.tracing.ext.yml b/preview/docs-ref-autogen/azure-core-tracing-opentelemetry/azure.core.tracing.ext.yml
new file mode 100644
index 000000000000..1c47029a4811
--- /dev/null
+++ b/preview/docs-ref-autogen/azure-core-tracing-opentelemetry/azure.core.tracing.ext.yml
@@ -0,0 +1,7 @@
+### YamlMime:PythonPackage
+uid: azure.core.tracing.ext
+name: ext
+fullName: azure.core.tracing.ext
+type: import
+packages:
+- azure.core.tracing.ext.opentelemetry_span
diff --git a/preview/docs-ref-autogen/azure-core-tracing-opentelemetry/index.yml b/preview/docs-ref-autogen/azure-core-tracing-opentelemetry/index.yml
index 04477969c042..c368a4e2880c 100644
--- a/preview/docs-ref-autogen/azure-core-tracing-opentelemetry/index.yml
+++ b/preview/docs-ref-autogen/azure-core-tracing-opentelemetry/index.yml
@@ -4,4 +4,4 @@ name: azure-core-tracing-opentelemetry
fullName: azure-core-tracing-opentelemetry
type: distribution
packages:
-- azure.core.tracing.ext.opentelemetry_span
+- azure.core.tracing.ext
diff --git a/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.ContainerProxy.yml b/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.ContainerProxy.yml
index d853cf7515f2..257a12c70d34 100644
--- a/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.ContainerProxy.yml
+++ b/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.ContainerProxy.yml
@@ -409,23 +409,25 @@ methods:
examples:
- "Get all products that have not been discontinued:<!--[!code-python[Main](les\\\
examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import json\n\
- \n for item in container.query_items(\n query='SELECT * FROM products\
- \ p WHERE p.productModel <> \"DISCONTINUED\"',\n enable_cross_partition_query=True,\n\
- \ ):\n print(json.dumps(item, indent=True))\n\n ````\n\nParameterized\
- \ query to get all products that have been discontinued:<!--[!code-python[Main](les\\\
- examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n discontinued_items\
- \ = container.query_items(\n query='SELECT * FROM products p WHERE p.productModel\
- \ = @model AND p.productName=\"Widget\"',\n parameters=[dict(name=\"@model\"\
- , value=\"DISCONTINUED\")],\n )\n for item in discontinued_items:\n \
- \ print(json.dumps(item, indent=True))\n\n ````\n"
+ : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n import json\n\n for item in\
+ \ container.query_items(\n query='SELECT * FROM products p WHERE p.productModel\
+ \ <> \"DISCONTINUED\"',\n enable_cross_partition_query=True,\n ):\n \
+ \ print(json.dumps(item, indent=True))\n\n ````\n\nParameterized query to\
+ \ get all products that have been discontinued:<!--[!code-python[Main](les\\examples.py\
+ \ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n discontinued_items = container.query_items(\n\
+ \ query='SELECT * FROM products p WHERE p.productModel = @model AND p.productName=\"\
+ Widget\"',\n parameters=[dict(name=\"@model\", value=\"DISCONTINUED\")],\n\
+ \ )\n for item in discontinued_items:\n print(json.dumps(item, indent=True))\n\
+ \n ````\n"
- uid: azure.cosmos.ContainerProxy.query_items_change_feed
name: query_items_change_feed
summary: Get a sorted list of items that were changed, in the order in which they
@@ -582,10 +584,11 @@ methods:
examples:
- "Get an item from the database and update one of its properties:<!--[!code-python[Main](les\\\
examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n item = container.read_item(\"\
+ : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n item = container.read_item(\"\
item2\", partition_key=\"Widget\")\n item[\"productModel\"] = \"DISCONTINUED\"\
\n updated_item = container.upsert_item(item)\n\n ````\n"
- uid: azure.cosmos.ContainerProxy.read_offer
diff --git a/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.CosmosClient.yml b/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.CosmosClient.yml
index b3b73073b03e..2b6b7e537c89 100644
--- a/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.CosmosClient.yml
+++ b/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.CosmosClient.yml
@@ -123,13 +123,13 @@ constructor:
examples:
- "Create a new instance of the Cosmos DB client:<!--[!code-python[Main](les\\examples.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.cosmos import exceptions,\
- \ CosmosClient, PartitionKey\n\n import os\n\n url = os.environ[\"ACCOUNT_URI\"\
- ]\n key = os.environ[\"ACCOUNT_KEY\"]\n client = CosmosClient(url, key)\n\n\
- \ ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\
+ \\samples\\\\examples.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
+ : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
+ \n````python\n\n from azure.cosmos import exceptions, CosmosClient, PartitionKey\n\
+ \n import os\n\n url = os.environ[\"ACCOUNT_URI\"]\n key = os.environ[\"ACCOUNT_KEY\"\
+ ]\n client = CosmosClient(url, key)\n\n ````\n"
methods:
- uid: azure.cosmos.CosmosClient.create_database
name: create_database
@@ -178,12 +178,13 @@ methods:
examples:
- "Create a database in the Cosmos DB account:<!--[!code-python[Main](les\\examples.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n database_name\
- \ = \"testDatabase\"\n try:\n database = client.create_database(id=database_name)\n\
- \ except exceptions.CosmosResourceExistsError:\n database = client.get_database_client(database=database_name)\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n database_name = \"testDatabase\"\
+ \n try:\n database = client.create_database(id=database_name)\n except\
+ \ exceptions.CosmosResourceExistsError:\n database = client.get_database_client(database=database_name)\n\
\n ````\n"
- uid: azure.cosmos.CosmosClient.create_database_if_not_exists
name: create_database_if_not_exists
diff --git a/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.DatabaseProxy.yml b/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.DatabaseProxy.yml
index 52aa80db39c5..4925df2d0d14 100644
--- a/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.DatabaseProxy.yml
+++ b/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.DatabaseProxy.yml
@@ -120,25 +120,26 @@ methods:
examples:
- "Create a container with default settings:<!--[!code-python[Main](les\\examples.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n container_name\
- \ = \"products\"\n try:\n container = database.create_container(\n \
- \ id=container_name, partition_key=PartitionKey(path=\"/productName\")\n\
- \ )\n except exceptions.CosmosResourceExistsError:\n container =\
- \ database.get_container_client(container_name)\n\n ````\n\nCreate a container\
- \ with specific settings; in this case, a custom partition key:<!--[!code-python[Main](les\\\
- examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n customer_container_name\
- \ = \"customers\"\n try:\n customer_container = database.create_container(\n\
- \ id=customer_container_name,\n partition_key=PartitionKey(path=\"\
- /city\"),\n default_ttl=200,\n )\n except exceptions.CosmosResourceExistsError:\n\
- \ customer_container = database.get_container_client(customer_container_name)\n\
- \n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n container_name = \"products\"\
+ \n try:\n container = database.create_container(\n id=container_name,\
+ \ partition_key=PartitionKey(path=\"/productName\")\n )\n except exceptions.CosmosResourceExistsError:\n\
+ \ container = database.get_container_client(container_name)\n\n ````\n\
+ \nCreate a container with specific settings; in this case, a custom partition\
+ \ key:<!--[!code-python[Main](les\\examples.py )]-->\n\n<!-- literal_block {\"\
+ ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\\
+ samples\\\\examples.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
+ : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
+ \n````python\n\n customer_container_name = \"customers\"\n try:\n customer_container\
+ \ = database.create_container(\n id=customer_container_name,\n \
+ \ partition_key=PartitionKey(path=\"/city\"),\n default_ttl=200,\n\
+ \ )\n except exceptions.CosmosResourceExistsError:\n customer_container\
+ \ = database.get_container_client(customer_container_name)\n\n ````\n"
- uid: azure.cosmos.DatabaseProxy.create_container_if_not_exists
name: create_container_if_not_exists
summary: 'Create a container if it does not exist already.
@@ -252,10 +253,11 @@ methods:
examples:
- "Create a database user:<!--[!code-python[Main](les\\examples.py )]-->\n\n<!--\
\ literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [],\
- \ \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n try:\n database.create_user(dict(id=\"\
+ \ \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\
+ \\samples\\\\examples.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n try:\n database.create_user(dict(id=\"\
Walter Harp\"))\n except exceptions.CosmosResourceExistsError:\n print(\"\
A user with that ID already exists.\")\n except exceptions.CosmosHttpResponseError\
\ as failure:\n print(\"Failed to create user. Status code:{}\".format(failure.status_code))\n\
@@ -346,12 +348,12 @@ methods:
examples:
- "Get an existing container, handling a failure if encountered:<!--[!code-python[Main](les\\\
examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n database =\
- \ client.get_database_client(database_name)\n container = database.get_container_client(container_name)\n\
- \n ````\n"
+ : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n database = client.get_database_client(database_name)\n\
+ \ container = database.get_container_client(container_name)\n\n ````\n"
- uid: azure.cosmos.DatabaseProxy.get_throughput
name: get_throughput
summary: "Get the ThroughputProperties object for this database.\nIf no ThroughputProperties\
@@ -406,12 +408,13 @@ methods:
examples:
- "List all containers in the database:<!--[!code-python[Main](les\\examples.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n database =\
- \ client.get_database_client(database_name)\n for container in database.list_containers():\n\
- \ print(\"Container ID: {}\".format(container['id']))\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n database = client.get_database_client(database_name)\n\
+ \ for container in database.list_containers():\n print(\"Container ID:\
+ \ {}\".format(container['id']))\n\n ````\n"
- uid: azure.cosmos.DatabaseProxy.list_users
name: list_users
summary: List all the users in the container.
@@ -604,15 +607,16 @@ methods:
examples:
- "Reset the TTL property on a container, and display the updated properties:<!--[!code-python[Main](les\\\
examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # Set the\
- \ TTL on the container to 3600 seconds (one hour)\n database.replace_container(container,\
- \ partition_key=PartitionKey(path='/productName'), default_ttl=3600)\n\n # Display\
- \ the new TTL setting for the container\n container_props = database.get_container_client(container_name).read()\n\
- \ print(\"New container TTL: {}\".format(json.dumps(container_props['defaultTtl'])))\n\
- \n ````\n"
+ : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n # Set the TTL on the container\
+ \ to 3600 seconds (one hour)\n database.replace_container(container, partition_key=PartitionKey(path='/productName'),\
+ \ default_ttl=3600)\n\n # Display the new TTL setting for the container\n \
+ \ container_props = database.get_container_client(container_name).read()\n print(\"\
+ New container TTL: {}\".format(json.dumps(container_props['defaultTtl'])))\n\n\
+ \ ````\n"
- uid: azure.cosmos.DatabaseProxy.replace_throughput
name: replace_throughput
summary: Replace the database-level throughput.
diff --git a/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.ContainerProxy.yml b/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.ContainerProxy.yml
index dfcfe3ec2edf..aef8d09131ba 100644
--- a/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.ContainerProxy.yml
+++ b/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.ContainerProxy.yml
@@ -443,25 +443,27 @@ methods:
examples:
- "Get all products that have not been discontinued:<!--[!code-python[Main](les\\\
examples_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"\
- names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\
- \\1\\\\s\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n import json\n\n async for item in container.query_items(\n\
- \ query='SELECT * FROM products p WHERE p.productModel <> \"\
- DISCONTINUED\"',\n enable_cross_partition_query=True,\n \
- \ ):\n print(json.dumps(item, indent=True))\n\n ````\n\n\
- Parameterized query to get all products that have been discontinued:<!--[!code-python[Main](les\\\
+ names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples_async.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import\
+ \ json\n\n async for item in container.query_items(\n \
+ \ query='SELECT * FROM products p WHERE p.productModel <> \"DISCONTINUED\"\
+ ',\n enable_cross_partition_query=True,\n ):\n \
+ \ print(json.dumps(item, indent=True))\n\n ````\n\nParameterized\
+ \ query to get all products that have been discontinued:<!--[!code-python[Main](les\\\
examples_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"\
- names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\
- \\1\\\\s\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n discontinued_items = container.query_items(\n query='SELECT\
- \ * FROM products p WHERE p.productModel = @model AND p.productName=\"Widget\"\
- ',\n parameters=[dict(name=\"@model\", value=\"DISCONTINUED\")],\n\
- \ )\n async for item in discontinued_items:\n \
- \ print(json.dumps(item, indent=True))\n\n ````\n"
+ names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples_async.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n discontinued_items\
+ \ = container.query_items(\n query='SELECT * FROM products p WHERE\
+ \ p.productModel = @model AND p.productName=\"Widget\"',\n parameters=[dict(name=\"\
+ @model\", value=\"DISCONTINUED\")],\n )\n async for item in\
+ \ discontinued_items:\n print(json.dumps(item, indent=True))\n\n\
+ \ ````\n"
- uid: azure.cosmos.aio.ContainerProxy.query_items_change_feed
name: query_items_change_feed
summary: Get a sorted list of items that were changed, in the order in which they
@@ -628,13 +630,14 @@ methods:
examples:
- "Get an item from the database and update one of its properties:<!--[!code-python[Main](les\\\
examples_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"\
- names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\
- \\1\\\\s\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n item = await container.read_item(\"item2\", partition_key=\"Widget\"\
- )\n item[\"productModel\"] = \"DISCONTINUED\"\n updated_item\
- \ = await container.upsert_item(item)\n\n ````\n"
+ names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples_async.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n item\
+ \ = await container.read_item(\"item2\", partition_key=\"Widget\")\n \
+ \ item[\"productModel\"] = \"DISCONTINUED\"\n updated_item = await\
+ \ container.upsert_item(item)\n\n ````\n"
- uid: azure.cosmos.aio.ContainerProxy.replace_item
name: replace_item
summary: 'Replaces the specified item if it exists in the container.
diff --git a/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.CosmosClient.yml b/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.CosmosClient.yml
index 315f91c7b3b6..02832711397f 100644
--- a/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.CosmosClient.yml
+++ b/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.CosmosClient.yml
@@ -122,11 +122,12 @@ constructor:
examples:
- "Create a new instance of the Cosmos DB client:<!--[!code-python[Main](les\\examples_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n async with CosmosClient(url,\
- \ key) as client:\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\
+ \\samples\\\\examples_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n async with CosmosClient(url, key) as client:\n\
+ \n ````\n"
methods:
- uid: azure.cosmos.aio.CosmosClient.close
name: close
@@ -181,10 +182,11 @@ methods:
examples:
- "Create a database in the Cosmos DB account:<!--[!code-python[Main](les\\examples_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples_async.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n database_name\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples_async.py\", \"xml:space\": \"\
+ preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
+ linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n database_name\
\ = \"testDatabase\"\n try:\n database = await client.create_database(id=database_name)\n\
\ except exceptions.CosmosResourceExistsError:\n database\
\ = client.get_database_client(database=database_name)\n\n ````\n"
diff --git a/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.DatabaseProxy.yml b/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.DatabaseProxy.yml
index fb723457b17e..67b5015be61d 100644
--- a/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.DatabaseProxy.yml
+++ b/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.aio.DatabaseProxy.yml
@@ -126,10 +126,11 @@ methods:
examples:
- "Create a container with default settings:<!--[!code-python[Main](les\\examples_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples_async.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n container_name\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples_async.py\", \"xml:space\": \"\
+ preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
+ linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n container_name\
\ = \"products\"\n try:\n container = await database.create_container(\n\
\ id=container_name, partition_key=PartitionKey(path=\"/productName\"\
)\n )\n except exceptions.CosmosResourceExistsError:\n\
@@ -137,7 +138,8 @@ methods:
\ ````\n\nCreate a container with specific settings; in this case, a custom\
\ partition key:<!--[!code-python[Main](les\\examples_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\
\\samples\\\\examples_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
\ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
: false} -->\n\n````python\n\n customer_container_name = \"customers\"\
@@ -267,15 +269,16 @@ methods:
examples:
- "Create a database user:<!--[!code-python[Main](les\\examples_async.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n try:\n\
- \ await database.create_user(dict(id=\"Walter Harp\"))\n \
- \ print(\"Created user Walter Harp.\")\n except exceptions.CosmosResourceExistsError:\n\
- \ print(\"A user with that ID already exists.\")\n except\
- \ exceptions.CosmosHttpResponseError as failure:\n print(\"Failed\
- \ to create user. Status code:{}\".format(failure.status_code))\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\
+ \\samples\\\\examples_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n try:\n await database.create_user(dict(id=\"\
+ Walter Harp\"))\n print(\"Created user Walter Harp.\")\n \
+ \ except exceptions.CosmosResourceExistsError:\n print(\"A user\
+ \ with that ID already exists.\")\n except exceptions.CosmosHttpResponseError\
+ \ as failure:\n print(\"Failed to create user. Status code:{}\"\
+ .format(failure.status_code))\n\n ````\n"
- uid: azure.cosmos.aio.DatabaseProxy.delete_container
name: delete_container
summary: Delete a container.
@@ -373,12 +376,13 @@ methods:
examples:
- "Get an existing container, handling a failure if encountered:<!--[!code-python[Main](les\\\
examples_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"\
- names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\
- \\1\\\\s\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n database = client.get_database_client(database_name)\n \
- \ container = database.get_container_client(container_name)\n\n ````\n"
+ names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples_async.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n database\
+ \ = client.get_database_client(database_name)\n container = database.get_container_client(container_name)\n\
+ \n ````\n"
- uid: azure.cosmos.aio.DatabaseProxy.get_throughput
name: get_throughput
summary: 'Get the ThroughputProperties object for this database.
@@ -447,10 +451,11 @@ methods:
examples:
- "List all containers in the database:<!--[!code-python[Main](les\\examples_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples_async.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n database\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples_async.py\", \"xml:space\": \"\
+ preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
+ linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n database\
\ = client.get_database_client(database_name)\n async for container\
\ in database.list_containers():\n print(\"Container ID: {}\".format(container['id']))\n\
\n ````\n"
@@ -651,16 +656,17 @@ methods:
examples:
- "Reset the TTL property on a container, and display the updated properties:<!--[!code-python[Main](les\\\
examples_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"\
- names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\
- \\1\\\\s\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # Set the TTL on the container to 3600 seconds (one hour)\n \
- \ await database.replace_container(container, partition_key=PartitionKey(path='/productName'),\
- \ default_ttl=3600)\n\n # Display the new TTL setting for the container\n\
- \ container_props = await database.get_container_client(container_name).read()\n\
- \ print(\"New container TTL: {}\".format(json.dumps(container_props['defaultTtl'])))\n\
- \n ````\n"
+ names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples_async.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n #\
+ \ Set the TTL on the container to 3600 seconds (one hour)\n await database.replace_container(container,\
+ \ partition_key=PartitionKey(path='/productName'), default_ttl=3600)\n\n \
+ \ # Display the new TTL setting for the container\n container_props\
+ \ = await database.get_container_client(container_name).read()\n print(\"\
+ New container TTL: {}\".format(json.dumps(container_props['defaultTtl'])))\n\n\
+ \ ````\n"
- uid: azure.cosmos.aio.DatabaseProxy.replace_throughput
name: replace_throughput
summary: 'Replace the database-level throughput.
diff --git a/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.container.ContainerProxy.yml b/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.container.ContainerProxy.yml
index 4f1523ddf0fc..793655f1d376 100644
--- a/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.container.ContainerProxy.yml
+++ b/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.container.ContainerProxy.yml
@@ -409,23 +409,25 @@ methods:
examples:
- "Get all products that have not been discontinued:<!--[!code-python[Main](les\\\
examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import json\n\
- \n for item in container.query_items(\n query='SELECT * FROM products\
- \ p WHERE p.productModel <> \"DISCONTINUED\"',\n enable_cross_partition_query=True,\n\
- \ ):\n print(json.dumps(item, indent=True))\n\n ````\n\nParameterized\
- \ query to get all products that have been discontinued:<!--[!code-python[Main](les\\\
- examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n discontinued_items\
- \ = container.query_items(\n query='SELECT * FROM products p WHERE p.productModel\
- \ = @model AND p.productName=\"Widget\"',\n parameters=[dict(name=\"@model\"\
- , value=\"DISCONTINUED\")],\n )\n for item in discontinued_items:\n \
- \ print(json.dumps(item, indent=True))\n\n ````\n"
+ : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n import json\n\n for item in\
+ \ container.query_items(\n query='SELECT * FROM products p WHERE p.productModel\
+ \ <> \"DISCONTINUED\"',\n enable_cross_partition_query=True,\n ):\n \
+ \ print(json.dumps(item, indent=True))\n\n ````\n\nParameterized query to\
+ \ get all products that have been discontinued:<!--[!code-python[Main](les\\examples.py\
+ \ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n discontinued_items = container.query_items(\n\
+ \ query='SELECT * FROM products p WHERE p.productModel = @model AND p.productName=\"\
+ Widget\"',\n parameters=[dict(name=\"@model\", value=\"DISCONTINUED\")],\n\
+ \ )\n for item in discontinued_items:\n print(json.dumps(item, indent=True))\n\
+ \n ````\n"
- uid: azure.cosmos.container.ContainerProxy.query_items_change_feed
name: query_items_change_feed
summary: Get a sorted list of items that were changed, in the order in which they
@@ -582,10 +584,11 @@ methods:
examples:
- "Get an item from the database and update one of its properties:<!--[!code-python[Main](les\\\
examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n item = container.read_item(\"\
+ : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n item = container.read_item(\"\
item2\", partition_key=\"Widget\")\n item[\"productModel\"] = \"DISCONTINUED\"\
\n updated_item = container.upsert_item(item)\n\n ````\n"
- uid: azure.cosmos.container.ContainerProxy.read_offer
diff --git a/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.cosmos_client.CosmosClient.yml b/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.cosmos_client.CosmosClient.yml
index 3451ef7a0d18..6638ebb2e30a 100644
--- a/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.cosmos_client.CosmosClient.yml
+++ b/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.cosmos_client.CosmosClient.yml
@@ -123,13 +123,13 @@ constructor:
examples:
- "Create a new instance of the Cosmos DB client:<!--[!code-python[Main](les\\examples.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.cosmos import exceptions,\
- \ CosmosClient, PartitionKey\n\n import os\n\n url = os.environ[\"ACCOUNT_URI\"\
- ]\n key = os.environ[\"ACCOUNT_KEY\"]\n client = CosmosClient(url, key)\n\n\
- \ ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\
+ \\samples\\\\examples.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
+ : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
+ \n````python\n\n from azure.cosmos import exceptions, CosmosClient, PartitionKey\n\
+ \n import os\n\n url = os.environ[\"ACCOUNT_URI\"]\n key = os.environ[\"ACCOUNT_KEY\"\
+ ]\n client = CosmosClient(url, key)\n\n ````\n"
methods:
- uid: azure.cosmos.cosmos_client.CosmosClient.create_database
name: create_database
@@ -178,12 +178,13 @@ methods:
examples:
- "Create a database in the Cosmos DB account:<!--[!code-python[Main](les\\examples.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n database_name\
- \ = \"testDatabase\"\n try:\n database = client.create_database(id=database_name)\n\
- \ except exceptions.CosmosResourceExistsError:\n database = client.get_database_client(database=database_name)\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n database_name = \"testDatabase\"\
+ \n try:\n database = client.create_database(id=database_name)\n except\
+ \ exceptions.CosmosResourceExistsError:\n database = client.get_database_client(database=database_name)\n\
\n ````\n"
- uid: azure.cosmos.cosmos_client.CosmosClient.create_database_if_not_exists
name: create_database_if_not_exists
diff --git a/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.database.DatabaseProxy.yml b/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.database.DatabaseProxy.yml
index 29530d75843b..e465862baf0f 100644
--- a/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.database.DatabaseProxy.yml
+++ b/preview/docs-ref-autogen/azure-cosmos/azure.cosmos.database.DatabaseProxy.yml
@@ -120,25 +120,26 @@ methods:
examples:
- "Create a container with default settings:<!--[!code-python[Main](les\\examples.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n container_name\
- \ = \"products\"\n try:\n container = database.create_container(\n \
- \ id=container_name, partition_key=PartitionKey(path=\"/productName\")\n\
- \ )\n except exceptions.CosmosResourceExistsError:\n container =\
- \ database.get_container_client(container_name)\n\n ````\n\nCreate a container\
- \ with specific settings; in this case, a custom partition key:<!--[!code-python[Main](les\\\
- examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n customer_container_name\
- \ = \"customers\"\n try:\n customer_container = database.create_container(\n\
- \ id=customer_container_name,\n partition_key=PartitionKey(path=\"\
- /city\"),\n default_ttl=200,\n )\n except exceptions.CosmosResourceExistsError:\n\
- \ customer_container = database.get_container_client(customer_container_name)\n\
- \n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n container_name = \"products\"\
+ \n try:\n container = database.create_container(\n id=container_name,\
+ \ partition_key=PartitionKey(path=\"/productName\")\n )\n except exceptions.CosmosResourceExistsError:\n\
+ \ container = database.get_container_client(container_name)\n\n ````\n\
+ \nCreate a container with specific settings; in this case, a custom partition\
+ \ key:<!--[!code-python[Main](les\\examples.py )]-->\n\n<!-- literal_block {\"\
+ ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\\
+ samples\\\\examples.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
+ : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
+ \n````python\n\n customer_container_name = \"customers\"\n try:\n customer_container\
+ \ = database.create_container(\n id=customer_container_name,\n \
+ \ partition_key=PartitionKey(path=\"/city\"),\n default_ttl=200,\n\
+ \ )\n except exceptions.CosmosResourceExistsError:\n customer_container\
+ \ = database.get_container_client(customer_container_name)\n\n ````\n"
- uid: azure.cosmos.database.DatabaseProxy.create_container_if_not_exists
name: create_container_if_not_exists
summary: 'Create a container if it does not exist already.
@@ -252,10 +253,11 @@ methods:
examples:
- "Create a database user:<!--[!code-python[Main](les\\examples.py )]-->\n\n<!--\
\ literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [],\
- \ \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n try:\n database.create_user(dict(id=\"\
+ \ \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\
+ \\samples\\\\examples.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n try:\n database.create_user(dict(id=\"\
Walter Harp\"))\n except exceptions.CosmosResourceExistsError:\n print(\"\
A user with that ID already exists.\")\n except exceptions.CosmosHttpResponseError\
\ as failure:\n print(\"Failed to create user. Status code:{}\".format(failure.status_code))\n\
@@ -346,12 +348,12 @@ methods:
examples:
- "Get an existing container, handling a failure if encountered:<!--[!code-python[Main](les\\\
examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n database =\
- \ client.get_database_client(database_name)\n container = database.get_container_client(container_name)\n\
- \n ````\n"
+ : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n database = client.get_database_client(database_name)\n\
+ \ container = database.get_container_client(container_name)\n\n ````\n"
- uid: azure.cosmos.database.DatabaseProxy.get_throughput
name: get_throughput
summary: "Get the ThroughputProperties object for this database.\nIf no ThroughputProperties\
@@ -406,12 +408,13 @@ methods:
examples:
- "List all containers in the database:<!--[!code-python[Main](les\\examples.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n database =\
- \ client.get_database_client(database_name)\n for container in database.list_containers():\n\
- \ print(\"Container ID: {}\".format(container['id']))\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n database = client.get_database_client(database_name)\n\
+ \ for container in database.list_containers():\n print(\"Container ID:\
+ \ {}\".format(container['id']))\n\n ````\n"
- uid: azure.cosmos.database.DatabaseProxy.list_users
name: list_users
summary: List all the users in the container.
@@ -605,15 +608,16 @@ methods:
examples:
- "Reset the TTL property on a container, and display the updated properties:<!--[!code-python[Main](les\\\
examples.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
- : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\
- \\s\\\\dist_temp\\\\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # Set the\
- \ TTL on the container to 3600 seconds (one hour)\n database.replace_container(container,\
- \ partition_key=PartitionKey(path='/productName'), default_ttl=3600)\n\n # Display\
- \ the new TTL setting for the container\n container_props = database.get_container_client(container_name).read()\n\
- \ print(\"New container TTL: {}\".format(json.dumps(container_props['defaultTtl'])))\n\
- \n ````\n"
+ : [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\36\\\\azure-cosmos-4.4.1b1\\\\samples\\\\examples.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n # Set the TTL on the container\
+ \ to 3600 seconds (one hour)\n database.replace_container(container, partition_key=PartitionKey(path='/productName'),\
+ \ default_ttl=3600)\n\n # Display the new TTL setting for the container\n \
+ \ container_props = database.get_container_client(container_name).read()\n print(\"\
+ New container TTL: {}\".format(json.dumps(container_props['defaultTtl'])))\n\n\
+ \ ````\n"
- uid: azure.cosmos.database.DatabaseProxy.replace_throughput
name: replace_throughput
summary: Replace the database-level throughput.
diff --git a/preview/docs-ref-autogen/azure-eventgrid/azure.eventgrid.EventGridPublisherClient.yml b/preview/docs-ref-autogen/azure-eventgrid/azure.eventgrid.EventGridPublisherClient.yml
index d71fe759d51b..53ec826d694f 100644
--- a/preview/docs-ref-autogen/azure-eventgrid/azure.eventgrid.EventGridPublisherClient.yml
+++ b/preview/docs-ref-autogen/azure-eventgrid/azure.eventgrid.EventGridPublisherClient.yml
@@ -30,19 +30,20 @@ examples:
- "Creating the EventGridPublisherClient with an endpoint and AzureKeyCredential.<!--[!code-python[Main](les\\\
sync_samples\\sample_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\41\\\\azure-eventgrid-4.12.0b1\\\\\
- samples\\\\sync_samples\\\\sample_authentication.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.eventgrid\
- \ import EventGridPublisherClient\n from azure.core.credentials import AzureKeyCredential\n\
- \n topic_key = os.environ[\"EVENTGRID_TOPIC_KEY\"]\n endpoint = os.environ[\"\
- EVENTGRID_TOPIC_ENDPOINT\"]\n\n credential = AzureKeyCredential(topic_key)\n \
- \ client = EventGridPublisherClient(endpoint, credential)\n\n ````\n\nCreating\
- \ the EventGridPublisherClient with an endpoint and AzureSasCredential.<!--[!code-python[Main](les\\\
- sync_samples\\sample_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [],\
- \ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\41\\\\azure-eventgrid-4.12.0b1\\\\\
- samples\\\\sync_samples\\\\sample_authentication.py\", \"xml:space\": \"preserve\"\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\41\\\\azure-eventgrid-4.12.0b1\\\\samples\\\\sync_samples\\\
+ \\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false}\
+ \ -->\n\n````python\n\n import os\n from azure.eventgrid import EventGridPublisherClient\n\
+ \ from azure.core.credentials import AzureKeyCredential\n\n topic_key = os.environ[\"\
+ EVENTGRID_TOPIC_KEY\"]\n endpoint = os.environ[\"EVENTGRID_TOPIC_ENDPOINT\"]\n\
+ \n credential = AzureKeyCredential(topic_key)\n client = EventGridPublisherClient(endpoint,\
+ \ credential)\n\n ````\n\nCreating the EventGridPublisherClient with an endpoint\
+ \ and AzureSasCredential.<!--[!code-python[Main](les\\sync_samples\\sample_authentication.py\
+ \ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\41\\\\azure-eventgrid-4.12.0b1\\\
+ \\samples\\\\sync_samples\\\\sample_authentication.py\", \"xml:space\": \"preserve\"\
, \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
: 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.eventgrid\
\ import EventGridPublisherClient\n from azure.core.credentials import AzureSasCredential\n\
@@ -116,11 +117,12 @@ methods:
- "Publishing a Custom Schema event.<!--[!code-python[Main](les\\sync_samples\\\
sample_publish_custom_schema_to_a_topic.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\41\\\\azure-eventgrid-4.12.0b1\\\
- \\samples\\\\sync_samples\\\\sample_publish_custom_schema_to_a_topic.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n custom_schema_event\
- \ = {\n \"customSubject\": \"sample\",\n \"customEventType\": \"sample.event\"\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\41\\\\azure-eventgrid-4.12.0b1\\\\samples\\\\sync_samples\\\
+ \\sample_publish_custom_schema_to_a_topic.py\", \"xml:space\": \"preserve\", \"\
+ force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n custom_schema_event = {\n \
+ \ \"customSubject\": \"sample\",\n \"customEventType\": \"sample.event\"\
,\n \"customDataVersion\": \"2.0\",\n \"customId\": uuid.uuid4(),\n\
\ \"customEventTime\": dt.datetime.now(UTC()).isoformat(),\n \"customData\"\
: \"sample data\",\n }\n\n client.send(custom_schema_event)\n\n ````\n"
diff --git a/preview/docs-ref-autogen/azure-eventgrid/azure.eventgrid.aio.EventGridPublisherClient.yml b/preview/docs-ref-autogen/azure-eventgrid/azure.eventgrid.aio.EventGridPublisherClient.yml
index c16d41e71bcc..9d2cbb20004c 100644
--- a/preview/docs-ref-autogen/azure-eventgrid/azure.eventgrid.aio.EventGridPublisherClient.yml
+++ b/preview/docs-ref-autogen/azure-eventgrid/azure.eventgrid.aio.EventGridPublisherClient.yml
@@ -31,19 +31,20 @@ examples:
- "Creating the EventGridPublisherClient with an endpoint and AzureKeyCredential.<!--[!code-python[Main](les\\\
async_samples\\sample_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\41\\\\azure-eventgrid-4.12.0b1\\\\\
- samples\\\\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from\
- \ azure.eventgrid.aio import EventGridPublisherClient\n from azure.core.credentials\
- \ import AzureKeyCredential\n\n topic_key = os.environ[\"EVENTGRID_TOPIC_KEY\"\
- ]\n endpoint = os.environ[\"EVENTGRID_TOPIC_ENDPOINT\"]\n\n credential = AzureKeyCredential(topic_key)\n\
- \ client = EventGridPublisherClient(endpoint, credential)\n\n ````\n\nCreating\
- \ the EventGridPublisherClient with an endpoint and AzureSasCredential.<!--[!code-python[Main](les\\\
- async_samples\\sample_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\"\
- : [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\41\\\\azure-eventgrid-4.12.0b1\\\\\
- samples\\\\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\41\\\\azure-eventgrid-4.12.0b1\\\\samples\\\\async_samples\\\
+ \\sample_authentication_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.eventgrid.aio import EventGridPublisherClient\n\
+ \ from azure.core.credentials import AzureKeyCredential\n\n topic_key = os.environ[\"\
+ EVENTGRID_TOPIC_KEY\"]\n endpoint = os.environ[\"EVENTGRID_TOPIC_ENDPOINT\"]\n\
+ \n credential = AzureKeyCredential(topic_key)\n client = EventGridPublisherClient(endpoint,\
+ \ credential)\n\n ````\n\nCreating the EventGridPublisherClient with an endpoint\
+ \ and AzureSasCredential.<!--[!code-python[Main](les\\async_samples\\sample_authentication_async.py\
+ \ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\41\\\\azure-eventgrid-4.12.0b1\\\
+ \\samples\\\\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"\
preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from\
\ azure.eventgrid.aio import EventGridPublisherClient\n from azure.core.credentials\
@@ -117,7 +118,8 @@ methods:
- "Publishing a Custom Schema event.<!--[!code-python[Main](les\\async_samples\\\
sample_publish_custom_schema_to_a_topic_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\41\\\\azure-eventgrid-4.12.0b1\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\41\\\\azure-eventgrid-4.12.0b1\\\
\\samples\\\\async_samples\\\\sample_publish_custom_schema_to_a_topic_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
diff --git a/preview/docs-ref-autogen/azure-eventgrid/azure.eventgrid.yml b/preview/docs-ref-autogen/azure-eventgrid/azure.eventgrid.yml
index 1d130c8a9f6d..407f897f5b2c 100644
--- a/preview/docs-ref-autogen/azure-eventgrid/azure.eventgrid.yml
+++ b/preview/docs-ref-autogen/azure-eventgrid/azure.eventgrid.yml
@@ -35,16 +35,17 @@ functions:
examples:
- "Generate a shared access signature.<!--[!code-python[Main](les\\sync_samples\\\
sample_generate_sas.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\":\
- \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\41\\\\azure-eventgrid-4.12.0b1\\\\samples\\\
- \\sync_samples\\\\sample_generate_sas.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n import os\n from azure.eventgrid import\
- \ generate_sas\n from datetime import datetime, timedelta\n\n topic_key =\
- \ os.environ[\"EVENTGRID_TOPIC_KEY\"]\n endpoint = os.environ[\"EVENTGRID_TOPIC_ENDPOINT\"\
- ]\n\n # represents the expiration date for sas\n expiration_date_utc = datetime.utcnow()\
- \ + timedelta(hours=10)\n\n signature = generate_sas(endpoint, topic_key, expiration_date_utc)\n\
- \n\n ````\n"
+ \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\41\\\\azure-eventgrid-4.12.0b1\\\\samples\\\\sync_samples\\\
+ \\sample_generate_sas.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.eventgrid import generate_sas\n\
+ \ from datetime import datetime, timedelta\n\n topic_key = os.environ[\"EVENTGRID_TOPIC_KEY\"\
+ ]\n endpoint = os.environ[\"EVENTGRID_TOPIC_ENDPOINT\"]\n\n # represents the\
+ \ expiration date for sas\n expiration_date_utc = datetime.utcnow() + timedelta(hours=10)\n\
+ \n signature = generate_sas(endpoint, topic_key, expiration_date_utc)\n\n\n\
+ \ ````\n"
classes:
- azure.eventgrid.EventGridClient
- azure.eventgrid.EventGridEvent
diff --git a/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.EventData.yml b/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.EventData.yml
index de63ceb8b494..7f8cfa1db47f 100644
--- a/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.EventData.yml
+++ b/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.EventData.yml
@@ -19,11 +19,12 @@ constructor:
examples:
- "Create instances of EventData<!--[!code-python[Main](les\\sync_samples\\sample_code_eventhub.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\sync_samples\\\\sample_code_eventhub.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.eventhub\
- \ import EventData\n\n event_data = EventData(\"String data\")\n event_data\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\
+ \\samples\\\\sync_samples\\\\sample_code_eventhub.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.eventhub import\
+ \ EventData\n\n event_data = EventData(\"String data\")\n event_data\
\ = EventData(b\"Bytes data\")\n\n\n ````\n"
methods:
- uid: azure.eventhub.EventData.body_as_json
diff --git a/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.EventHubConsumerClient.yml b/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.EventHubConsumerClient.yml
index 29fe5273b012..49b4bec45f08 100644
--- a/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.EventHubConsumerClient.yml
+++ b/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.EventHubConsumerClient.yml
@@ -269,14 +269,14 @@ examples:
- "Create a new instance of the EventHubConsumerClient.<!--[!code-python[Main](les\\\
sync_samples\\sample_code_eventhub.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\\
- samples\\\\sync_samples\\\\sample_code_eventhub.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.eventhub\
- \ import EventHubConsumerClient, EventHubSharedKeyCredential\n\n fully_qualified_namespace\
- \ = os.environ['EVENT_HUB_HOSTNAME']\n eventhub_name = os.environ['EVENT_HUB_NAME']\n\
- \ shared_access_policy = os.environ['EVENT_HUB_SAS_POLICY']\n shared_access_key\
- \ = os.environ['EVENT_HUB_SAS_KEY']\n\n credential = EventHubSharedKeyCredential(shared_access_policy,\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\sync_samples\\\
+ \\sample_code_eventhub.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
+ : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
+ \n````python\n\n import os\n from azure.eventhub import EventHubConsumerClient,\
+ \ EventHubSharedKeyCredential\n\n fully_qualified_namespace = os.environ['EVENT_HUB_HOSTNAME']\n\
+ \ eventhub_name = os.environ['EVENT_HUB_NAME']\n shared_access_policy = os.environ['EVENT_HUB_SAS_POLICY']\n\
+ \ shared_access_key = os.environ['EVENT_HUB_SAS_KEY']\n\n credential = EventHubSharedKeyCredential(shared_access_policy,\
\ shared_access_key)\n consumer = EventHubConsumerClient(\n fully_qualified_namespace=fully_qualified_namespace,\n\
\ eventhub_name=eventhub_name,\n consumer_group='$Default',\n \
\ credential=credential)\n\n ````\n"
@@ -292,8 +292,9 @@ methods:
examples:
- "Close down the client.<!--[!code-python[Main](les\\sync_samples\\sample_code_eventhub.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\sync_samples\\\\sample_code_eventhub.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\sync_samples\\\\sample_code_eventhub.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n import os\n import threading\n\n event_hub_connection_str = os.environ['EVENT_HUB_CONN_STR']\n\
@@ -523,12 +524,13 @@ methods:
- "Create a new instance of the EventHubConsumerClient from connection string.<!--[!code-python[Main](les\\\
sync_samples\\sample_code_eventhub.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\\
- samples\\\\sync_samples\\\\sample_code_eventhub.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.eventhub\
- \ import EventHubConsumerClient\n event_hub_connection_str = os.environ['EVENT_HUB_CONN_STR']\n\
- \ eventhub_name = os.environ['EVENT_HUB_NAME']\n consumer = EventHubConsumerClient.from_connection_string(\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\sync_samples\\\
+ \\sample_code_eventhub.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.eventhub import EventHubConsumerClient\n\
+ \ event_hub_connection_str = os.environ['EVENT_HUB_CONN_STR']\n eventhub_name\
+ \ = os.environ['EVENT_HUB_NAME']\n consumer = EventHubConsumerClient.from_connection_string(\n\
\ conn_str=event_hub_connection_str,\n consumer_group='$Default',\n\
\ eventhub_name=eventhub_name # EventHub name should be specified if it\
\ doesn't show up in connection string.\n )\n\n ````\n"
@@ -740,11 +742,12 @@ methods:
examples:
- "Receive events from the EventHub.<!--[!code-python[Main](les\\sync_samples\\\
sample_code_eventhub.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\
- \\sync_samples\\\\sample_code_eventhub.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n logger = logging.getLogger(\"azure.eventhub\"\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\sync_samples\\\
+ \\sample_code_eventhub.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n logger = logging.getLogger(\"azure.eventhub\"\
)\n\n def on_event(partition_context, event):\n # Put your code\
\ here.\n # If the operation is i/o intensive, multi-thread will have\
\ better performance.\n logger.info(\"Received event from partition:\
@@ -933,11 +936,12 @@ methods:
examples:
- "Receive events in batches from the EventHub.<!--[!code-python[Main](les\\sync_samples\\\
sample_code_eventhub.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\
- \\sync_samples\\\\sample_code_eventhub.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n logger = logging.getLogger(\"azure.eventhub\"\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\sync_samples\\\
+ \\sample_code_eventhub.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n logger = logging.getLogger(\"azure.eventhub\"\
)\n\n def on_event_batch(partition_context, event_batch):\n #\
\ Put your code here.\n # If the operation is i/o intensive, multi-thread\
\ will have better performance.\n logger.info(\"Received events from\
diff --git a/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.EventHubProducerClient.yml b/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.EventHubProducerClient.yml
index 457ab724bea6..bdeb5fb46341 100644
--- a/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.EventHubProducerClient.yml
+++ b/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.EventHubProducerClient.yml
@@ -220,14 +220,14 @@ examples:
- "Create a new instance of the EventHubProducerClient.<!--[!code-python[Main](les\\\
sync_samples\\sample_code_eventhub.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\\
- samples\\\\sync_samples\\\\sample_code_eventhub.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.eventhub\
- \ import EventHubProducerClient, EventHubSharedKeyCredential\n\n fully_qualified_namespace\
- \ = os.environ['EVENT_HUB_HOSTNAME']\n eventhub_name = os.environ['EVENT_HUB_NAME']\n\
- \ shared_access_policy = os.environ['EVENT_HUB_SAS_POLICY']\n shared_access_key\
- \ = os.environ['EVENT_HUB_SAS_KEY']\n\n credential = EventHubSharedKeyCredential(shared_access_policy,\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\sync_samples\\\
+ \\sample_code_eventhub.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
+ : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
+ \n````python\n\n import os\n from azure.eventhub import EventHubProducerClient,\
+ \ EventHubSharedKeyCredential\n\n fully_qualified_namespace = os.environ['EVENT_HUB_HOSTNAME']\n\
+ \ eventhub_name = os.environ['EVENT_HUB_NAME']\n shared_access_policy = os.environ['EVENT_HUB_SAS_POLICY']\n\
+ \ shared_access_key = os.environ['EVENT_HUB_SAS_KEY']\n\n credential = EventHubSharedKeyCredential(shared_access_policy,\
\ shared_access_key)\n producer = EventHubProducerClient(\n fully_qualified_namespace=fully_qualified_namespace,\n\
\ eventhub_name=eventhub_name, # EventHub name should be specified if it\
\ doesn't show up in connection string.\n credential=credential\n )\n\n\
@@ -263,8 +263,9 @@ methods:
examples:
- "Close down the client.<!--[!code-python[Main](les\\sync_samples\\sample_code_eventhub.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\sync_samples\\\\sample_code_eventhub.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\sync_samples\\\\sample_code_eventhub.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n import os\n from azure.eventhub import EventHubProducerClient, EventData\n\
@@ -331,10 +332,11 @@ methods:
- "Create EventDataBatch object within limited size<!--[!code-python[Main](les\\\
sync_samples\\sample_code_eventhub.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\\
- samples\\\\sync_samples\\\\sample_code_eventhub.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n event_data_batch = producer.create_batch()\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\sync_samples\\\
+ \\sample_code_eventhub.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n event_data_batch = producer.create_batch()\n\
\ while True:\n try:\n event_data_batch.add(EventData('Message\
\ inside EventBatchData'))\n except ValueError:\n # The\
\ EventDataBatch object reaches its max_size.\n # You can send the\
@@ -560,12 +562,13 @@ methods:
- "Create a new instance of the EventHubProducerClient from connection string.<!--[!code-python[Main](les\\\
sync_samples\\sample_code_eventhub.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\\
- samples\\\\sync_samples\\\\sample_code_eventhub.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.eventhub\
- \ import EventHubProducerClient\n event_hub_connection_str = os.environ['EVENT_HUB_CONN_STR']\n\
- \ eventhub_name = os.environ['EVENT_HUB_NAME']\n producer = EventHubProducerClient.from_connection_string(\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\sync_samples\\\
+ \\sample_code_eventhub.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.eventhub import EventHubProducerClient\n\
+ \ event_hub_connection_str = os.environ['EVENT_HUB_CONN_STR']\n eventhub_name\
+ \ = os.environ['EVENT_HUB_NAME']\n producer = EventHubProducerClient.from_connection_string(\n\
\ conn_str=event_hub_connection_str,\n eventhub_name=eventhub_name\
\ # EventHub name should be specified if it doesn't show up in connection string.\n\
\ )\n\n ````\n"
@@ -735,8 +738,9 @@ methods:
examples:
- "Sends event data<!--[!code-python[Main](les\\sync_samples\\sample_code_eventhub.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\sync_samples\\\\sample_code_eventhub.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\sync_samples\\\\sample_code_eventhub.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n with producer:\n event_data_batch = producer.create_batch()\n\
diff --git a/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.aio.EventHubConsumerClient.yml b/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.aio.EventHubConsumerClient.yml
index ff3f4fa84e2a..ed6d69da77fc 100644
--- a/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.aio.EventHubConsumerClient.yml
+++ b/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.aio.EventHubConsumerClient.yml
@@ -269,14 +269,14 @@ examples:
- "Create a new instance of the EventHubConsumerClient.<!--[!code-python[Main](les\\\
async_samples\\sample_code_eventhub_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\\
- samples\\\\async_samples\\\\sample_code_eventhub_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.eventhub.aio\
- \ import EventHubConsumerClient, EventHubSharedKeyCredential\n\n fully_qualified_namespace\
- \ = os.environ['EVENT_HUB_HOSTNAME']\n eventhub_name = os.environ['EVENT_HUB_NAME']\n\
- \ shared_access_policy = os.environ['EVENT_HUB_SAS_POLICY']\n shared_access_key\
- \ = os.environ['EVENT_HUB_SAS_KEY']\n\n consumer = EventHubConsumerClient(fully_qualified_namespace=fully_qualified_namespace,\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\async_samples\\\
+ \\sample_code_eventhub_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.eventhub.aio import EventHubConsumerClient,\
+ \ EventHubSharedKeyCredential\n\n fully_qualified_namespace = os.environ['EVENT_HUB_HOSTNAME']\n\
+ \ eventhub_name = os.environ['EVENT_HUB_NAME']\n shared_access_policy = os.environ['EVENT_HUB_SAS_POLICY']\n\
+ \ shared_access_key = os.environ['EVENT_HUB_SAS_KEY']\n\n consumer = EventHubConsumerClient(fully_qualified_namespace=fully_qualified_namespace,\n\
\ consumer_group='$Default',\n \
\ eventhub_name=eventhub_name,\n \
\ credential=EventHubSharedKeyCredential(shared_access_policy, shared_access_key))\n\
@@ -293,8 +293,9 @@ methods:
examples:
- "Close down the client.<!--[!code-python[Main](les\\async_samples\\sample_code_eventhub_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\async_samples\\\\sample_code_eventhub_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\async_samples\\\\sample_code_eventhub_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n import os\n\n event_hub_connection_str = os.environ['EVENT_HUB_CONN_STR']\n\
@@ -527,16 +528,16 @@ methods:
- "Create a new instance of the EventHubConsumerClient from connection string.<!--[!code-python[Main](les\\\
async_samples\\sample_code_eventhub_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\\
- samples\\\\async_samples\\\\sample_code_eventhub_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from\
- \ azure.eventhub.aio import EventHubConsumerClient\n event_hub_connection_str\
- \ = os.environ['EVENT_HUB_CONN_STR']\n eventhub_name = os.environ['EVENT_HUB_NAME']\n\
- \ consumer = EventHubConsumerClient.from_connection_string(\n conn_str=event_hub_connection_str,\n\
- \ consumer_group='$Default',\n eventhub_name=eventhub_name # EventHub\
- \ name should be specified if it doesn't show up in connection string.\n )\n\
- \n ````\n"
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\async_samples\\\
+ \\sample_code_eventhub_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.eventhub.aio import\
+ \ EventHubConsumerClient\n event_hub_connection_str = os.environ['EVENT_HUB_CONN_STR']\n\
+ \ eventhub_name = os.environ['EVENT_HUB_NAME']\n consumer = EventHubConsumerClient.from_connection_string(\n\
+ \ conn_str=event_hub_connection_str,\n consumer_group='$Default',\n\
+ \ eventhub_name=eventhub_name # EventHub name should be specified if it\
+ \ doesn't show up in connection string.\n )\n\n ````\n"
- uid: azure.eventhub.aio.EventHubConsumerClient.get_eventhub_properties
name: get_eventhub_properties
summary: "Get properties of the Event Hub.\n\nKeys in the returned dictionary include:\n\
@@ -750,18 +751,19 @@ methods:
examples:
- "Receive events from the EventHub.<!--[!code-python[Main](les\\async_samples\\\
sample_code_eventhub_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\
- \\async_samples\\\\sample_code_eventhub_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n logger = logging.getLogger(\"\
- azure.eventhub\")\n\n async def on_event(partition_context, event):\n \
- \ # Put your code here.\n # If the operation is i/o intensive,\
- \ async will have better performance.\n logger.info(\"Received event\
- \ from partition: {}\".format(partition_context.partition_id))\n\n async\
- \ with consumer:\n await consumer.receive(\n on_event=on_event,\n\
- \ starting_position=\"-1\", # \"-1\" is from the beginning of the\
- \ partition.\n )\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\async_samples\\\
+ \\sample_code_eventhub_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n logger = logging.getLogger(\"azure.eventhub\"\
+ )\n\n async def on_event(partition_context, event):\n # Put your\
+ \ code here.\n # If the operation is i/o intensive, async will have\
+ \ better performance.\n logger.info(\"Received event from partition:\
+ \ {}\".format(partition_context.partition_id))\n\n async with consumer:\n\
+ \ await consumer.receive(\n on_event=on_event,\n \
+ \ starting_position=\"-1\", # \"-1\" is from the beginning of the partition.\n\
+ \ )\n\n ````\n"
- uid: azure.eventhub.aio.EventHubConsumerClient.receive_batch
name: receive_batch
summary: Receive events from partition(s) in batches, with optional load-balancing
@@ -954,15 +956,16 @@ methods:
examples:
- "Receive events in batches from the EventHub.<!--[!code-python[Main](les\\async_samples\\\
sample_code_eventhub_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\
- \\async_samples\\\\sample_code_eventhub_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n logger = logging.getLogger(\"\
- azure.eventhub\")\n\n async def on_event_batch(partition_context, event_batch):\n\
- \ # Put your code here.\n # If the operation is i/o intensive,\
- \ async will have better performance.\n logger.info(\n \
- \ \"{} events received from partition: {}\".format(len(event_batch), partition_context.partition_id)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\async_samples\\\
+ \\sample_code_eventhub_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n logger = logging.getLogger(\"azure.eventhub\"\
+ )\n\n async def on_event_batch(partition_context, event_batch):\n \
+ \ # Put your code here.\n # If the operation is i/o intensive, async\
+ \ will have better performance.\n logger.info(\n \"{}\
+ \ events received from partition: {}\".format(len(event_batch), partition_context.partition_id)\n\
\ )\n\n async with consumer:\n await consumer.receive_batch(\n\
\ on_event_batch=on_event_batch,\n starting_position=\"\
-1\", # \"-1\" is from the beginning of the partition.\n )\n\n ````\n"
diff --git a/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.aio.EventHubProducerClient.yml b/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.aio.EventHubProducerClient.yml
index 9017746e9f5c..8c0706d81964 100644
--- a/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.aio.EventHubProducerClient.yml
+++ b/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.aio.EventHubProducerClient.yml
@@ -212,14 +212,14 @@ examples:
- "Create a new instance of the EventHubProducerClient.<!--[!code-python[Main](les\\\
async_samples\\sample_code_eventhub_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\\
- samples\\\\async_samples\\\\sample_code_eventhub_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.eventhub.aio\
- \ import EventHubProducerClient, EventHubSharedKeyCredential\n\n fully_qualified_namespace\
- \ = os.environ['EVENT_HUB_HOSTNAME']\n eventhub_name = os.environ['EVENT_HUB_NAME']\n\
- \ shared_access_policy = os.environ['EVENT_HUB_SAS_POLICY']\n shared_access_key\
- \ = os.environ['EVENT_HUB_SAS_KEY']\n\n producer = EventHubProducerClient(fully_qualified_namespace=fully_qualified_namespace,\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\async_samples\\\
+ \\sample_code_eventhub_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.eventhub.aio import EventHubProducerClient,\
+ \ EventHubSharedKeyCredential\n\n fully_qualified_namespace = os.environ['EVENT_HUB_HOSTNAME']\n\
+ \ eventhub_name = os.environ['EVENT_HUB_NAME']\n shared_access_policy = os.environ['EVENT_HUB_SAS_POLICY']\n\
+ \ shared_access_key = os.environ['EVENT_HUB_SAS_KEY']\n\n producer = EventHubProducerClient(fully_qualified_namespace=fully_qualified_namespace,\n\
\ eventhub_name=eventhub_name,\n \
\ credential=EventHubSharedKeyCredential(shared_access_policy,\
\ shared_access_key))\n\n ````\n"
@@ -254,8 +254,9 @@ methods:
examples:
- "Close down the handler.<!--[!code-python[Main](les\\async_samples\\sample_code_eventhub_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\async_samples\\\\sample_code_eventhub_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\async_samples\\\\sample_code_eventhub_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n import os\n from azure.eventhub.aio import EventHubProducerClient\n from\
@@ -326,16 +327,16 @@ methods:
- "Create EventDataBatch object within limited size<!--[!code-python[Main](les\\\
async_samples\\sample_code_eventhub_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\\
- samples\\\\async_samples\\\\sample_code_eventhub_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.eventhub\
- \ import EventData\n event_data_batch = await producer.create_batch()\n\
- \ while True:\n try:\n event_data_batch.add(EventData('Message\
- \ inside EventBatchData'))\n except ValueError:\n # The\
- \ EventDataBatch object reaches its max_size.\n # You can send the\
- \ full EventDataBatch object and create a new one here.\n break\n\
- \n ````\n"
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\async_samples\\\
+ \\sample_code_eventhub_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.eventhub import EventData\n \
+ \ event_data_batch = await producer.create_batch()\n while True:\n \
+ \ try:\n event_data_batch.add(EventData('Message inside\
+ \ EventBatchData'))\n except ValueError:\n # The EventDataBatch\
+ \ object reaches its max_size.\n # You can send the full EventDataBatch\
+ \ object and create a new one here.\n break\n\n ````\n"
- uid: azure.eventhub.aio.EventHubProducerClient.flush
name: flush
summary: 'Buffered mode only.
@@ -543,15 +544,16 @@ methods:
- "Create a new instance of the EventHubProducerClient from connection string.<!--[!code-python[Main](les\\\
async_samples\\sample_code_eventhub_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\\
- samples\\\\async_samples\\\\sample_code_eventhub_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from\
- \ azure.eventhub.aio import EventHubProducerClient\n event_hub_connection_str\
- \ = os.environ['EVENT_HUB_CONN_STR']\n eventhub_name = os.environ['EVENT_HUB_NAME']\n\
- \ producer = EventHubProducerClient.from_connection_string(\n conn_str=event_hub_connection_str,\n\
- \ eventhub_name=eventhub_name # EventHub name should be specified if it\
- \ doesn't show up in connection string.\n )\n\n ````\n"
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\async_samples\\\
+ \\sample_code_eventhub_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.eventhub.aio import\
+ \ EventHubProducerClient\n event_hub_connection_str = os.environ['EVENT_HUB_CONN_STR']\n\
+ \ eventhub_name = os.environ['EVENT_HUB_NAME']\n producer = EventHubProducerClient.from_connection_string(\n\
+ \ conn_str=event_hub_connection_str,\n eventhub_name=eventhub_name\
+ \ # EventHub name should be specified if it doesn't show up in connection string.\n\
+ \ )\n\n ````\n"
- uid: azure.eventhub.aio.EventHubProducerClient.get_buffered_event_count
name: get_buffered_event_count
summary: "The number of events that are buffered and waiting to be published for\
@@ -717,8 +719,9 @@ methods:
examples:
- "Asynchronously sends event data<!--[!code-python[Main](les\\async_samples\\sample_code_eventhub_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\async_samples\\\\sample_code_eventhub_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 42\\\\azure-eventhub-5.8.0b2\\\\samples\\\\async_samples\\\\sample_code_eventhub_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n async with producer:\n event_data_batch = await producer.create_batch()\n\
diff --git a/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.extensions.yml b/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.extensions.yml
new file mode 100644
index 000000000000..cd57f6efd135
--- /dev/null
+++ b/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.extensions.yml
@@ -0,0 +1,5 @@
+### YamlMime:PythonPackage
+uid: azure.eventhub.extensions
+name: extensions
+fullName: azure.eventhub.extensions
+type: import
diff --git a/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.yml b/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.yml
index f47fa24e535c..70b760336901 100644
--- a/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.yml
+++ b/preview/docs-ref-autogen/azure-eventhub/azure.eventhub.yml
@@ -30,6 +30,7 @@ classes:
packages:
- azure.eventhub.aio
- azure.eventhub.amqp
+- azure.eventhub.extensions
modules:
- azure.eventhub.exceptions
enums:
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.AuthorizationCodeCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.AuthorizationCodeCredential.yml
index fc8a758ad8d3..9a585daf9550 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.AuthorizationCodeCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.AuthorizationCodeCredential.yml
@@ -64,13 +64,14 @@ constructor:
examples:
- "Create an AuthorizationCodeCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import AuthorizationCodeCredential\n\n credential = AuthorizationCodeCredential(\n\
- \ tenant_id=\"<tenant_id>\",\n client_id=\"<client_id>\",\n authorization_code=\"\
- <auth_code>\",\n redirect_uri=\"<redirect_uri>\",\n )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import AuthorizationCodeCredential\n\
+ \n credential = AuthorizationCodeCredential(\n tenant_id=\"<tenant_id>\"\
+ ,\n client_id=\"<client_id>\",\n authorization_code=\"<auth_code>\"\
+ ,\n redirect_uri=\"<redirect_uri>\",\n )\n\n ````\n"
methods:
- uid: azure.identity.AuthorizationCodeCredential.close
name: close
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.AzureCliCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.AzureCliCredential.yml
index b2eb748544dd..bbf2347f57bb 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.AzureCliCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.AzureCliCredential.yml
@@ -35,11 +35,12 @@ constructor:
examples:
- "Create an AzureCliCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import AzureCliCredential\n\n credential = AzureCliCredential()\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import AzureCliCredential\n\
+ \n credential = AzureCliCredential()\n\n ````\n"
methods:
- uid: azure.identity.AzureCliCredential.close
name: close
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.AzureDeveloperCliCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.AzureDeveloperCliCredential.yml
index 1cd55ead08ca..fa356774b213 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.AzureDeveloperCliCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.AzureDeveloperCliCredential.yml
@@ -51,12 +51,12 @@ constructor:
examples:
- "Create an AzureDeveloperCliCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import AzureDeveloperCliCredential\n\n credential = AzureDeveloperCliCredential()\n\
- \n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import AzureDeveloperCliCredential\n\
+ \n credential = AzureDeveloperCliCredential()\n\n ````\n"
methods:
- uid: azure.identity.AzureDeveloperCliCredential.close
name: close
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.AzurePowerShellCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.AzurePowerShellCredential.yml
index 040568d5cb33..7daa0463cca8 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.AzurePowerShellCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.AzurePowerShellCredential.yml
@@ -35,12 +35,12 @@ constructor:
examples:
- "Create an AzurePowerShellCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import AzurePowerShellCredential\n\n credential = AzurePowerShellCredential()\n\
- \n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import AzurePowerShellCredential\n\
+ \n credential = AzurePowerShellCredential()\n\n ````\n"
methods:
- uid: azure.identity.AzurePowerShellCredential.close
name: close
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.CertificateCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.CertificateCredential.yml
index 77a283010571..b30bb2ed9ca2 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.CertificateCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.CertificateCredential.yml
@@ -108,14 +108,14 @@ constructor:
examples:
- "Create a CertificateCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import CertificateCredential\n\n credential = CertificateCredential(\n \
- \ tenant_id=\"<tenant_id>\",\n client_id=\"<client_id>\",\n certificate_path=\"\
- <path to PEM/PKCS12 certificate>\",\n password=\"<certificate password if\
- \ necessary>\",\n )\n\n # Certificate/private key byte data can also be passed\
- \ directly\n credential = CertificateCredential(\n tenant_id=\"<tenant_id>\"\
- ,\n client_id=\"<client_id>\",\n certificate_data=b\"<cert data>\",\n\
- \ )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import CertificateCredential\n\
+ \n credential = CertificateCredential(\n tenant_id=\"<tenant_id>\",\n \
+ \ client_id=\"<client_id>\",\n certificate_path=\"<path to PEM/PKCS12\
+ \ certificate>\",\n password=\"<certificate password if necessary>\",\n \
+ \ )\n\n # Certificate/private key byte data can also be passed directly\n credential\
+ \ = CertificateCredential(\n tenant_id=\"<tenant_id>\",\n client_id=\"\
+ <client_id>\",\n certificate_data=b\"<cert data>\",\n )\n\n ````\n"
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.ChainedTokenCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.ChainedTokenCredential.yml
index e7d7c4a8178f..77fd30e5e9e2 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.ChainedTokenCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.ChainedTokenCredential.yml
@@ -23,14 +23,15 @@ constructor:
examples:
- "Create a ChainedTokenCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import ChainedTokenCredential, EnvironmentCredential, AzureCliCredential\n\n \
- \ credential_chain = (\n # Try EnvironmentCredential first\n EnvironmentCredential(),\n\
- \ # Fallback to Azure CLI if EnvironmentCredential fails\n AzureCliCredential(),\n\
- \ )\n credential = ChainedTokenCredential(*credential_chain)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import ChainedTokenCredential,\
+ \ EnvironmentCredential, AzureCliCredential\n\n credential_chain = (\n #\
+ \ Try EnvironmentCredential first\n EnvironmentCredential(),\n # Fallback\
+ \ to Azure CLI if EnvironmentCredential fails\n AzureCliCredential(),\n \
+ \ )\n credential = ChainedTokenCredential(*credential_chain)\n\n ````\n"
methods:
- uid: azure.identity.ChainedTokenCredential.close
name: close
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.ClientAssertionCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.ClientAssertionCredential.yml
index 8fc52d797fc0..0e191a3d862f 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.ClientAssertionCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.ClientAssertionCredential.yml
@@ -54,14 +54,14 @@ constructor:
examples:
- "Create a ClientAssertionCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import ClientAssertionCredential\n\n def get_assertion():\n return \"\
- <client-assertion>\"\n\n credential = ClientAssertionCredential(\n tenant_id=\"\
- <tenant_id>\",\n client_id=\"<client_id>\",\n func=get_assertion,\n\
- \ )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import ClientAssertionCredential\n\
+ \n def get_assertion():\n return \"<client-assertion>\"\n\n credential\
+ \ = ClientAssertionCredential(\n tenant_id=\"<tenant_id>\",\n client_id=\"\
+ <client_id>\",\n func=get_assertion,\n )\n\n ````\n"
methods:
- uid: azure.identity.ClientAssertionCredential.close
name: close
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.ClientSecretCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.ClientSecretCredential.yml
index 7b4940030212..0ea146a88e54 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.ClientSecretCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.ClientSecretCredential.yml
@@ -74,10 +74,11 @@ constructor:
examples:
- "Create a ClientSecretCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import ClientSecretCredential\n\n credential = ClientSecretCredential(\n \
- \ tenant_id=\"<tenant_id>\",\n client_id=\"<client_id>\",\n client_secret=\"\
- <client_secret>\",\n )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import ClientSecretCredential\n\
+ \n credential = ClientSecretCredential(\n tenant_id=\"<tenant_id>\",\n \
+ \ client_id=\"<client_id>\",\n client_secret=\"<client_secret>\",\n \
+ \ )\n\n ````\n"
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.DefaultAzureCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.DefaultAzureCredential.yml
index b8ae5b4d7d8b..cc8d00f72679 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.DefaultAzureCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.DefaultAzureCredential.yml
@@ -154,12 +154,12 @@ constructor:
examples:
- "Create a DefaultAzureCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import DefaultAzureCredential\n\n credential = DefaultAzureCredential()\n\n\
- \ ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import DefaultAzureCredential\n\
+ \n credential = DefaultAzureCredential()\n\n ````\n"
methods:
- uid: azure.identity.DefaultAzureCredential.get_token
name: get_token
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.DeviceCodeCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.DeviceCodeCredential.yml
index 7a36ee267cd1..1edec9a99adf 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.DeviceCodeCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.DeviceCodeCredential.yml
@@ -111,8 +111,9 @@ constructor:
examples:
- "Create a DeviceCodeCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import DeviceCodeCredential\n\n credential = DeviceCodeCredential()\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import DeviceCodeCredential\n\
+ \n credential = DeviceCodeCredential()\n\n ````\n"
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.EnvironmentCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.EnvironmentCredential.yml
index 9ba99b77af76..02bb046ec754 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.EnvironmentCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.EnvironmentCredential.yml
@@ -35,12 +35,12 @@ constructor:
examples:
- "Create an EnvironmentCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import EnvironmentCredential\n\n credential = EnvironmentCredential()\n\n \
- \ ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import EnvironmentCredential\n\
+ \n credential = EnvironmentCredential()\n\n ````\n"
methods:
- uid: azure.identity.EnvironmentCredential.close
name: close
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.InteractiveBrowserCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.InteractiveBrowserCredential.yml
index 32054cf8e930..e3a01ba17655 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.InteractiveBrowserCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.InteractiveBrowserCredential.yml
@@ -105,9 +105,10 @@ constructor:
examples:
- "Create an InteractiveBrowserCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import InteractiveBrowserCredential\n\n credential = InteractiveBrowserCredential(\n\
- \ client_id=\"<client_id>\",\n )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import InteractiveBrowserCredential\n\
+ \n credential = InteractiveBrowserCredential(\n client_id=\"<client_id>\"\
+ ,\n )\n\n ````\n"
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.ManagedIdentityCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.ManagedIdentityCredential.yml
index 6810993ebca5..1a83fe6753a5 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.ManagedIdentityCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.ManagedIdentityCredential.yml
@@ -39,13 +39,14 @@ constructor:
examples:
- "Create a ManagedIdentityCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import ManagedIdentityCredential\n\n credential = ManagedIdentityCredential()\n\
- \n # Can also specify a client ID of a user-assigned managed identity\n credential\
- \ = ManagedIdentityCredential(\n client_id=\"<client_id>\",\n )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import ManagedIdentityCredential\n\
+ \n credential = ManagedIdentityCredential()\n\n # Can also specify a client\
+ \ ID of a user-assigned managed identity\n credential = ManagedIdentityCredential(\n\
+ \ client_id=\"<client_id>\",\n )\n\n ````\n"
methods:
- uid: azure.identity.ManagedIdentityCredential.close
name: close
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.OnBehalfOfCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.OnBehalfOfCredential.yml
index ff521832b60d..d358b09348f8 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.OnBehalfOfCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.OnBehalfOfCredential.yml
@@ -108,10 +108,11 @@ constructor:
examples:
- "Create an OnBehalfOfCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import OnBehalfOfCredential\n\n credential = OnBehalfOfCredential(\n tenant_id=\"\
- <tenant_id>\",\n client_id=\"<client_id>\",\n client_secret=\"<client_secret>\"\
- ,\n user_assertion=\"<access_token>\",\n )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import OnBehalfOfCredential\n\
+ \n credential = OnBehalfOfCredential(\n tenant_id=\"<tenant_id>\",\n \
+ \ client_id=\"<client_id>\",\n client_secret=\"<client_secret>\",\n \
+ \ user_assertion=\"<access_token>\",\n )\n\n ````\n"
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.TokenCachePersistenceOptions.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.TokenCachePersistenceOptions.yml
index 6a9542055f9f..ebac80ef6a09 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.TokenCachePersistenceOptions.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.TokenCachePersistenceOptions.yml
@@ -65,11 +65,12 @@ constructor:
examples:
- "Configuring a credential for persistent caching<!--[!code-python[Main](s\\test_persistent_cache.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\tests\\\\test_persistent_cache.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
- \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n cache_options\
- \ = TokenCachePersistenceOptions()\n credential = InteractiveBrowserCredential(cache_persistence_options=cache_options)\n\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\tests\\\\test_persistent_cache.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n cache_options = TokenCachePersistenceOptions()\n\
+ \ credential = InteractiveBrowserCredential(cache_persistence_options=cache_options)\n\
\n # specify a cache name to isolate the cache from other applications\n TokenCachePersistenceOptions(name=\"\
my_application\")\n\n # configure the cache to fall back to unencrypted storage\
\ when encryption isn't available\n TokenCachePersistenceOptions(allow_unencrypted_storage=True)\n\
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.UsernamePasswordCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.UsernamePasswordCredential.yml
index 1e471ca88af6..78592027f639 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.UsernamePasswordCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.UsernamePasswordCredential.yml
@@ -105,10 +105,11 @@ constructor:
examples:
- "Create a UsernamePasswordCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import UsernamePasswordCredential\n\n credential = UsernamePasswordCredential(\n\
- \ client_id=\"<client_id>\",\n username=\"<username>\",\n password=\"\
- <password>\",\n )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import UsernamePasswordCredential\n\
+ \n credential = UsernamePasswordCredential(\n client_id=\"<client_id>\"\
+ ,\n username=\"<username>\",\n password=\"<password>\",\n )\n\n \
+ \ ````\n"
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.WorkloadIdentityCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.WorkloadIdentityCredential.yml
index cddb0e44a0d1..41008c6d03e8 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.WorkloadIdentityCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.WorkloadIdentityCredential.yml
@@ -66,13 +66,13 @@ constructor:
examples:
- "Create a WorkloadIdentityCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import WorkloadIdentityCredential\n\n credential = WorkloadIdentityCredential(\n\
- \ tenant_id=\"<tenant_id>\",\n client_id=\"<client_id>\",\n token_file_path=\"\
- <token_file_path>\",\n )\n\n # Parameters can be omitted if the following environment\
- \ variables are set:\n # - AZURE_TENANT_ID\n # - AZURE_CLIENT_ID\n # \
- \ - AZURE_FEDERATED_TOKEN_FILE\n credential = WorkloadIdentityCredential()\n\n\
- \ ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity import WorkloadIdentityCredential\n\
+ \n credential = WorkloadIdentityCredential(\n tenant_id=\"<tenant_id>\"\
+ ,\n client_id=\"<client_id>\",\n token_file_path=\"<token_file_path>\"\
+ ,\n )\n\n # Parameters can be omitted if the following environment variables\
+ \ are set:\n # - AZURE_TENANT_ID\n # - AZURE_CLIENT_ID\n # - AZURE_FEDERATED_TOKEN_FILE\n\
+ \ credential = WorkloadIdentityCredential()\n\n ````\n"
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.AuthorizationCodeCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.AuthorizationCodeCredential.yml
index f05bd8d9e7fc..39d5e3118147 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.AuthorizationCodeCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.AuthorizationCodeCredential.yml
@@ -65,11 +65,12 @@ constructor:
examples:
- "Create an AuthorizationCodeCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import AuthorizationCodeCredential\n\n credential = AuthorizationCodeCredential(\n\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ AuthorizationCodeCredential\n\n credential = AuthorizationCodeCredential(\n\
\ tenant_id=\"<tenant_id>\",\n client_id=\"<client_id>\",\n authorization_code=\"\
<auth_code>\",\n redirect_uri=\"<redirect_uri>\",\n )\n\n ````\n"
methods:
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.AzureCliCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.AzureCliCredential.yml
index e0c1fe8cda22..8ada271e065b 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.AzureCliCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.AzureCliCredential.yml
@@ -35,11 +35,12 @@ constructor:
examples:
- "Create an AzureCliCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import AzureCliCredential\n\n credential = AzureCliCredential()\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ AzureCliCredential\n\n credential = AzureCliCredential()\n\n ````\n"
methods:
- uid: azure.identity.aio.AzureCliCredential.close
name: close
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.AzureDeveloperCliCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.AzureDeveloperCliCredential.yml
index 45619a7ba18f..283f88a12929 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.AzureDeveloperCliCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.AzureDeveloperCliCredential.yml
@@ -51,11 +51,12 @@ constructor:
examples:
- "Create an AzureDeveloperCliCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import AzureDeveloperCliCredential\n\n credential = AzureDeveloperCliCredential()\n\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ AzureDeveloperCliCredential\n\n credential = AzureDeveloperCliCredential()\n\
\n ````\n"
methods:
- uid: azure.identity.aio.AzureDeveloperCliCredential.close
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.AzurePowerShellCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.AzurePowerShellCredential.yml
index 3fafa2ca1bdb..a78fd341076f 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.AzurePowerShellCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.AzurePowerShellCredential.yml
@@ -35,12 +35,13 @@ constructor:
examples:
- "Create an AzurePowerShellCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import AzurePowerShellCredential\n\n credential = AzurePowerShellCredential()\n\
- \n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ AzurePowerShellCredential\n\n credential = AzurePowerShellCredential()\n\n \
+ \ ````\n"
methods:
- uid: azure.identity.aio.AzurePowerShellCredential.close
name: close
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.CertificateCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.CertificateCredential.yml
index dbefec4956b4..0ccd4d63e44d 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.CertificateCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.CertificateCredential.yml
@@ -77,17 +77,18 @@ constructor:
examples:
- "Create a CertificateCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import CertificateCredential\n\n credential = CertificateCredential(\n \
- \ tenant_id=\"<tenant_id>\",\n client_id=\"<client_id>\",\n certificate_path=\"\
- <path to PEM/PKCS12 certificate>\",\n password=\"<certificate password if\
- \ necessary>\",\n )\n\n # Certificate/private key byte data can also be passed\
- \ directly\n credential = CertificateCredential(\n tenant_id=\"<tenant_id>\"\
- ,\n client_id=\"<client_id>\",\n certificate_data=b\"<cert data>\",\n\
- \ )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ CertificateCredential\n\n credential = CertificateCredential(\n tenant_id=\"\
+ <tenant_id>\",\n client_id=\"<client_id>\",\n certificate_path=\"<path\
+ \ to PEM/PKCS12 certificate>\",\n password=\"<certificate password if necessary>\"\
+ ,\n )\n\n # Certificate/private key byte data can also be passed directly\n\
+ \ credential = CertificateCredential(\n tenant_id=\"<tenant_id>\",\n \
+ \ client_id=\"<client_id>\",\n certificate_data=b\"<cert data>\",\n )\n\
+ \n ````\n"
methods:
- uid: azure.identity.aio.CertificateCredential.close
name: close
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.ChainedTokenCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.ChainedTokenCredential.yml
index bae698ce2959..50071331102e 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.ChainedTokenCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.ChainedTokenCredential.yml
@@ -23,12 +23,13 @@ constructor:
examples:
- "Create a ChainedTokenCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import ChainedTokenCredential, EnvironmentCredential, AzureCliCredential\n\n \
- \ credential_chain = (\n # Try EnvironmentCredential first\n EnvironmentCredential(),\n\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ ChainedTokenCredential, EnvironmentCredential, AzureCliCredential\n\n credential_chain\
+ \ = (\n # Try EnvironmentCredential first\n EnvironmentCredential(),\n\
\ # Fallback to Azure CLI if EnvironmentCredential fails\n AzureCliCredential(),\n\
\ )\n credential = ChainedTokenCredential(*credential_chain)\n\n ````\n"
methods:
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.ClientAssertionCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.ClientAssertionCredential.yml
index a118e21e5ad0..1fbd55ea1b31 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.ClientAssertionCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.ClientAssertionCredential.yml
@@ -55,14 +55,14 @@ constructor:
examples:
- "Create a ClientAssertionCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import ClientAssertionCredential\n\n def get_assertion():\n return \"\
- <client-assertion>\"\n\n credential = ClientAssertionCredential(\n tenant_id=\"\
- <tenant_id>\",\n client_id=\"<client_id>\",\n func=get_assertion,\n\
- \ )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ ClientAssertionCredential\n\n def get_assertion():\n return \"<client-assertion>\"\
+ \n\n credential = ClientAssertionCredential(\n tenant_id=\"<tenant_id>\"\
+ ,\n client_id=\"<client_id>\",\n func=get_assertion,\n )\n\n ````\n"
methods:
- uid: azure.identity.aio.ClientAssertionCredential.close
name: close
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.ClientSecretCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.ClientSecretCredential.yml
index 0a8592a66633..71466a5e8849 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.ClientSecretCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.ClientSecretCredential.yml
@@ -54,13 +54,14 @@ constructor:
examples:
- "Create a ClientSecretCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import ClientSecretCredential\n\n credential = ClientSecretCredential(\n \
- \ tenant_id=\"<tenant_id>\",\n client_id=\"<client_id>\",\n client_secret=\"\
- <client_secret>\",\n )\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ ClientSecretCredential\n\n credential = ClientSecretCredential(\n tenant_id=\"\
+ <tenant_id>\",\n client_id=\"<client_id>\",\n client_secret=\"<client_secret>\"\
+ ,\n )\n\n ````\n"
methods:
- uid: azure.identity.aio.ClientSecretCredential.close
name: close
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.DefaultAzureCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.DefaultAzureCredential.yml
index e44828f2ebd1..980802de1ebe 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.DefaultAzureCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.DefaultAzureCredential.yml
@@ -133,12 +133,12 @@ constructor:
examples:
- "Create a DefaultAzureCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import DefaultAzureCredential\n\n credential = DefaultAzureCredential()\n\n\
- \ ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ DefaultAzureCredential\n\n credential = DefaultAzureCredential()\n\n ````\n"
methods:
- uid: azure.identity.aio.DefaultAzureCredential.get_token
name: get_token
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.EnvironmentCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.EnvironmentCredential.yml
index 94f51c223d92..86080615eb07 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.EnvironmentCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.EnvironmentCredential.yml
@@ -27,12 +27,12 @@ constructor:
examples:
- "Create an EnvironmentCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import EnvironmentCredential\n\n credential = EnvironmentCredential()\n\n \
- \ ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ EnvironmentCredential\n\n credential = EnvironmentCredential()\n\n ````\n"
methods:
- uid: azure.identity.aio.EnvironmentCredential.close
name: close
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.ManagedIdentityCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.ManagedIdentityCredential.yml
index 7286ecf7e759..3cd08ba5dacc 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.ManagedIdentityCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.ManagedIdentityCredential.yml
@@ -39,12 +39,13 @@ constructor:
examples:
- "Create a ManagedIdentityCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import ManagedIdentityCredential\n\n credential = ManagedIdentityCredential()\n\
- \n # Can also specify a client ID of a user-assigned managed identity\n credential\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ ManagedIdentityCredential\n\n credential = ManagedIdentityCredential()\n\n \
+ \ # Can also specify a client ID of a user-assigned managed identity\n credential\
\ = ManagedIdentityCredential(\n client_id=\"<client_id>\",\n )\n\n ````\n"
methods:
- uid: azure.identity.aio.ManagedIdentityCredential.close
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.OnBehalfOfCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.OnBehalfOfCredential.yml
index a4c46767cb19..5a6311a04ffe 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.OnBehalfOfCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.OnBehalfOfCredential.yml
@@ -89,11 +89,12 @@ constructor:
examples:
- "Create an OnBehalfOfCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import OnBehalfOfCredential\n\n credential = OnBehalfOfCredential(\n tenant_id=\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ OnBehalfOfCredential\n\n credential = OnBehalfOfCredential(\n tenant_id=\"\
<tenant_id>\",\n client_id=\"<client_id>\",\n client_secret=\"<client_secret>\"\
,\n user_assertion=\"<access_token>\",\n )\n\n ````\n"
methods:
diff --git a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.WorkloadIdentityCredential.yml b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.WorkloadIdentityCredential.yml
index 7d857b10232a..05bd51838e1b 100644
--- a/preview/docs-ref-autogen/azure-identity/azure.identity.aio.WorkloadIdentityCredential.yml
+++ b/preview/docs-ref-autogen/azure-identity/azure.identity.aio.WorkloadIdentityCredential.yml
@@ -66,12 +66,13 @@ constructor:
examples:
- "Create a WorkloadIdentityCredential.<!--[!code-python[Main](les\\credential_creation_code_snippets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\45\\\\azure-identity-1.15.0b1\\\\samples\\\\credential_creation_code_snippets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import WorkloadIdentityCredential\n\n credential = WorkloadIdentityCredential(\n\
- \ tenant_id=\"<tenant_id>\",\n client_id=\"<client_id>\",\n token_file_path=\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\45\\\\azure-identity-1.15.0b1\\\
+ \\samples\\\\credential_creation_code_snippets.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ WorkloadIdentityCredential\n\n credential = WorkloadIdentityCredential(\n \
+ \ tenant_id=\"<tenant_id>\",\n client_id=\"<client_id>\",\n token_file_path=\"\
<token_file_path>\",\n )\n\n # Parameters can be omitted if the following environment\
\ variables are set:\n # - AZURE_TENANT_ID\n # - AZURE_CLIENT_ID\n # \
\ - AZURE_FEDERATED_TOKEN_FILE\n credential = WorkloadIdentityCredential()\n\n\
diff --git a/preview/docs-ref-autogen/azure-keyvault-administration/azure.keyvault.administration.KeyVaultBackupClient.yml b/preview/docs-ref-autogen/azure-keyvault-administration/azure.keyvault.administration.KeyVaultBackupClient.yml
index 4f24f2353a48..c531d5abc1cd 100644
--- a/preview/docs-ref-autogen/azure-keyvault-administration/azure.keyvault.administration.KeyVaultBackupClient.yml
+++ b/preview/docs-ref-autogen/azure-keyvault-administration/azure.keyvault.administration.KeyVaultBackupClient.yml
@@ -74,8 +74,9 @@ methods:
examples:
- "Create a vault backup<!--[!code-python[Main](s\\test_examples_administration.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\51\\\\azure-keyvault-administration-4.4.0b1\\\\tests\\\\test_examples_administration.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 51\\\\azure-keyvault-administration-4.4.0b1\\\\tests\\\\test_examples_administration.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # begin a vault backup\n backup_poller = backup_client.begin_backup(container_uri,\
@@ -123,8 +124,9 @@ methods:
examples:
- "Restore a vault backup<!--[!code-python[Main](s\\test_examples_administration.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\51\\\\azure-keyvault-administration-4.4.0b1\\\\tests\\\\test_examples_administration.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 51\\\\azure-keyvault-administration-4.4.0b1\\\\tests\\\\test_examples_administration.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # begin a full vault restore\n restore_poller = backup_client.begin_restore(folder_url,\
@@ -132,8 +134,9 @@ methods:
\n # wait for the restore to complete\n restore_poller.wait()\n\n ````\n\
\nRestore a single key<!--[!code-python[Main](s\\test_examples_administration.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\51\\\\azure-keyvault-administration-4.4.0b1\\\\tests\\\\test_examples_administration.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 51\\\\azure-keyvault-administration-4.4.0b1\\\\tests\\\\test_examples_administration.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # begin a restore of a single key from a backed up vault\n restore_poller\
diff --git a/preview/docs-ref-autogen/azure-keyvault-administration/azure.keyvault.administration.aio.KeyVaultBackupClient.yml b/preview/docs-ref-autogen/azure-keyvault-administration/azure.keyvault.administration.aio.KeyVaultBackupClient.yml
index 5edc93620174..6bdcf886ca02 100644
--- a/preview/docs-ref-autogen/azure-keyvault-administration/azure.keyvault.administration.aio.KeyVaultBackupClient.yml
+++ b/preview/docs-ref-autogen/azure-keyvault-administration/azure.keyvault.administration.aio.KeyVaultBackupClient.yml
@@ -73,8 +73,9 @@ methods:
examples:
- "Create a vault backup<!--[!code-python[Main](s\\test_examples_administration_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\51\\\\azure-keyvault-administration-4.4.0b1\\\\tests\\\\test_examples_administration_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 51\\\\azure-keyvault-administration-4.4.0b1\\\\tests\\\\test_examples_administration_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # begin a vault backup\n backup_poller = await backup_client.begin_backup(container_uri,\
@@ -126,8 +127,9 @@ methods:
examples:
- "Restore a vault backup<!--[!code-python[Main](s\\test_examples_administration_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\51\\\\azure-keyvault-administration-4.4.0b1\\\\tests\\\\test_examples_administration_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 51\\\\azure-keyvault-administration-4.4.0b1\\\\tests\\\\test_examples_administration_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # begin a full vault restore\n restore_poller = await backup_client.begin_restore(folder_url,\
@@ -135,8 +137,9 @@ methods:
\n # wait for the restore to complete\n await restore_poller.wait()\n\n \
\ ````\n\nRestore a single key<!--[!code-python[Main](s\\test_examples_administration_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\51\\\\azure-keyvault-administration-4.4.0b1\\\\tests\\\\test_examples_administration_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 51\\\\azure-keyvault-administration-4.4.0b1\\\\tests\\\\test_examples_administration_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # begin a restore of a single key from a backed up vault\n restore_poller\
diff --git a/preview/docs-ref-autogen/azure-keyvault-certificates/azure.keyvault.certificates.CertificateClient.yml b/preview/docs-ref-autogen/azure-keyvault-certificates/azure.keyvault.certificates.CertificateClient.yml
index 32bab3c55c49..41aa1e03ff83 100644
--- a/preview/docs-ref-autogen/azure-keyvault-certificates/azure.keyvault.certificates.CertificateClient.yml
+++ b/preview/docs-ref-autogen/azure-keyvault-certificates/azure.keyvault.certificates.CertificateClient.yml
@@ -42,14 +42,15 @@ constructor:
examples:
- "Create a new `CertificateClient`<!--[!code-python[Main](s\\test_examples_certificates.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import DefaultAzureCredential\n from azure.keyvault.certificates import CertificateClient\n\
- \n # Create a CertificateClient using default Azure credentials\n credential\
- \ = DefaultAzureCredential()\n certificate_client = CertificateClient(vault_url=vault_url,\
- \ credential=credential)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\
+ \\tests\\\\test_examples_certificates.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.identity import DefaultAzureCredential\n\
+ \ from azure.keyvault.certificates import CertificateClient\n\n # Create a CertificateClient\
+ \ using default Azure credentials\n credential = DefaultAzureCredential()\n \
+ \ certificate_client = CertificateClient(vault_url=vault_url, credential=credential)\n\
+ \n ````\n"
methods:
- uid: azure.keyvault.certificates.CertificateClient.backup_certificate
name: backup_certificate
@@ -85,8 +86,9 @@ methods:
examples:
- "Get a certificate backup<!--[!code-python[Main](s\\test_examples_certificates.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # backup certificate\n certificate_backup = certificate_client.backup_certificate(cert_name)\n\
@@ -139,8 +141,9 @@ methods:
examples:
- "Create a certificate<!--[!code-python[Main](s\\test_examples_certificates.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.keyvault.certificates import (CertificateContentType,\n \
@@ -201,8 +204,9 @@ methods:
examples:
- "Delete a certificate<!--[!code-python[Main](s\\test_examples_certificates.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # delete a certificate\n deleted_certificate = certificate_client.begin_delete_certificate(certificate.name).result()\n\
@@ -252,8 +256,9 @@ methods:
examples:
- "Recover a deleted certificate<!--[!code-python[Main](s\\test_examples_certificates.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # recover a deleted certificate to its latest version (requires soft-delete\
@@ -324,20 +329,20 @@ methods:
examples:
- "Create an issuer<!--[!code-python[Main](s\\test_examples_certificates.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.keyvault.certificates import AdministratorContact\n\n # First\
- \ we specify the AdministratorContact for a issuer.\n admin_contacts = [\n \
- \ AdministratorContact(first_name=\"John\", last_name=\"Doe\", email=\"admin@microsoft.com\"\
- , phone=\"4255555555\")\n ]\n\n issuer = certificate_client.create_issuer(\n\
- \ issuer_name=\"issuer1\",\n provider=\"Test\",\n account_id=\"\
- keyvaultuser\",\n admin_contacts=admin_contacts,\n enabled=True,\n\
- \ )\n\n print(issuer.name)\n print(issuer.provider)\n print(issuer.account_id)\n\
- \n for contact in issuer.admin_contacts:\n print(contact.first_name)\n\
- \ print(contact.last_name)\n print(contact.email)\n print(contact.phone)\n\
- \n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\
+ \\tests\\\\test_examples_certificates.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.keyvault.certificates import\
+ \ AdministratorContact\n\n # First we specify the AdministratorContact for a\
+ \ issuer.\n admin_contacts = [\n AdministratorContact(first_name=\"John\"\
+ , last_name=\"Doe\", email=\"admin@microsoft.com\", phone=\"4255555555\")\n \
+ \ ]\n\n issuer = certificate_client.create_issuer(\n issuer_name=\"issuer1\"\
+ ,\n provider=\"Test\",\n account_id=\"keyvaultuser\",\n admin_contacts=admin_contacts,\n\
+ \ enabled=True,\n )\n\n print(issuer.name)\n print(issuer.provider)\n\
+ \ print(issuer.account_id)\n\n for contact in issuer.admin_contacts:\n \
+ \ print(contact.first_name)\n print(contact.last_name)\n print(contact.email)\n\
+ \ print(contact.phone)\n\n ````\n"
- uid: azure.keyvault.certificates.CertificateClient.delete_certificate_operation
name: delete_certificate_operation
summary: 'Deletes and stops the creation operation for a specific certificate.
@@ -371,13 +376,14 @@ methods:
examples:
- "Delete contacts<!--[!code-python[Main](s\\test_examples_certificates.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n deleted_contacts = certificate_client.delete_contacts()\n\n for deleted_contact\
- \ in deleted_contacts:\n print(deleted_contact.name)\n print(deleted_contact.email)\n\
- \ print(deleted_contact.phone)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\
+ \\tests\\\\test_examples_certificates.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n deleted_contacts = certificate_client.delete_contacts()\n\
+ \n for deleted_contact in deleted_contacts:\n print(deleted_contact.name)\n\
+ \ print(deleted_contact.email)\n print(deleted_contact.phone)\n\n\
+ \ ````\n"
- uid: azure.keyvault.certificates.CertificateClient.delete_issuer
name: delete_issuer
summary: 'Deletes the specified certificate issuer.
@@ -400,15 +406,15 @@ methods:
examples:
- "Delete an issuer<!--[!code-python[Main](s\\test_examples_certificates.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n deleted_issuer = certificate_client.delete_issuer(\"issuer1\")\n\n print(deleted_issuer.name)\n\
- \ print(deleted_issuer.provider)\n print(deleted_issuer.account_id)\n\n \
- \ for contact in deleted_issuer.admin_contacts:\n print(contact.first_name)\n\
- \ print(contact.last_name)\n print(contact.email)\n print(contact.phone)\n\
- \n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\
+ \\tests\\\\test_examples_certificates.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n deleted_issuer = certificate_client.delete_issuer(\"\
+ issuer1\")\n\n print(deleted_issuer.name)\n print(deleted_issuer.provider)\n\
+ \ print(deleted_issuer.account_id)\n\n for contact in deleted_issuer.admin_contacts:\n\
+ \ print(contact.first_name)\n print(contact.last_name)\n print(contact.email)\n\
+ \ print(contact.phone)\n\n ````\n"
- uid: azure.keyvault.certificates.CertificateClient.get_certificate
name: get_certificate
summary: 'Gets a certificate with its management policy attached. Requires certificates/get
@@ -438,13 +444,13 @@ methods:
examples:
- "Get a certificate<!--[!code-python[Main](s\\test_examples_certificates.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # get the certificate\n certificate = certificate_client.get_certificate(cert_name)\n\
- \n print(certificate.id)\n print(certificate.name)\n print(certificate.policy.issuer_name)\n\
- \n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\
+ \\tests\\\\test_examples_certificates.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # get the certificate\n certificate\
+ \ = certificate_client.get_certificate(cert_name)\n\n print(certificate.id)\n\
+ \ print(certificate.name)\n print(certificate.policy.issuer_name)\n\n ````\n"
- uid: azure.keyvault.certificates.CertificateClient.get_certificate_operation
name: get_certificate_operation
summary: Gets the creation operation of a certificate. Requires the certificates/get
@@ -519,8 +525,9 @@ methods:
examples:
- "Get a certificate with a specific version<!--[!code-python[Main](s\\test_examples_certificates.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n certificate = certificate_client.get_certificate_version(cert_name, version)\n\
@@ -539,13 +546,14 @@ methods:
examples:
- "Get contacts<!--[!code-python[Main](s\\test_examples_certificates.py )]-->\n\n\
<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n contacts = certificate_client.get_contacts()\n\n # Loop through the certificate\
- \ contacts for this key vault.\n for contact in contacts:\n print(contact.name)\n\
- \ print(contact.email)\n print(contact.phone)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\
+ \\tests\\\\test_examples_certificates.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n contacts = certificate_client.get_contacts()\n\
+ \n # Loop through the certificate contacts for this key vault.\n for contact\
+ \ in contacts:\n print(contact.name)\n print(contact.email)\n \
+ \ print(contact.phone)\n\n ````\n"
- uid: azure.keyvault.certificates.CertificateClient.get_deleted_certificate
name: get_deleted_certificate
summary: 'Get a deleted certificate. Possible only in a vault with soft-delete enabled.
@@ -575,8 +583,9 @@ methods:
examples:
- "Get a deleted certificate<!--[!code-python[Main](s\\test_examples_certificates.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # get a deleted certificate (requires soft-delete enabled for the vault)\n\
@@ -608,14 +617,15 @@ methods:
examples:
- "Get an issuer<!--[!code-python[Main](s\\test_examples_certificates.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n issuer = certificate_client.get_issuer(\"issuer1\")\n\n print(issuer.name)\n\
- \ print(issuer.provider)\n print(issuer.account_id)\n\n for contact in issuer.admin_contacts:\n\
- \ print(contact.first_name)\n print(contact.last_name)\n print(contact.email)\n\
- \ print(contact.phone)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\
+ \\tests\\\\test_examples_certificates.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n issuer = certificate_client.get_issuer(\"\
+ issuer1\")\n\n print(issuer.name)\n print(issuer.provider)\n print(issuer.account_id)\n\
+ \n for contact in issuer.admin_contacts:\n print(contact.first_name)\n\
+ \ print(contact.last_name)\n print(contact.email)\n print(contact.phone)\n\
+ \n ````\n"
- uid: azure.keyvault.certificates.CertificateClient.import_certificate
name: import_certificate
summary: 'Import a certificate created externally. Requires certificates/import
@@ -706,8 +716,9 @@ methods:
examples:
- "List all the deleted certificates<!--[!code-python[Main](s\\test_examples_certificates.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # get an iterator of deleted certificates (requires soft-delete enabled for\
@@ -739,8 +750,9 @@ methods:
examples:
- "List all versions of a certificate<!--[!code-python[Main](s\\test_examples_certificates.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # get an iterator of a certificate's versions\n certificate_versions =\
@@ -772,8 +784,9 @@ methods:
examples:
- "List all certificates<!--[!code-python[Main](s\\test_examples_certificates.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # get an iterator of certificates\n certificates = certificate_client.list_properties_of_certificates()\n\
@@ -796,8 +809,9 @@ methods:
examples:
- "List issuers of a vault<!--[!code-python[Main](s\\test_examples_certificates.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n issuers = certificate_client.list_properties_of_issuers()\n\n for issuer\
@@ -907,8 +921,9 @@ methods:
examples:
- "Restore a certificate backup<!--[!code-python[Main](s\\test_examples_certificates.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # restore a certificate backup\n restored_certificate = certificate_client.restore_certificate_backup(certificate_backup)\n\
@@ -934,17 +949,18 @@ methods:
examples:
- "Create contacts<!--[!code-python[Main](s\\test_examples_certificates.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.keyvault.certificates import CertificateContact\n\n # Create\
- \ a list of the contacts that you want to set for this key vault.\n contact_list\
- \ = [\n CertificateContact(email=\"admin@contoso.com\", name=\"John Doe\"\
- , phone=\"1111111111\"),\n CertificateContact(email=\"admin2@contoso.com\"\
- , name=\"John Doe2\", phone=\"2222222222\"),\n ]\n\n contacts = certificate_client.set_contacts(contact_list)\n\
- \ for contact in contacts:\n print(contact.name)\n print(contact.email)\n\
- \ print(contact.phone)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\
+ \\tests\\\\test_examples_certificates.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.keyvault.certificates import\
+ \ CertificateContact\n\n # Create a list of the contacts that you want to set\
+ \ for this key vault.\n contact_list = [\n CertificateContact(email=\"\
+ admin@contoso.com\", name=\"John Doe\", phone=\"1111111111\"),\n CertificateContact(email=\"\
+ admin2@contoso.com\", name=\"John Doe2\", phone=\"2222222222\"),\n ]\n\n contacts\
+ \ = certificate_client.set_contacts(contact_list)\n for contact in contacts:\n\
+ \ print(contact.name)\n print(contact.email)\n print(contact.phone)\n\
+ \n ````\n"
- uid: azure.keyvault.certificates.CertificateClient.update_certificate_policy
name: update_certificate_policy
summary: 'Updates the policy for a certificate. Requires certificates/update permission.
@@ -1003,8 +1019,9 @@ methods:
examples:
- "Update a certificate's attributes<!--[!code-python[Main](s\\test_examples_certificates.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # update attributes of an existing certificate\n tags = {\"foo\": \"updated\
diff --git a/preview/docs-ref-autogen/azure-keyvault-certificates/azure.keyvault.certificates.KeyVaultCertificateIdentifier.yml b/preview/docs-ref-autogen/azure-keyvault-certificates/azure.keyvault.certificates.KeyVaultCertificateIdentifier.yml
index 8bbe5c11701a..e74c430d8fc3 100644
--- a/preview/docs-ref-autogen/azure-keyvault-certificates/azure.keyvault.certificates.KeyVaultCertificateIdentifier.yml
+++ b/preview/docs-ref-autogen/azure-keyvault-certificates/azure.keyvault.certificates.KeyVaultCertificateIdentifier.yml
@@ -17,11 +17,12 @@ constructor:
examples:
- "Parse a certificate's ID<!--[!code-python[Main](s\\test_parse_id.py )]-->\n\n<!--\
\ literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [],\
- \ \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\52\\\
- \\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_parse_id.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
- \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n cert = client.get_certificate(cert_name)\n\
- \ parsed_certificate_id = KeyVaultCertificateIdentifier(cert.id)\n\n print(parsed_certificate_id.name)\n\
+ \ \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\\
+ 3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\
+ \\tests\\\\test_parse_id.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false}\
+ \ -->\n\n````python\n\n cert = client.get_certificate(cert_name)\n parsed_certificate_id\
+ \ = KeyVaultCertificateIdentifier(cert.id)\n\n print(parsed_certificate_id.name)\n\
\ print(parsed_certificate_id.vault_url)\n print(parsed_certificate_id.version)\n\
\ print(parsed_certificate_id.source_id)\n\n ````\n"
attributes:
diff --git a/preview/docs-ref-autogen/azure-keyvault-certificates/azure.keyvault.certificates.aio.CertificateClient.yml b/preview/docs-ref-autogen/azure-keyvault-certificates/azure.keyvault.certificates.aio.CertificateClient.yml
index 5285fc290776..bd09362136be 100644
--- a/preview/docs-ref-autogen/azure-keyvault-certificates/azure.keyvault.certificates.aio.CertificateClient.yml
+++ b/preview/docs-ref-autogen/azure-keyvault-certificates/azure.keyvault.certificates.aio.CertificateClient.yml
@@ -42,13 +42,14 @@ constructor:
examples:
- "Creates a new instance of the Certificate client<!--[!code-python[Main](s\\test_examples_certificates_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import DefaultAzureCredential\n from azure.keyvault.certificates.aio import\
- \ CertificateClient\n\n # Create a KeyVaultCertificate using default Azure credentials\n\
- \ credential = DefaultAzureCredential()\n certificate_client = CertificateClient(vault_url=vault_url,\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\
+ \\tests\\\\test_examples_certificates_async.py\", \"xml:space\": \"preserve\", \"\
+ force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\":\
+ \ 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio import\
+ \ DefaultAzureCredential\n from azure.keyvault.certificates.aio import CertificateClient\n\
+ \n # Create a KeyVaultCertificate using default Azure credentials\n credential\
+ \ = DefaultAzureCredential()\n certificate_client = CertificateClient(vault_url=vault_url,\
\ credential=credential)\n\n # the client and credential should be closed when\
\ no longer needed\n # (both are also async context managers)\n await certificate_client.close()\n\
\ await credential.close()\n\n ````\n"
@@ -87,8 +88,9 @@ methods:
examples:
- "Get a certificate backup<!--[!code-python[Main](s\\test_examples_certificates_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # backup certificate\n certificate_backup = await certificate_client.backup_certificate(cert_name)\n\
@@ -165,8 +167,9 @@ methods:
examples:
- "Create a certificate<!--[!code-python[Main](s\\test_examples_certificates_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.keyvault.certificates import CertificatePolicy, CertificateContentType,\
@@ -225,8 +228,9 @@ methods:
examples:
- "Create an issuer<!--[!code-python[Main](s\\test_examples_certificates_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.keyvault.certificates import AdministratorContact\n\n # First\
@@ -264,8 +268,9 @@ methods:
examples:
- "Delete a certificate<!--[!code-python[Main](s\\test_examples_certificates_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # delete a certificate\n deleted_certificate = await certificate_client.delete_certificate(cert_name)\n\
@@ -310,8 +315,9 @@ methods:
examples:
- "Delete contacts<!--[!code-python[Main](s\\test_examples_certificates_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n deleted_contacts = await certificate_client.delete_contacts()\n\n for deleted_contact\
@@ -339,8 +345,9 @@ methods:
examples:
- "Delete an issuer<!--[!code-python[Main](s\\test_examples_certificates_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n deleted_issuer = await certificate_client.delete_issuer(\"issuer1\")\n\n\
@@ -377,8 +384,9 @@ methods:
examples:
- "Get a certificate<!--[!code-python[Main](s\\test_examples_certificates_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # get the latest version of a certificate\n certificate = await certificate_client.get_certificate(cert_name)\n\
@@ -459,8 +467,9 @@ methods:
examples:
- "Get a certificate with a specific version<!--[!code-python[Main](s\\test_examples_certificates_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n certificate = await certificate_client.get_certificate_version(cert_name,\
@@ -480,14 +489,14 @@ methods:
examples:
- "Get contacts<!--[!code-python[Main](s\\test_examples_certificates_async.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n contacts = await certificate_client.get_contacts()\n\n # Loop through the\
- \ certificate contacts for this key vault.\n for contact in contacts:\n \
- \ print(contact.name)\n print(contact.email)\n print(contact.phone)\n\
- \n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\
+ \\tests\\\\test_examples_certificates_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n contacts = await certificate_client.get_contacts()\n\
+ \n # Loop through the certificate contacts for this key vault.\n for contact\
+ \ in contacts:\n print(contact.name)\n print(contact.email)\n \
+ \ print(contact.phone)\n\n ````\n"
- uid: azure.keyvault.certificates.aio.CertificateClient.get_deleted_certificate
name: get_deleted_certificate
summary: 'Get a deleted certificate. Possible only in a vault with soft-delete enabled.
@@ -517,8 +526,9 @@ methods:
examples:
- "Get a deleted certificate<!--[!code-python[Main](s\\test_examples_certificates_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # get a deleted certificate (requires soft-delete enabled for the vault)\n\
@@ -547,14 +557,15 @@ methods:
examples:
- "Get an issuer<!--[!code-python[Main](s\\test_examples_certificates_async.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n issuer = await certificate_client.get_issuer(\"issuer1\")\n\n print(issuer.name)\n\
- \ print(issuer.provider)\n print(issuer.account_id)\n\n for contact in issuer.admin_contacts:\n\
- \ print(contact.first_name)\n print(contact.last_name)\n print(contact.email)\n\
- \ print(contact.phone)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\
+ \\tests\\\\test_examples_certificates_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n issuer = await certificate_client.get_issuer(\"\
+ issuer1\")\n\n print(issuer.name)\n print(issuer.provider)\n print(issuer.account_id)\n\
+ \n for contact in issuer.admin_contacts:\n print(contact.first_name)\n\
+ \ print(contact.last_name)\n print(contact.email)\n print(contact.phone)\n\
+ \n ````\n"
- uid: azure.keyvault.certificates.aio.CertificateClient.import_certificate
name: import_certificate
summary: 'Import a certificate created externally. Requires certificates/import
@@ -645,8 +656,9 @@ methods:
examples:
- "List all the deleted certificates<!--[!code-python[Main](s\\test_examples_certificates_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # get an iterator of deleted certificates (requires soft-delete enabled for\
@@ -678,8 +690,9 @@ methods:
examples:
- "List all versions of a certificate<!--[!code-python[Main](s\\test_examples_certificates_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # get an iterator of all versions of a certificate\n certificate_versions\
@@ -711,8 +724,9 @@ methods:
examples:
- "List all certificates<!--[!code-python[Main](s\\test_examples_certificates_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # list certificates\n certificates = certificate_client.list_properties_of_certificates()\n\
@@ -735,8 +749,9 @@ methods:
examples:
- "List issuers of a vault<!--[!code-python[Main](s\\test_examples_certificates_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n issuers = certificate_client.list_properties_of_issuers()\n\n async for\
@@ -846,8 +861,9 @@ methods:
examples:
- "Recover a deleted certificate<!--[!code-python[Main](s\\test_examples_certificates_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # recover deleted certificate to its latest version (requires soft-delete\
@@ -883,8 +899,9 @@ methods:
examples:
- "Restore a certificate backup<!--[!code-python[Main](s\\test_examples_certificates_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # restores a certificate backup\n restored_certificate = await certificate_client.restore_certificate_backup(certificate_backup)\n\
@@ -911,8 +928,9 @@ methods:
examples:
- "Create contacts<!--[!code-python[Main](s\\test_examples_certificates_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.keyvault.certificates import CertificateContact\n\n # Create\
@@ -980,8 +998,9 @@ methods:
examples:
- "Update a certificate's attributes<!--[!code-python[Main](s\\test_examples_certificates_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 52\\\\azure-keyvault-certificates-4.8.0b2\\\\tests\\\\test_examples_certificates_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # update attributes of an existing certificate\n tags = {\"foo\": \"updated\
diff --git a/preview/docs-ref-autogen/azure-keyvault-keys/azure.keyvault.keys.KeyClient.yml b/preview/docs-ref-autogen/azure-keyvault-keys/azure.keyvault.keys.KeyClient.yml
index e845ddcff844..4e6ae4a9404a 100644
--- a/preview/docs-ref-autogen/azure-keyvault-keys/azure.keyvault.keys.KeyClient.yml
+++ b/preview/docs-ref-autogen/azure-keyvault-keys/azure.keyvault.keys.KeyClient.yml
@@ -43,13 +43,14 @@ constructor:
examples:
- "Create a new `KeyClient`<!--[!code-python[Main](s\\test_samples_keys.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
- \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import DefaultAzureCredential\n from azure.keyvault.keys import KeyClient\n\n\
- \ # Create a KeyClient using default Azure credentials\n credential = DefaultAzureCredential()\n\
- \ key_client = KeyClient(vault_url, credential)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ \\tests\\\\test_samples_keys.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.identity import DefaultAzureCredential\n\
+ \ from azure.keyvault.keys import KeyClient\n\n # Create a KeyClient using default\
+ \ Azure credentials\n credential = DefaultAzureCredential()\n key_client = KeyClient(vault_url,\
+ \ credential)\n\n ````\n"
methods:
- uid: azure.keyvault.keys.KeyClient.backup_key
name: backup_key
@@ -84,12 +85,13 @@ methods:
examples:
- "Get a key backup<!--[!code-python[Main](s\\test_samples_keys.py )]-->\n\n<!--\
\ literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [],\
- \ \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # backup key\n\
- \ key_backup = key_client.backup_key(key_name)\n\n # returns the raw bytes\
- \ of the backed up key\n print(key_backup)\n\n ````\n"
+ \ \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ \\tests\\\\test_samples_keys.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n # backup key\n key_backup = key_client.backup_key(key_name)\n\
+ \n # returns the raw bytes of the backed up key\n print(key_backup)\n\n \
+ \ ````\n"
- uid: azure.keyvault.keys.KeyClient.begin_delete_key
name: begin_delete_key
summary: 'Delete all versions of a key and its cryptographic material.
@@ -133,7 +135,8 @@ methods:
examples:
- "Delete a key<!--[!code-python[Main](s\\test_samples_keys.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
\\tests\\\\test_samples_keys.py\", \"xml:space\": \"preserve\", \"force\": false,\
\ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
: false} -->\n\n````python\n\n # delete a key\n deleted_key_poller = key_client.begin_delete_key(key_name)\n\
@@ -183,15 +186,15 @@ methods:
examples:
- "Recover a deleted key<!--[!code-python[Main](s\\test_samples_keys.py )]-->\n\n\
<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # recover\
- \ a deleted key to its latest version (requires soft-delete enabled for the vault)\n\
- \ recover_key_poller = key_client.begin_recover_deleted_key(key_name)\n recovered_key\
- \ = recover_key_poller.result()\n print(recovered_key.id)\n print(recovered_key.name)\n\
- \n # if you want to block until key is recovered server-side, call wait() on\
- \ the poller\n recover_key_poller.wait()\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ \\tests\\\\test_samples_keys.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n # recover a deleted key to its latest version\
+ \ (requires soft-delete enabled for the vault)\n recover_key_poller = key_client.begin_recover_deleted_key(key_name)\n\
+ \ recovered_key = recover_key_poller.result()\n print(recovered_key.id)\n\
+ \ print(recovered_key.name)\n\n # if you want to block until key is recovered\
+ \ server-side, call wait() on the poller\n recover_key_poller.wait()\n\n ````\n"
- uid: azure.keyvault.keys.KeyClient.create_ec_key
name: create_ec_key
summary: 'Create a new elliptic curve key or, if `name` is already in use, create
@@ -264,14 +267,15 @@ methods:
examples:
- "Create an elliptic curve key<!--[!code-python[Main](s\\test_samples_keys.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n key_curve\
- \ = \"P-256\"\n\n # create an EC (Elliptic curve) key with curve specification\n\
- \ # EC key can be created with default curve of 'P-256'\n ec_key = key_client.create_ec_key(key_name,\
- \ curve=key_curve)\n\n print(ec_key.id)\n print(ec_key.properties.version)\n\
- \ print(ec_key.key_type)\n print(ec_key.key.crv)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ \\tests\\\\test_samples_keys.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n key_curve = \"P-256\"\n\n # create an EC (Elliptic\
+ \ curve) key with curve specification\n # EC key can be created with default\
+ \ curve of 'P-256'\n ec_key = key_client.create_ec_key(key_name, curve=key_curve)\n\
+ \n print(ec_key.id)\n print(ec_key.properties.version)\n print(ec_key.key_type)\n\
+ \ print(ec_key.key.crv)\n\n ````\n"
- uid: azure.keyvault.keys.KeyClient.create_key
name: create_key
summary: 'Create a key or, if `name` is already in use, create a new version of
@@ -362,7 +366,8 @@ methods:
examples:
- "Create a key<!--[!code-python[Main](s\\test_samples_keys.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
\\tests\\\\test_samples_keys.py\", \"xml:space\": \"preserve\", \"force\": false,\
\ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
: false} -->\n\n````python\n\n from dateutil import parser as date_parse\n\n\
@@ -441,12 +446,13 @@ methods:
examples:
- "Create an octet sequence (symmetric) key<!--[!code-python[Main](s\\test_samples_keys.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n key = key_client.create_oct_key(key_name, size=256, hardware_protected=True)\n\
- \n print(key.id)\n print(key.name)\n print(key.key_type)\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n key = key_client.create_oct_key(key_name,\
+ \ size=256, hardware_protected=True)\n\n print(key.id)\n print(key.name)\n\
+ \ print(key.key_type)\n\n ````\n"
- uid: azure.keyvault.keys.KeyClient.create_rsa_key
name: create_rsa_key
summary: 'Create a new RSA key or, if `name` is already in use, create a new version
@@ -524,7 +530,8 @@ methods:
examples:
- "Create RSA key<!--[!code-python[Main](s\\test_samples_keys.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
\\tests\\\\test_samples_keys.py\", \"xml:space\": \"preserve\", \"force\": false,\
\ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
: false} -->\n\n````python\n\n key_size = 2048\n key_ops = [\"encrypt\", \"\
@@ -580,15 +587,15 @@ methods:
examples:
- "Get a deleted key<!--[!code-python[Main](s\\test_samples_keys.py )]-->\n\n<!--\
\ literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [],\
- \ \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # get a deleted\
- \ key (requires soft-delete enabled for the vault)\n deleted_key = key_client.get_deleted_key(key_name)\n\
- \ print(deleted_key.name)\n\n # if the vault has soft-delete enabled, the\
- \ key's deleted_date\n # scheduled purge date and recovery id are set\n print(deleted_key.deleted_date)\n\
- \ print(deleted_key.scheduled_purge_date)\n print(deleted_key.recovery_id)\n\
- \n ````\n"
+ \ \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ \\tests\\\\test_samples_keys.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n # get a deleted key (requires soft-delete enabled\
+ \ for the vault)\n deleted_key = key_client.get_deleted_key(key_name)\n print(deleted_key.name)\n\
+ \n # if the vault has soft-delete enabled, the key's deleted_date\n # scheduled\
+ \ purge date and recovery id are set\n print(deleted_key.deleted_date)\n print(deleted_key.scheduled_purge_date)\n\
+ \ print(deleted_key.recovery_id)\n\n ````\n"
- uid: azure.keyvault.keys.KeyClient.get_key
name: get_key
summary: 'Get a key''s attributes and, if it''s an asymmetric key, its public material.
@@ -622,7 +629,8 @@ methods:
examples:
- "Get a key<!--[!code-python[Main](s\\test_samples_keys.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
\\tests\\\\test_samples_keys.py\", \"xml:space\": \"preserve\", \"force\": false,\
\ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
: false} -->\n\n````python\n\n # get the latest version of a key\n key = key_client.get_key(key_name)\n\
@@ -668,7 +676,8 @@ methods:
examples:
- "Get random bytes<!--[!code-python[Main](s\\test_key_client.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
\\tests\\\\test_key_client.py\", \"xml:space\": \"preserve\", \"force\": false,\
\ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
: false} -->\n\n````python\n\n # get eight random bytes from a managed HSM\n\
@@ -748,14 +757,15 @@ methods:
examples:
- "List all the deleted keys<!--[!code-python[Main](s\\test_samples_keys.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # get an iterator\
- \ of deleted keys (requires soft-delete enabled for the vault)\n deleted_keys\
- \ = key_client.list_deleted_keys()\n\n for key in deleted_keys:\n print(key.id)\n\
- \ print(key.name)\n print(key.scheduled_purge_date)\n print(key.recovery_id)\n\
- \ print(key.deleted_date)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ \\tests\\\\test_samples_keys.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n # get an iterator of deleted keys (requires soft-delete\
+ \ enabled for the vault)\n deleted_keys = key_client.list_deleted_keys()\n\n\
+ \ for key in deleted_keys:\n print(key.id)\n print(key.name)\n \
+ \ print(key.scheduled_purge_date)\n print(key.recovery_id)\n \
+ \ print(key.deleted_date)\n\n ````\n"
- uid: azure.keyvault.keys.KeyClient.list_properties_of_key_versions
name: list_properties_of_key_versions
summary: 'List the identifiers and properties of a key''s versions.
@@ -776,13 +786,13 @@ methods:
examples:
- "List all versions of a key<!--[!code-python[Main](s\\test_samples_keys.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # get an iterator\
- \ of a key's versions\n key_versions = key_client.list_properties_of_key_versions(\"\
- key-name\")\n\n for key in key_versions:\n print(key.id)\n print(key.name)\n\
- \n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ \\tests\\\\test_samples_keys.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n # get an iterator of a key's versions\n key_versions\
+ \ = key_client.list_properties_of_key_versions(\"key-name\")\n\n for key in\
+ \ key_versions:\n print(key.id)\n print(key.name)\n\n ````\n"
- uid: azure.keyvault.keys.KeyClient.list_properties_of_keys
name: list_properties_of_keys
summary: 'List identifiers and properties of all keys in the vault.
@@ -798,7 +808,8 @@ methods:
examples:
- "List all keys<!--[!code-python[Main](s\\test_samples_keys.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
\\tests\\\\test_samples_keys.py\", \"xml:space\": \"preserve\", \"force\": false,\
\ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
: false} -->\n\n````python\n\n # get an iterator of keys\n keys = key_client.list_properties_of_keys()\n\
@@ -917,11 +928,11 @@ methods:
examples:
- "Restore a key backup<!--[!code-python[Main](s\\test_samples_keys.py )]-->\n\n\
<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # restore\
- \ a key backup\n restored_key = key_client.restore_key_backup(key_backup)\n\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ \\tests\\\\test_samples_keys.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n # restore a key backup\n restored_key = key_client.restore_key_backup(key_backup)\n\
\ print(restored_key.id)\n print(restored_key.properties.version)\n\n ````\n"
- uid: azure.keyvault.keys.KeyClient.rotate_key
name: rotate_key
@@ -1007,15 +1018,16 @@ methods:
examples:
- "Update a key's attributes<!--[!code-python[Main](s\\test_samples_keys.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # update attributes\
- \ of an existing key\n expires_on = date_parse.parse(\"2050-01-02T08:00:00.000Z\"\
- )\n tags = {\"foo\": \"updated tag\"}\n updated_key = key_client.update_key_properties(key.name,\
- \ expires_on=expires_on, tags=tags)\n\n print(updated_key.properties.version)\n\
- \ print(updated_key.properties.updated_on)\n print(updated_key.properties.expires_on)\n\
- \ print(updated_key.properties.tags)\n print(key.key_type)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ \\tests\\\\test_samples_keys.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n # update attributes of an existing key\n expires_on\
+ \ = date_parse.parse(\"2050-01-02T08:00:00.000Z\")\n tags = {\"foo\": \"updated\
+ \ tag\"}\n updated_key = key_client.update_key_properties(key.name, expires_on=expires_on,\
+ \ tags=tags)\n\n print(updated_key.properties.version)\n print(updated_key.properties.updated_on)\n\
+ \ print(updated_key.properties.expires_on)\n print(updated_key.properties.tags)\n\
+ \ print(key.key_type)\n\n ````\n"
- uid: azure.keyvault.keys.KeyClient.update_key_rotation_policy
name: update_key_rotation_policy
summary: 'Updates the rotation policy of a Key Vault key.
diff --git a/preview/docs-ref-autogen/azure-keyvault-keys/azure.keyvault.keys.KeyVaultKeyIdentifier.yml b/preview/docs-ref-autogen/azure-keyvault-keys/azure.keyvault.keys.KeyVaultKeyIdentifier.yml
index 9210b1cc1fe4..79a6a70f0031 100644
--- a/preview/docs-ref-autogen/azure-keyvault-keys/azure.keyvault.keys.KeyVaultKeyIdentifier.yml
+++ b/preview/docs-ref-autogen/azure-keyvault-keys/azure.keyvault.keys.KeyVaultKeyIdentifier.yml
@@ -17,7 +17,8 @@ constructor:
examples:
- "Parse a key's ID<!--[!code-python[Main](s\\test_parse_id.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\":\
- \ [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ \ [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
\\tests\\\\test_parse_id.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false}\
\ -->\n\n````python\n\n key = client.get_key(key_name)\n parsed_key_id = KeyVaultKeyIdentifier(key.id)\n\
diff --git a/preview/docs-ref-autogen/azure-keyvault-keys/azure.keyvault.keys.aio.KeyClient.yml b/preview/docs-ref-autogen/azure-keyvault-keys/azure.keyvault.keys.aio.KeyClient.yml
index 79a15df84f3e..1ed937ff28f8 100644
--- a/preview/docs-ref-autogen/azure-keyvault-keys/azure.keyvault.keys.aio.KeyClient.yml
+++ b/preview/docs-ref-autogen/azure-keyvault-keys/azure.keyvault.keys.aio.KeyClient.yml
@@ -43,15 +43,16 @@ constructor:
examples:
- "Create a new `KeyClient`<!--[!code-python[Main](s\\test_samples_keys_async.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
- \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import DefaultAzureCredential\n from azure.keyvault.keys.aio import KeyClient\n\
- \n # Create a KeyClient using default Azure credentials\n credential = DefaultAzureCredential()\n\
- \ key_client = KeyClient(vault_url, credential)\n\n # the client and credential\
- \ should be closed when no longer needed\n # (both are also async context managers)\n\
- \ await key_client.close()\n await credential.close()\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ \\tests\\\\test_samples_keys_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.identity.aio import DefaultAzureCredential\n\
+ \ from azure.keyvault.keys.aio import KeyClient\n\n # Create a KeyClient using\
+ \ default Azure credentials\n credential = DefaultAzureCredential()\n key_client\
+ \ = KeyClient(vault_url, credential)\n\n # the client and credential should be\
+ \ closed when no longer needed\n # (both are also async context managers)\n \
+ \ await key_client.close()\n await credential.close()\n\n ````\n"
methods:
- uid: azure.keyvault.keys.aio.KeyClient.backup_key
name: backup_key
@@ -84,12 +85,13 @@ methods:
examples:
- "Get a key backup<!--[!code-python[Main](s\\test_samples_keys_async.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys_async.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # backup key\n key_backup = await key_client.backup_key(key_name)\n\n \
- \ # returns the raw bytes of the backup\n print(key_backup)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ \\tests\\\\test_samples_keys_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # backup key\n key_backup = await\
+ \ key_client.backup_key(key_name)\n\n # returns the raw bytes of the backup\n\
+ \ print(key_backup)\n\n ````\n"
- uid: azure.keyvault.keys.aio.KeyClient.create_ec_key
name: create_ec_key
summary: 'Create a new elliptic curve key or, if `name` is already in use, create
@@ -162,14 +164,14 @@ methods:
examples:
- "Create an elliptic curve key<!--[!code-python[Main](s\\test_samples_keys_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # create an elliptic curve (ec) key\n key_curve = \"P-256\"\n ec_key\
- \ = await key_client.create_ec_key(key_name, curve=key_curve)\n\n print(ec_key.id)\n\
- \ print(ec_key.name)\n print(ec_key.key_type)\n print(ec_key.key.crv)\n\n\
- \ ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys_async.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # create an\
+ \ elliptic curve (ec) key\n key_curve = \"P-256\"\n ec_key = await key_client.create_ec_key(key_name,\
+ \ curve=key_curve)\n\n print(ec_key.id)\n print(ec_key.name)\n print(ec_key.key_type)\n\
+ \ print(ec_key.key.crv)\n\n ````\n"
- uid: azure.keyvault.keys.aio.KeyClient.create_key
name: create_key
summary: 'Create a key or, if `name` is already in use, create a new version of
@@ -260,16 +262,16 @@ methods:
examples:
- "Create a key<!--[!code-python[Main](s\\test_samples_keys_async.py )]-->\n\n<!--\
\ literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [],\
- \ \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys_async.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from dateutil\
- \ import parser as date_parse\n\n key_size = 2048\n key_ops = [\"encrypt\"\
- , \"decrypt\", \"sign\", \"verify\", \"wrapKey\", \"unwrapKey\"]\n expires_on\
- \ = date_parse.parse(\"2050-02-02T08:00:00.000Z\")\n\n # create a key with optional\
- \ arguments\n key = await key_client.create_key(\n key_name, KeyType.rsa,\
- \ size=key_size, key_operations=key_ops, expires_on=expires_on\n )\n\n print(key.id)\n\
- \ print(key.name)\n print(key.key_type)\n print(key.properties.enabled)\n\
+ \ \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ \\tests\\\\test_samples_keys_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from dateutil import parser as date_parse\n\
+ \n key_size = 2048\n key_ops = [\"encrypt\", \"decrypt\", \"sign\", \"verify\"\
+ , \"wrapKey\", \"unwrapKey\"]\n expires_on = date_parse.parse(\"2050-02-02T08:00:00.000Z\"\
+ )\n\n # create a key with optional arguments\n key = await key_client.create_key(\n\
+ \ key_name, KeyType.rsa, size=key_size, key_operations=key_ops, expires_on=expires_on\n\
+ \ )\n\n print(key.id)\n print(key.name)\n print(key.key_type)\n print(key.properties.enabled)\n\
\ print(key.properties.expires_on)\n\n ````\n"
- uid: azure.keyvault.keys.aio.KeyClient.create_oct_key
name: create_oct_key
@@ -342,12 +344,13 @@ methods:
examples:
- "Create an octet sequence (symmetric) key<!--[!code-python[Main](s\\test_samples_keys_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n key = await key_client.create_oct_key(key_name, size=256, hardware_protected=True)\n\
- \n print(key.id)\n print(key.name)\n print(key.key_type)\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys_async.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n key = await\
+ \ key_client.create_oct_key(key_name, size=256, hardware_protected=True)\n\n \
+ \ print(key.id)\n print(key.name)\n print(key.key_type)\n\n ````\n"
- uid: azure.keyvault.keys.aio.KeyClient.create_rsa_key
name: create_rsa_key
summary: 'Create a new RSA key or, if `name` is already in use, create a new version
@@ -425,13 +428,14 @@ methods:
examples:
- "Create RSA key<!--[!code-python[Main](s\\test_samples_keys_async.py )]-->\n\n\
<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys_async.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # create an rsa key in a hardware security module\n key = await key_client.create_rsa_key(key_name,\
- \ hardware_protected=True, size=2048)\n\n print(key.id)\n print(key.name)\n\
- \ print(key.key_type)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ \\tests\\\\test_samples_keys_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # create an rsa key in a hardware security\
+ \ module\n key = await key_client.create_rsa_key(key_name, hardware_protected=True,\
+ \ size=2048)\n\n print(key.id)\n print(key.name)\n print(key.key_type)\n\
+ \n ````\n"
- uid: azure.keyvault.keys.aio.KeyClient.delete_key
name: delete_key
summary: 'Delete all versions of a key and its cryptographic material.
@@ -460,15 +464,15 @@ methods:
examples:
- "Delete a key<!--[!code-python[Main](s\\test_samples_keys_async.py )]-->\n\n<!--\
\ literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [],\
- \ \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys_async.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # delete a\
- \ key\n deleted_key = await key_client.delete_key(key_name)\n\n print(deleted_key.name)\n\
- \n # if the vault has soft-delete enabled, the key's\n # scheduled purge date,\
- \ deleted_date and recovery id are set\n print(deleted_key.deleted_date)\n \
- \ print(deleted_key.scheduled_purge_date)\n print(deleted_key.recovery_id)\n\
- \n ````\n"
+ \ \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ \\tests\\\\test_samples_keys_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # delete a key\n deleted_key = await\
+ \ key_client.delete_key(key_name)\n\n print(deleted_key.name)\n\n # if the\
+ \ vault has soft-delete enabled, the key's\n # scheduled purge date, deleted_date\
+ \ and recovery id are set\n print(deleted_key.deleted_date)\n print(deleted_key.scheduled_purge_date)\n\
+ \ print(deleted_key.recovery_id)\n\n ````\n"
- uid: azure.keyvault.keys.aio.KeyClient.get_cryptography_client
name: get_cryptography_client
summary: Gets a <xref:azure.keyvault.keys.crypto.aio.CryptographyClient> for the
@@ -516,13 +520,13 @@ methods:
examples:
- "Get a deleted key<!--[!code-python[Main](s\\test_samples_keys_async.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys_async.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # get a deleted key (requires soft-delete enabled for the vault)\n deleted_key\
- \ = await key_client.get_deleted_key(key_name)\n print(deleted_key.name)\n\n\
- \ ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ \\tests\\\\test_samples_keys_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # get a deleted key (requires soft-delete\
+ \ enabled for the vault)\n deleted_key = await key_client.get_deleted_key(key_name)\n\
+ \ print(deleted_key.name)\n\n ````\n"
- uid: azure.keyvault.keys.aio.KeyClient.get_key
name: get_key
summary: 'Get a key''s attributes and, if it''s an asymmetric key, its public material.
@@ -556,15 +560,15 @@ methods:
examples:
- "Get a key<!--[!code-python[Main](s\\test_samples_keys_async.py )]-->\n\n<!--\
\ literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [],\
- \ \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys_async.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # get the\
- \ latest version of a key\n key = await key_client.get_key(key_name)\n\n #\
- \ alternatively, specify a version\n key_version = key.properties.version\n\
- \ key = await key_client.get_key(key_name, key_version)\n\n print(key.id)\n\
- \ print(key.name)\n print(key.properties.version)\n print(key.key_type)\n\
- \ print(key.properties.vault_url)\n\n ````\n"
+ \ \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ \\tests\\\\test_samples_keys_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # get the latest version of a key\n\
+ \ key = await key_client.get_key(key_name)\n\n # alternatively, specify a\
+ \ version\n key_version = key.properties.version\n key = await key_client.get_key(key_name,\
+ \ key_version)\n\n print(key.id)\n print(key.name)\n print(key.properties.version)\n\
+ \ print(key.key_type)\n print(key.properties.vault_url)\n\n ````\n"
- uid: azure.keyvault.keys.aio.KeyClient.get_key_rotation_policy
name: get_key_rotation_policy
summary: Get the rotation policy of a Key Vault key.
@@ -603,7 +607,8 @@ methods:
examples:
- "Get random bytes<!--[!code-python[Main](s\\test_keys_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
\\tests\\\\test_keys_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
\ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
: false} -->\n\n````python\n\n # get eight random bytes from a managed HSM\n\
@@ -683,13 +688,14 @@ methods:
examples:
- "List all the deleted keys<!--[!code-python[Main](s\\test_samples_keys_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # get an iterator of deleted keys (requires soft-delete enabled for the vault)\n\
- \ deleted_keys = key_client.list_deleted_keys()\n\n async for key in deleted_keys:\n\
- \ print(key.id)\n print(key.name)\n print(key.scheduled_purge_date)\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys_async.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # get an iterator\
+ \ of deleted keys (requires soft-delete enabled for the vault)\n deleted_keys\
+ \ = key_client.list_deleted_keys()\n\n async for key in deleted_keys:\n \
+ \ print(key.id)\n print(key.name)\n print(key.scheduled_purge_date)\n\
\ print(key.recovery_id)\n print(key.deleted_date)\n\n ````\n"
- uid: azure.keyvault.keys.aio.KeyClient.list_properties_of_key_versions
name: list_properties_of_key_versions
@@ -711,11 +717,12 @@ methods:
examples:
- "List all versions of a key<!--[!code-python[Main](s\\test_samples_keys_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # get an iterator of all versions of a key\n key_versions = key_client.list_properties_of_key_versions(\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys_async.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # get an iterator\
+ \ of all versions of a key\n key_versions = key_client.list_properties_of_key_versions(\"\
key-name\")\n\n async for key in key_versions:\n print(key.id)\n \
\ print(key.updated_on)\n print(key.properties.version)\n print(key.expires_on)\n\
\n ````\n"
@@ -734,13 +741,14 @@ methods:
examples:
- "List all keys<!--[!code-python[Main](s\\test_samples_keys_async.py )]-->\n\n\
<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys_async.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # list keys\n keys = key_client.list_properties_of_keys()\n\n async for\
- \ key in keys:\n print(key.id)\n print(key.created_on)\n print(key.name)\n\
- \ print(key.updated_on)\n print(key.enabled)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ \\tests\\\\test_samples_keys_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # list keys\n keys = key_client.list_properties_of_keys()\n\
+ \n async for key in keys:\n print(key.id)\n print(key.created_on)\n\
+ \ print(key.name)\n print(key.updated_on)\n print(key.enabled)\n\
+ \n ````\n"
- uid: azure.keyvault.keys.aio.KeyClient.purge_deleted_key
name: purge_deleted_key
summary: 'Permanently deletes a deleted key. Only possible in a vault with soft-delete
@@ -806,13 +814,14 @@ methods:
examples:
- "Recover a deleted key<!--[!code-python[Main](s\\test_samples_keys_async.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys_async.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # recover deleted key to its latest version (requires soft-delete enabled\
- \ for the vault)\n recovered_key = await key_client.recover_deleted_key(key_name)\n\
- \ print(recovered_key.id)\n print(recovered_key.name)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ \\tests\\\\test_samples_keys_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # recover deleted key to its latest\
+ \ version (requires soft-delete enabled for the vault)\n recovered_key = await\
+ \ key_client.recover_deleted_key(key_name)\n print(recovered_key.id)\n print(recovered_key.name)\n\
+ \n ````\n"
- uid: azure.keyvault.keys.aio.KeyClient.release_key
name: release_key
summary: 'Releases a key.
@@ -889,13 +898,14 @@ methods:
examples:
- "Restore a key backup<!--[!code-python[Main](s\\test_samples_keys_async.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys_async.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # restores a backup\n restored_key = await key_client.restore_key_backup(key_backup)\n\
- \ print(restored_key.id)\n print(restored_key.name)\n print(restored_key.properties.version)\n\
- \n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ \\tests\\\\test_samples_keys_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # restores a backup\n restored_key\
+ \ = await key_client.restore_key_backup(key_backup)\n print(restored_key.id)\n\
+ \ print(restored_key.name)\n print(restored_key.properties.version)\n\n \
+ \ ````\n"
- uid: azure.keyvault.keys.aio.KeyClient.rotate_key
name: rotate_key
summary: 'Rotate the key based on the key policy by generating a new version of
@@ -980,16 +990,16 @@ methods:
examples:
- "Update a key's attributes<!--[!code-python[Main](s\\test_samples_keys_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # update attributes of an existing key\n expires_on = date_parse.parse(\"\
- 2050-01-02T08:00:00.000Z\")\n tags = {\"foo\": \"updated tag\"}\n updated_key\
- \ = await key_client.update_key_properties(key.name, expires_on=expires_on, tags=tags)\n\
- \n print(updated_key.properties.version)\n print(updated_key.properties.updated_on)\n\
- \ print(updated_key.properties.expires_on)\n print(updated_key.properties.tags)\n\
- \ print(updated_key.key_type)\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_samples_keys_async.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # update attributes\
+ \ of an existing key\n expires_on = date_parse.parse(\"2050-01-02T08:00:00.000Z\"\
+ )\n tags = {\"foo\": \"updated tag\"}\n updated_key = await key_client.update_key_properties(key.name,\
+ \ expires_on=expires_on, tags=tags)\n\n print(updated_key.properties.version)\n\
+ \ print(updated_key.properties.updated_on)\n print(updated_key.properties.expires_on)\n\
+ \ print(updated_key.properties.tags)\n print(updated_key.key_type)\n\n ````\n"
- uid: azure.keyvault.keys.aio.KeyClient.update_key_rotation_policy
name: update_key_rotation_policy
summary: 'Updates the rotation policy of a Key Vault key.
diff --git a/preview/docs-ref-autogen/azure-keyvault-keys/azure.keyvault.keys.crypto.CryptographyClient.yml b/preview/docs-ref-autogen/azure-keyvault-keys/azure.keyvault.keys.crypto.CryptographyClient.yml
index 88abc2219cd2..4f3785315cae 100644
--- a/preview/docs-ref-autogen/azure-keyvault-keys/azure.keyvault.keys.crypto.CryptographyClient.yml
+++ b/preview/docs-ref-autogen/azure-keyvault-keys/azure.keyvault.keys.crypto.CryptographyClient.yml
@@ -11,13 +11,14 @@ summary: "Performs cryptographic operations using Azure Key Vault keys.\n\nThis
\ is unavailable, cryptographic operations are performed\nby the Key Vault service.\n\
\nCreate a CryptographyClient<!--[!code-python[Main](s\\test_examples_crypto.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_examples_crypto.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
- \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # create a CryptographyClient\
- \ using a KeyVaultKey instance\n key = key_client.get_key(key_name)\n crypto_client\
- \ = CryptographyClient(key, credential)\n\n # or a key's id, which must include\
- \ a version\n key_id = \"https://<your vault>.vault.azure.net/keys/<key name>/fe4fdcab688c479a9aa80f01ffeac26\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ \\tests\\\\test_examples_crypto.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n # create a CryptographyClient using a KeyVaultKey\
+ \ instance\n key = key_client.get_key(key_name)\n crypto_client = CryptographyClient(key,\
+ \ credential)\n\n # or a key's id, which must include a version\n key_id = \"\
+ https://<your vault>.vault.azure.net/keys/<key name>/fe4fdcab688c479a9aa80f01ffeac26\"\
\n crypto_client = CryptographyClient(key_id, credential)\n\n ````"
constructor:
syntax: 'CryptographyClient(key: KeyVaultKey | str, credential: TokenCredential,
@@ -60,12 +61,13 @@ methods:
\ the keys/decrypt permission. This method decrypts only a single block of data,\
\ whose size depends on\nthe key and encryption algorithm.\n\nDecrypt bytes<!--[!code-python[Main](s\\\
test_examples_crypto.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\
- \\test_examples_crypto.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
- language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.keyvault.keys.crypto import EncryptionAlgorithm\n\
- \n result = client.decrypt(EncryptionAlgorithm.rsa_oaep, ciphertext)\n print(result.plaintext)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_examples_crypto.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.keyvault.keys.crypto import EncryptionAlgorithm\n\n result =\
+ \ client.decrypt(EncryptionAlgorithm.rsa_oaep, ciphertext)\n print(result.plaintext)\n\
\n ````"
signature: 'decrypt(algorithm: EncryptionAlgorithm, ciphertext: bytes, **kwargs)
-> DecryptResult'
@@ -120,15 +122,15 @@ methods:
\ This method encrypts only a single block of data, whose size depends on\nthe\
\ key and encryption algorithm.\n\nEncrypt bytes<!--[!code-python[Main](s\\test_examples_crypto.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_examples_crypto.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.keyvault.keys.crypto import EncryptionAlgorithm\n\n # the result\
- \ holds the ciphertext and identifies the encryption key and algorithm used\n\
- \ result = client.encrypt(EncryptionAlgorithm.rsa_oaep, b\"plaintext\")\n \
- \ ciphertext = result.ciphertext\n print(result.key_id)\n print(result.algorithm)\n\
- \n ````"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_examples_crypto.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.keyvault.keys.crypto\
+ \ import EncryptionAlgorithm\n\n # the result holds the ciphertext and identifies\
+ \ the encryption key and algorithm used\n result = client.encrypt(EncryptionAlgorithm.rsa_oaep,\
+ \ b\"plaintext\")\n ciphertext = result.ciphertext\n print(result.key_id)\n\
+ \ print(result.algorithm)\n\n ````"
signature: 'encrypt(algorithm: EncryptionAlgorithm, plaintext: bytes, **kwargs)
-> EncryptResult'
parameters:
@@ -191,13 +193,14 @@ methods:
summary: "Create a signature from a digest using the client's key.\n\nRequires the\
\ keys/sign permission.\n\nSign bytes<!--[!code-python[Main](s\\test_examples_crypto.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_examples_crypto.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n import hashlib\n\n from azure.keyvault.keys.crypto import SignatureAlgorithm\n\
- \n digest = hashlib.sha256(b\"plaintext\").digest()\n\n # sign returns the\
- \ signature and the metadata required to verify it\n result = client.sign(SignatureAlgorithm.rs256,\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_examples_crypto.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import hashlib\n\
+ \n from azure.keyvault.keys.crypto import SignatureAlgorithm\n\n digest =\
+ \ hashlib.sha256(b\"plaintext\").digest()\n\n # sign returns the signature and\
+ \ the metadata required to verify it\n result = client.sign(SignatureAlgorithm.rs256,\
\ digest)\n print(result.key_id)\n print(result.algorithm)\n signature =\
\ result.signature\n\n ````"
signature: 'sign(algorithm: SignatureAlgorithm, digest: bytes, **kwargs) -> SignResult'
@@ -220,11 +223,12 @@ methods:
summary: "Unwrap a key previously wrapped with the client's key.\n\nRequires the\
\ keys/unwrapKey permission.\n\nUnwrap a key<!--[!code-python[Main](s\\test_examples_crypto.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_examples_crypto.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.keyvault.keys.crypto import KeyWrapAlgorithm\n\n result = client.unwrap_key(KeyWrapAlgorithm.rsa_oaep,\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_examples_crypto.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.keyvault.keys.crypto\
+ \ import KeyWrapAlgorithm\n\n result = client.unwrap_key(KeyWrapAlgorithm.rsa_oaep,\
\ encrypted_key)\n key = result.key\n\n ````"
signature: 'unwrap_key(algorithm: KeyWrapAlgorithm, encrypted_key: bytes, **kwargs)
-> UnwrapResult'
@@ -247,13 +251,13 @@ methods:
summary: "Verify a signature using the client's key.\n\nRequires the keys/verify\
\ permission.\n\nVerify a signature<!--[!code-python[Main](s\\test_examples_crypto.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_examples_crypto.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.keyvault.keys.crypto import SignatureAlgorithm\n\n result =\
- \ client.verify(SignatureAlgorithm.rs256, digest, signature)\n assert result.is_valid\n\
- \n ````"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_examples_crypto.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.keyvault.keys.crypto\
+ \ import SignatureAlgorithm\n\n result = client.verify(SignatureAlgorithm.rs256,\
+ \ digest, signature)\n assert result.is_valid\n\n ````"
signature: 'verify(algorithm: SignatureAlgorithm, digest: bytes, signature: bytes,
**kwargs) -> VerifyResult'
parameters:
@@ -283,7 +287,8 @@ methods:
summary: "Wrap a key with the client's key.\n\nRequires the keys/wrapKey permission.\n\
\nWrap a key<!--[!code-python[Main](s\\test_examples_crypto.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
\\tests\\\\test_examples_crypto.py\", \"xml:space\": \"preserve\", \"force\":\
\ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
linenos\": false} -->\n\n````python\n\n from azure.keyvault.keys.crypto import\
diff --git a/preview/docs-ref-autogen/azure-keyvault-keys/azure.keyvault.keys.crypto.aio.CryptographyClient.yml b/preview/docs-ref-autogen/azure-keyvault-keys/azure.keyvault.keys.crypto.aio.CryptographyClient.yml
index f298550a9c14..c8986fb73cdf 100644
--- a/preview/docs-ref-autogen/azure-keyvault-keys/azure.keyvault.keys.crypto.aio.CryptographyClient.yml
+++ b/preview/docs-ref-autogen/azure-keyvault-keys/azure.keyvault.keys.crypto.aio.CryptographyClient.yml
@@ -11,17 +11,17 @@ summary: "Performs cryptographic operations using Azure Key Vault keys.\n\nThis
\ is unavailable, cryptographic operations are performed\nby the Key Vault service.\n\
\nCreate a CryptographyClient<!--[!code-python[Main](s\\test_examples_crypto_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_examples_crypto_async.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # create a CryptographyClient\
- \ using a KeyVaultKey instance\n key = await key_client.get_key(key_name)\n \
- \ crypto_client = CryptographyClient(key, credential)\n\n # or a key's id, which\
- \ must include a version\n key_id = \"https://<your vault>.vault.azure.net/keys/<key\
- \ name>/fe4fdcab688c479a9aa80f01ffeac26\"\n crypto_client = CryptographyClient(key_id,\
- \ credential)\n\n # the client and credential should be closed when no longer\
- \ needed\n # (both are also async context managers)\n await crypto_client.close()\n\
- \ await credential.close()\n\n ````"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ \\tests\\\\test_examples_crypto_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # create a CryptographyClient using a\
+ \ KeyVaultKey instance\n key = await key_client.get_key(key_name)\n crypto_client\
+ \ = CryptographyClient(key, credential)\n\n # or a key's id, which must include\
+ \ a version\n key_id = \"https://<your vault>.vault.azure.net/keys/<key name>/fe4fdcab688c479a9aa80f01ffeac26\"\
+ \n crypto_client = CryptographyClient(key_id, credential)\n\n # the client and\
+ \ credential should be closed when no longer needed\n # (both are also async context\
+ \ managers)\n await crypto_client.close()\n await credential.close()\n\n ````"
constructor:
syntax: 'CryptographyClient(key: KeyVaultKey | str, credential: AsyncTokenCredential,
**kwargs)'
@@ -63,13 +63,14 @@ methods:
\ the keys/decrypt permission. This method decrypts only a single block of data,\
\ whose size depends on\nthe key and encryption algorithm.\n\nDecrypt bytes<!--[!code-python[Main](s\\\
test_examples_crypto_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\
- \\test_examples_crypto_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.keyvault.keys.crypto import EncryptionAlgorithm\n\
- \n result = await client.decrypt(EncryptionAlgorithm.rsa_oaep, ciphertext)\n\
- \ print(result.plaintext)\n\n ````"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_examples_crypto_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.keyvault.keys.crypto import EncryptionAlgorithm\n\n result =\
+ \ await client.decrypt(EncryptionAlgorithm.rsa_oaep, ciphertext)\n print(result.plaintext)\n\
+ \n ````"
signature: 'async decrypt(algorithm: EncryptionAlgorithm, ciphertext: bytes, **kwargs)
-> DecryptResult'
parameters:
@@ -123,8 +124,9 @@ methods:
\ This method encrypts only a single block of data, whose size depends on\nthe\
\ key and encryption algorithm.\n\nEncrypt bytes<!--[!code-python[Main](s\\test_examples_crypto_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_examples_crypto_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_examples_crypto_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.keyvault.keys.crypto import EncryptionAlgorithm\n\n # the result\
@@ -194,8 +196,9 @@ methods:
summary: "Create a signature from a digest using the client's key.\n\nRequires the\
\ keys/sign permission.\n\nSign bytes<!--[!code-python[Main](s\\test_examples_crypto_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_examples_crypto_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_examples_crypto_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n import hashlib\n\n from azure.keyvault.keys.crypto import SignatureAlgorithm\n\
@@ -224,8 +227,9 @@ methods:
summary: "Unwrap a key previously wrapped with the client's key.\n\nRequires the\
\ keys/unwrapKey permission.\n\nUnwrap a key<!--[!code-python[Main](s\\test_examples_crypto_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_examples_crypto_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_examples_crypto_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.keyvault.keys.crypto import KeyWrapAlgorithm\n\n result = await\
@@ -251,8 +255,9 @@ methods:
summary: "Verify a signature using the client's key.\n\nRequires the keys/verify\
\ permission.\n\nVerify a signature<!--[!code-python[Main](s\\test_examples_crypto_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_examples_crypto_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_examples_crypto_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.keyvault.keys.crypto import SignatureAlgorithm\n\n verified\
@@ -287,14 +292,15 @@ methods:
summary: "Wrap a key with the client's key.\n\nRequires the keys/wrapKey permission.\n\
\nWrap a key<!--[!code-python[Main](s\\test_examples_crypto_async.py )]-->\n\n\
<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\53\\\\azure-keyvault-keys-4.9.0b1\\\\tests\\\\test_examples_crypto_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.keyvault.keys.crypto import KeyWrapAlgorithm\n\n # wrap returns\
- \ a tuple with the wrapped bytes and the metadata required to unwrap the key\n\
- \ result = await client.wrap_key(KeyWrapAlgorithm.rsa_oaep, key_bytes)\n print(result.key_id)\n\
- \ print(result.algorithm)\n encrypted_key = result.encrypted_key\n\n ````"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\53\\\\azure-keyvault-keys-4.9.0b1\\\
+ \\tests\\\\test_examples_crypto_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.keyvault.keys.crypto import\
+ \ KeyWrapAlgorithm\n\n # wrap returns a tuple with the wrapped bytes and the\
+ \ metadata required to unwrap the key\n result = await client.wrap_key(KeyWrapAlgorithm.rsa_oaep,\
+ \ key_bytes)\n print(result.key_id)\n print(result.algorithm)\n encrypted_key\
+ \ = result.encrypted_key\n\n ````"
signature: 'async wrap_key(algorithm: KeyWrapAlgorithm, key: bytes, **kwargs) ->
WrapResult'
parameters:
diff --git a/preview/docs-ref-autogen/azure-keyvault-secrets/azure.keyvault.secrets.KeyVaultSecretIdentifier.yml b/preview/docs-ref-autogen/azure-keyvault-secrets/azure.keyvault.secrets.KeyVaultSecretIdentifier.yml
index 29e122bdbd2f..6bd66ca19881 100644
--- a/preview/docs-ref-autogen/azure-keyvault-secrets/azure.keyvault.secrets.KeyVaultSecretIdentifier.yml
+++ b/preview/docs-ref-autogen/azure-keyvault-secrets/azure.keyvault.secrets.KeyVaultSecretIdentifier.yml
@@ -17,7 +17,8 @@ constructor:
examples:
- "Parse a secret's ID<!--[!code-python[Main](s\\test_parse_id.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\":\
- \ [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\
+ \ [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\
\\tests\\\\test_parse_id.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false}\
\ -->\n\n````python\n\n secret = client.get_secret(secret_name)\n parsed_secret_id\
diff --git a/preview/docs-ref-autogen/azure-keyvault-secrets/azure.keyvault.secrets.SecretClient.yml b/preview/docs-ref-autogen/azure-keyvault-secrets/azure.keyvault.secrets.SecretClient.yml
index a81244f9e41a..81018610014d 100644
--- a/preview/docs-ref-autogen/azure-keyvault-secrets/azure.keyvault.secrets.SecretClient.yml
+++ b/preview/docs-ref-autogen/azure-keyvault-secrets/azure.keyvault.secrets.SecretClient.yml
@@ -42,13 +42,14 @@ constructor:
examples:
- "Create a new `SecretClient`<!--[!code-python[Main](s\\test_samples_secrets.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
- \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
- \ import DefaultAzureCredential\n from azure.keyvault.secrets import SecretClient\n\
- \n # Create a SecretClient using default Azure credentials\n credential = DefaultAzureCredential()\n\
- \ secret_client = SecretClient(vault_url, credential)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\
+ \\tests\\\\test_samples_secrets.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.identity import DefaultAzureCredential\n\
+ \ from azure.keyvault.secrets import SecretClient\n\n # Create a SecretClient\
+ \ using default Azure credentials\n credential = DefaultAzureCredential()\n \
+ \ secret_client = SecretClient(vault_url, credential)\n\n ````\n"
methods:
- uid: azure.keyvault.secrets.SecretClient.backup_secret
name: backup_secret
@@ -72,13 +73,13 @@ methods:
examples:
- "Back up a secret<!--[!code-python[Main](s\\test_samples_secrets.py )]-->\n\n\
<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # backup secret\n # returns the raw bytes of the backed up secret\n secret_backup\
- \ = secret_client.backup_secret(secret_name)\n\n print(secret_backup)\n\n \
- \ ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\
+ \\tests\\\\test_samples_secrets.py\", \"xml:space\": \"preserve\", \"force\":\
+ \ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # backup secret\n # returns the raw\
+ \ bytes of the backed up secret\n secret_backup = secret_client.backup_secret(secret_name)\n\
+ \n print(secret_backup)\n\n ````\n"
- uid: azure.keyvault.secrets.SecretClient.begin_delete_secret
name: begin_delete_secret
summary: 'Delete all versions of a secret. Requires secrets/delete permission.
@@ -120,17 +121,18 @@ methods:
examples:
- "Delete a secret<!--[!code-python[Main](s\\test_samples_secrets.py )]-->\n\n<!--\
\ literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [],\
- \ \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # delete a\
- \ secret\n deleted_secret_poller = secret_client.begin_delete_secret(secret_name)\n\
- \ deleted_secret = deleted_secret_poller.result()\n\n print(deleted_secret.name)\n\
- \n # if the vault has soft-delete enabled, the secret's, deleted_date\n #\
- \ scheduled purge date and recovery id are set\n print(deleted_secret.deleted_date)\n\
- \ print(deleted_secret.scheduled_purge_date)\n print(deleted_secret.recovery_id)\n\
- \n # if you want to block until secret is deleted server-side, call wait() on\
- \ the poller\n deleted_secret_poller.wait()\n\n ````\n"
+ \ \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\
+ \\tests\\\\test_samples_secrets.py\", \"xml:space\": \"preserve\", \"force\":\
+ \ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # delete a secret\n deleted_secret_poller\
+ \ = secret_client.begin_delete_secret(secret_name)\n deleted_secret = deleted_secret_poller.result()\n\
+ \n print(deleted_secret.name)\n\n # if the vault has soft-delete enabled,\
+ \ the secret's, deleted_date\n # scheduled purge date and recovery id are set\n\
+ \ print(deleted_secret.deleted_date)\n print(deleted_secret.scheduled_purge_date)\n\
+ \ print(deleted_secret.recovery_id)\n\n # if you want to block until secret\
+ \ is deleted server-side, call wait() on the poller\n deleted_secret_poller.wait()\n\
+ \n ````\n"
- uid: azure.keyvault.secrets.SecretClient.begin_recover_deleted_secret
name: begin_recover_deleted_secret
summary: 'Recover a deleted secret to its latest version. Possible only in a vault
@@ -178,15 +180,16 @@ methods:
examples:
- "Recover a deleted secret<!--[!code-python[Main](s\\test_samples_secrets.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # recover deleted secret to the latest version\n recover_secret_poller\
- \ = secret_client.begin_recover_deleted_secret(secret_name)\n recovered_secret\
- \ = recover_secret_poller.result()\n print(recovered_secret.id)\n print(recovered_secret.name)\n\
- \n # if you want to block until secret is recovered server-side, call wait()\
- \ on the poller\n recover_secret_poller.wait()\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\
+ \\tests\\\\test_samples_secrets.py\", \"xml:space\": \"preserve\", \"force\":\
+ \ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # recover deleted secret to the latest\
+ \ version\n recover_secret_poller = secret_client.begin_recover_deleted_secret(secret_name)\n\
+ \ recovered_secret = recover_secret_poller.result()\n print(recovered_secret.id)\n\
+ \ print(recovered_secret.name)\n\n # if you want to block until secret is\
+ \ recovered server-side, call wait() on the poller\n recover_secret_poller.wait()\n\
+ \n ````\n"
- uid: azure.keyvault.secrets.SecretClient.get_deleted_secret
name: get_deleted_secret
summary: Get a deleted secret. Possible only in vaults with soft-delete enabled.
@@ -209,13 +212,13 @@ methods:
examples:
- "Get a deleted secret<!--[!code-python[Main](s\\test_samples_secrets.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # gets a deleted secret (requires soft-delete enabled for the vault)\n \
- \ deleted_secret = secret_client.get_deleted_secret(secret_name)\n print(deleted_secret.name)\n\
- \n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\
+ \\tests\\\\test_samples_secrets.py\", \"xml:space\": \"preserve\", \"force\":\
+ \ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # gets a deleted secret (requires soft-delete\
+ \ enabled for the vault)\n deleted_secret = secret_client.get_deleted_secret(secret_name)\n\
+ \ print(deleted_secret.name)\n\n ````\n"
- uid: azure.keyvault.secrets.SecretClient.get_secret
name: get_secret
summary: Get a secret. Requires the secrets/get permission.
@@ -243,15 +246,15 @@ methods:
examples:
- "Get a secret<!--[!code-python[Main](s\\test_samples_secrets.py )]-->\n\n<!--\
\ literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [],\
- \ \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets.py\", \"\
- xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # get the\
- \ latest version of a secret\n secret = secret_client.get_secret(secret_name)\n\
- \n # alternatively, specify a version\n secret = secret_client.get_secret(secret_name,\
- \ secret.properties.version)\n\n print(secret.id)\n print(secret.name)\n \
- \ print(secret.properties.version)\n print(secret.properties.vault_url)\n\n\
- \ ````\n"
+ \ \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\
+ \\tests\\\\test_samples_secrets.py\", \"xml:space\": \"preserve\", \"force\":\
+ \ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # get the latest version of a secret\n\
+ \ secret = secret_client.get_secret(secret_name)\n\n # alternatively, specify\
+ \ a version\n secret = secret_client.get_secret(secret_name, secret.properties.version)\n\
+ \n print(secret.id)\n print(secret.name)\n print(secret.properties.version)\n\
+ \ print(secret.properties.vault_url)\n\n ````\n"
- uid: azure.keyvault.secrets.SecretClient.list_deleted_secrets
name: list_deleted_secrets
summary: 'Lists all deleted secrets. Possible only in vaults with soft-delete enabled.
@@ -266,14 +269,14 @@ methods:
examples:
- "List deleted secrets<!--[!code-python[Main](s\\test_samples_secrets.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # gets an iterator of deleted secrets (requires soft-delete enabled for the\
- \ vault)\n deleted_secrets = secret_client.list_deleted_secrets()\n\n for\
- \ secret in deleted_secrets:\n # the list doesn't include values or versions\
- \ of the deleted secrets\n print(secret.id)\n print(secret.name)\n\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\
+ \\tests\\\\test_samples_secrets.py\", \"xml:space\": \"preserve\", \"force\":\
+ \ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # gets an iterator of deleted secrets\
+ \ (requires soft-delete enabled for the vault)\n deleted_secrets = secret_client.list_deleted_secrets()\n\
+ \n for secret in deleted_secrets:\n # the list doesn't include values\
+ \ or versions of the deleted secrets\n print(secret.id)\n print(secret.name)\n\
\ print(secret.scheduled_purge_date)\n print(secret.recovery_id)\n\
\ print(secret.deleted_date)\n\n\n ````\n"
- uid: azure.keyvault.secrets.SecretClient.list_properties_of_secret_versions
@@ -298,14 +301,15 @@ methods:
examples:
- "List all versions of a secret<!--[!code-python[Main](s\\test_samples_secrets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n secret_versions = secret_client.list_properties_of_secret_versions(\"secret-name\"\
- )\n\n for secret in secret_versions:\n # the list doesn't include the\
- \ values at each version\n print(secret.id)\n print(secret.enabled)\n\
- \ print(secret.updated_on)\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n secret_versions\
+ \ = secret_client.list_properties_of_secret_versions(\"secret-name\")\n\n for\
+ \ secret in secret_versions:\n # the list doesn't include the values at\
+ \ each version\n print(secret.id)\n print(secret.enabled)\n \
+ \ print(secret.updated_on)\n\n ````\n"
- uid: azure.keyvault.secrets.SecretClient.list_properties_of_secrets
name: list_properties_of_secrets
summary: 'List identifiers and attributes of all secrets in the vault. Requires
@@ -322,11 +326,11 @@ methods:
examples:
- "List all secrets<!--[!code-python[Main](s\\test_samples_secrets.py )]-->\n\n\
<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # list secrets\n secrets = secret_client.list_properties_of_secrets()\n\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\
+ \\tests\\\\test_samples_secrets.py\", \"xml:space\": \"preserve\", \"force\":\
+ \ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # list secrets\n secrets = secret_client.list_properties_of_secrets()\n\
\n for secret in secrets:\n # the list doesn't include values or versions\
\ of the secrets\n print(secret.id)\n print(secret.name)\n print(secret.enabled)\n\
\n ````\n"
@@ -388,11 +392,12 @@ methods:
examples:
- "Restore a backed up secret<!--[!code-python[Main](s\\test_samples_secrets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # restores a backed up secret\n restored_secret = secret_client.restore_secret_backup(secret_backup)\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # restores\
+ \ a backed up secret\n restored_secret = secret_client.restore_secret_backup(secret_backup)\n\
\ print(restored_secret.id)\n print(restored_secret.version)\n\n ````\n"
- uid: azure.keyvault.secrets.SecretClient.set_secret
name: set_secret
@@ -442,15 +447,15 @@ methods:
examples:
- "Set a secret's value<!--[!code-python[Main](s\\test_samples_secrets.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets.py\",\
- \ \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from dateutil import parser as date_parse\n\n expires_on = date_parse.parse(\"\
- 2050-02-02T08:00:00.000Z\")\n\n # create a secret, setting optional arguments\n\
- \ secret = secret_client.set_secret(secret_name, \"secret-value\", expires_on=expires_on)\n\
- \n print(secret.name)\n print(secret.properties.version)\n print(secret.properties.expires_on)\n\
- \n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\
+ \\tests\\\\test_samples_secrets.py\", \"xml:space\": \"preserve\", \"force\":\
+ \ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from dateutil import parser as date_parse\n\
+ \n expires_on = date_parse.parse(\"2050-02-02T08:00:00.000Z\")\n\n # create\
+ \ a secret, setting optional arguments\n secret = secret_client.set_secret(secret_name,\
+ \ \"secret-value\", expires_on=expires_on)\n\n print(secret.name)\n print(secret.properties.version)\n\
+ \ print(secret.properties.expires_on)\n\n ````\n"
- uid: azure.keyvault.secrets.SecretClient.update_secret_properties
name: update_secret_properties
summary: 'Update properties of a secret other than its value. Requires secrets/set
@@ -508,12 +513,13 @@ methods:
examples:
- "Update a secret's attributes<!--[!code-python[Main](s\\test_samples_secrets.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # update attributes of an existing secret\n\n content_type = \"text/plain\"\
- \n tags = {\"foo\": \"updated tag\"}\n updated_secret_properties = secret_client.update_secret_properties(\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n # update attributes\
+ \ of an existing secret\n\n content_type = \"text/plain\"\n tags = {\"foo\"\
+ : \"updated tag\"}\n updated_secret_properties = secret_client.update_secret_properties(\n\
\ secret_name, content_type=content_type, tags=tags\n )\n\n print(updated_secret_properties.version)\n\
\ print(updated_secret_properties.updated_on)\n print(updated_secret_properties.content_type)\n\
\ print(updated_secret_properties.tags)\n\n ````\n"
diff --git a/preview/docs-ref-autogen/azure-keyvault-secrets/azure.keyvault.secrets.aio.SecretClient.yml b/preview/docs-ref-autogen/azure-keyvault-secrets/azure.keyvault.secrets.aio.SecretClient.yml
index 5af230e263c1..d0fe37209406 100644
--- a/preview/docs-ref-autogen/azure-keyvault-secrets/azure.keyvault.secrets.aio.SecretClient.yml
+++ b/preview/docs-ref-autogen/azure-keyvault-secrets/azure.keyvault.secrets.aio.SecretClient.yml
@@ -42,13 +42,14 @@ constructor:
examples:
- "Create a new `SecretClient`<!--[!code-python[Main](s\\test_samples_secrets_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import DefaultAzureCredential\n from azure.keyvault.secrets.aio import SecretClient\n\
- \n # Create a SecretClient using default Azure credentials\n credential = DefaultAzureCredential()\n\
- \ secret_client = SecretClient(vault_url, credential)\n\n # the client and credential\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\
+ \\tests\\\\test_samples_secrets_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.identity.aio import DefaultAzureCredential\n\
+ \ from azure.keyvault.secrets.aio import SecretClient\n\n # Create a SecretClient\
+ \ using default Azure credentials\n credential = DefaultAzureCredential()\n \
+ \ secret_client = SecretClient(vault_url, credential)\n\n # the client and credential\
\ should be closed when no longer needed\n # (both are also async context managers)\n\
\ await secret_client.close()\n await credential.close()\n\n ````\n"
methods:
@@ -74,13 +75,13 @@ methods:
examples:
- "Back up a secret<!--[!code-python[Main](s\\test_samples_secrets_async.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # backup secret\n secret_backup = await secret_client.backup_secret(secret_name)\n\
- \n # returns the raw bytes of the backed up secret\n print(secret_backup)\n\
- \n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\
+ \\tests\\\\test_samples_secrets_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # backup secret\n secret_backup\
+ \ = await secret_client.backup_secret(secret_name)\n\n # returns the raw\
+ \ bytes of the backed up secret\n print(secret_backup)\n\n ````\n"
- uid: azure.keyvault.secrets.aio.SecretClient.delete_secret
name: delete_secret
summary: 'Delete all versions of a secret. Requires secrets/delete permission.
@@ -105,15 +106,16 @@ methods:
examples:
- "Delete a secret<!--[!code-python[Main](s\\test_samples_secrets_async.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # delete a secret\n deleted_secret = await secret_client.delete_secret(secret_name)\n\
- \n print(deleted_secret.name)\n\n # if the vault has soft-delete enabled,\
- \ the secret's deleted_date,\n # scheduled purge date and recovery id are\
- \ set\n print(deleted_secret.deleted_date)\n print(deleted_secret.scheduled_purge_date)\n\
- \ print(deleted_secret.recovery_id)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\
+ \\tests\\\\test_samples_secrets_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # delete a secret\n deleted_secret\
+ \ = await secret_client.delete_secret(secret_name)\n\n print(deleted_secret.name)\n\
+ \n # if the vault has soft-delete enabled, the secret's deleted_date,\n\
+ \ # scheduled purge date and recovery id are set\n print(deleted_secret.deleted_date)\n\
+ \ print(deleted_secret.scheduled_purge_date)\n print(deleted_secret.recovery_id)\n\
+ \n ````\n"
- uid: azure.keyvault.secrets.aio.SecretClient.get_deleted_secret
name: get_deleted_secret
summary: Get a deleted secret. Possible only in vaults with soft-delete enabled.
@@ -136,8 +138,9 @@ methods:
examples:
- "Get a deleted secret<!--[!code-python[Main](s\\test_samples_secrets_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # gets a deleted secret (requires soft-delete enabled for the vault)\n\
@@ -171,12 +174,13 @@ methods:
examples:
- "Get a secret<!--[!code-python[Main](s\\test_samples_secrets_async.py )]-->\n\n\
<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # get the latest version of a secret\n secret = await secret_client.get_secret(secret_name)\n\
- \n # alternatively, specify a version\n secret = await secret_client.get_secret(secret_name,\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\
+ \\tests\\\\test_samples_secrets_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # get the latest version of a secret\n\
+ \ secret = await secret_client.get_secret(secret_name)\n\n # alternatively,\
+ \ specify a version\n secret = await secret_client.get_secret(secret_name,\
\ secret_version)\n\n print(secret.id)\n print(secret.name)\n \
\ print(secret.properties.version)\n print(secret.properties.vault_url)\n\
\n ````\n"
@@ -194,8 +198,9 @@ methods:
examples:
- "Lists deleted secrets<!--[!code-python[Main](s\\test_samples_secrets_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # gets a list of deleted secrets (requires soft-delete enabled for the\
@@ -227,8 +232,9 @@ methods:
examples:
- "List all versions of a secret<!--[!code-python[Main](s\\test_samples_secrets_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # gets a list of all versions of a secret\n secret_versions = secret_client.list_properties_of_secret_versions(\"\
@@ -251,12 +257,13 @@ methods:
examples:
- "Lists all secrets<!--[!code-python[Main](s\\test_samples_secrets_async.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\
- \\54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n # gets a list of secrets in the vault\n secrets = secret_client.list_properties_of_secrets()\n\
- \n async for secret in secrets:\n # the list doesn't include values\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\
+ \\tests\\\\test_samples_secrets_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n # gets a list of secrets in the\
+ \ vault\n secrets = secret_client.list_properties_of_secrets()\n\n \
+ \ async for secret in secrets:\n # the list doesn't include values\
\ or versions of the secrets\n print(secret.id)\n print(secret.name)\n\
\ print(secret.enabled)\n\n ````\n"
- uid: azure.keyvault.secrets.aio.SecretClient.purge_deleted_secret
@@ -323,8 +330,9 @@ methods:
examples:
- "Recover a deleted secret<!--[!code-python[Main](s\\test_samples_secrets_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # recover deleted secret to the latest version\n recovered_secret\
@@ -352,8 +360,9 @@ methods:
examples:
- "Restore a backed up secret<!--[!code-python[Main](s\\test_samples_secrets_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # restores a backed up secret\n restored_secret = await secret_client.restore_secret_backup(secret_backup)\n\
@@ -407,8 +416,9 @@ methods:
examples:
- "Set a secret's value<!--[!code-python[Main](s\\test_samples_secrets_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from dateutil import parser as date_parse\n\n expires_on = date_parse.parse(\"\
@@ -474,8 +484,9 @@ methods:
examples:
- "Updates a secret's attributes<!--[!code-python[Main](s\\test_samples_secrets_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets_async.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 54\\\\azure-keyvault-secrets-4.8.0b1\\\\tests\\\\test_samples_secrets_async.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n # update attributes of an existing secret\n content_type = \"text/plain\"\
diff --git a/preview/docs-ref-autogen/azure-maps-geolocation/azure.maps.geolocation.MapsGeolocationClient.yml b/preview/docs-ref-autogen/azure-maps-geolocation/azure.maps.geolocation.MapsGeolocationClient.yml
index e7c6bb5608fc..435cfca8d0da 100644
--- a/preview/docs-ref-autogen/azure-maps-geolocation/azure.maps.geolocation.MapsGeolocationClient.yml
+++ b/preview/docs-ref-autogen/azure-maps-geolocation/azure.maps.geolocation.MapsGeolocationClient.yml
@@ -33,24 +33,25 @@ constructor:
examples:
- "Creating the MapsGeolocationClient with an subscription key.<!--[!code-python[Main](les\\\
sample_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\":\
- \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\dist_temp\\\\55\\\\azure-maps-geolocation-1.0.0b1\\\\samples\\\
- \\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
- language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false}\
- \ -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
- \ from azure.maps.geolocation import MapsGeolocationClient\n\n subscription_key\
- \ = os.getenv(\"AZURE_SUBSCRIPTION_KEY\")\n\n maps_geolocation_client = MapsGeolocationClient(credential=AzureKeyCredential(subscription_key))\n\
- \n ````\n\nCreating the MapsGeolocationClient with a token credential.<!--[!code-python[Main](les\\\
+ \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\55\\\\azure-maps-geolocation-1.0.0b1\\\\samples\\\\sample_authentication.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
+ \ import AzureKeyCredential\n from azure.maps.geolocation import MapsGeolocationClient\n\
+ \n subscription_key = os.getenv(\"AZURE_SUBSCRIPTION_KEY\")\n\n maps_geolocation_client\
+ \ = MapsGeolocationClient(credential=AzureKeyCredential(subscription_key))\n\n \
+ \ ````\n\nCreating the MapsGeolocationClient with a token credential.<!--[!code-python[Main](les\\\
sample_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\":\
- \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\dist_temp\\\\55\\\\azure-maps-geolocation-1.0.0b1\\\\samples\\\
- \\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
- language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false}\
- \ -->\n\n````python\n\n from azure.identity import DefaultAzureCredential\n \
- \ from azure.maps.geolocation import MapsGeolocationClient\n\n credential = DefaultAzureCredential()\n\
- \ maps_client_id = os.getenv(\"AZURE_MAPS_CLIENT_ID\")\n\n maps_geolocation_client\
- \ = MapsGeolocationClient(client_id=maps_client_id, credential=credential)\n\n \
- \ ````\n"
+ \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\55\\\\azure-maps-geolocation-1.0.0b1\\\\samples\\\\sample_authentication.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
+ \ import DefaultAzureCredential\n from azure.maps.geolocation import MapsGeolocationClient\n\
+ \n credential = DefaultAzureCredential()\n maps_client_id = os.getenv(\"AZURE_MAPS_CLIENT_ID\"\
+ )\n\n maps_geolocation_client = MapsGeolocationClient(client_id=maps_client_id,\
+ \ credential=credential)\n\n ````\n"
methods:
- uid: azure.maps.geolocation.MapsGeolocationClient.get_country_code
name: get_country_code
@@ -77,11 +78,12 @@ methods:
examples:
- "Return the ISO country code for the provided IP address.<!--[!code-python[Main](les\\\
sample_get_country_code.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\55\\\\azure-maps-geolocation-1.0.0b1\\\\\
- samples\\\\sample_get_country_code.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\55\\\\azure-maps-geolocation-1.0.0b1\\\\samples\\\\\
+ sample_get_country_code.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
+ language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
\ from azure.maps.geolocation import MapsGeolocationClient\n\n maps_geolocation_client\
\ = MapsGeolocationClient(credential=AzureKeyCredential(subscription_key))\n\n\
\ result = maps_geolocation_client.get_country_code(ip_address=\"2001:4898:80e8:b::189\"\
diff --git a/preview/docs-ref-autogen/azure-maps-geolocation/azure.maps.geolocation.aio.MapsGeolocationClient.yml b/preview/docs-ref-autogen/azure-maps-geolocation/azure.maps.geolocation.aio.MapsGeolocationClient.yml
index ec05bb3333e1..230f9b389eac 100644
--- a/preview/docs-ref-autogen/azure-maps-geolocation/azure.maps.geolocation.aio.MapsGeolocationClient.yml
+++ b/preview/docs-ref-autogen/azure-maps-geolocation/azure.maps.geolocation.aio.MapsGeolocationClient.yml
@@ -34,22 +34,23 @@ examples:
- "Creating the MapsGeolocationClient with an subscription key.<!--[!code-python[Main](les\\\
async_samples\\sample_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\55\\\\azure-maps-geolocation-1.0.0b1\\\
- \\samples\\\\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.maps.geolocation.aio import MapsGeolocationClient\n\
- \n subscription_key = os.getenv(\"AZURE_SUBSCRIPTION_KEY\")\n\n maps_geolocation_client\
- \ = MapsGeolocationClient(credential=AzureKeyCredential(subscription_key))\n\n \
- \ ````\n\nCreating the MapsGeolocationClient with a token credential.<!--[!code-python[Main](les\\\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\55\\\\azure-maps-geolocation-1.0.0b1\\\\samples\\\\async_samples\\\
+ \\sample_authentication_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.maps.geolocation.aio import MapsGeolocationClient\n\n subscription_key\
+ \ = os.getenv(\"AZURE_SUBSCRIPTION_KEY\")\n\n maps_geolocation_client = MapsGeolocationClient(credential=AzureKeyCredential(subscription_key))\n\
+ \n ````\n\nCreating the MapsGeolocationClient with a token credential.<!--[!code-python[Main](les\\\
async_samples\\sample_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\55\\\\azure-maps-geolocation-1.0.0b1\\\
- \\samples\\\\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import DefaultAzureCredential\n from azure.maps.geolocation.aio import MapsGeolocationClient\n\
- \n credential = DefaultAzureCredential()\n maps_client_id = os.getenv(\"AZURE_MAPS_CLIENT_ID\"\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\55\\\\azure-maps-geolocation-1.0.0b1\\\\samples\\\\async_samples\\\
+ \\sample_authentication_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.identity.aio import DefaultAzureCredential\n\
+ \ from azure.maps.geolocation.aio import MapsGeolocationClient\n\n credential\
+ \ = DefaultAzureCredential()\n maps_client_id = os.getenv(\"AZURE_MAPS_CLIENT_ID\"\
)\n\n maps_geolocation_client = MapsGeolocationClient(client_id=maps_client_id,\
\ credential=credential)\n\n ````\n"
methods:
@@ -79,7 +80,8 @@ methods:
- "Return the ISO country code for the provided IP address.<!--[!code-python[Main](les\\\
async_samples\\sample_get_country_code_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\55\\\\azure-maps-geolocation-1.0.0b1\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\55\\\\azure-maps-geolocation-1.0.0b1\\\
\\samples\\\\async_samples\\\\sample_get_country_code_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
diff --git a/preview/docs-ref-autogen/azure-maps-render/azure.maps.render.MapsRenderClient.yml b/preview/docs-ref-autogen/azure-maps-render/azure.maps.render.MapsRenderClient.yml
index 73b6d439f250..689aa27d8577 100644
--- a/preview/docs-ref-autogen/azure-maps-render/azure.maps.render.MapsRenderClient.yml
+++ b/preview/docs-ref-autogen/azure-maps-render/azure.maps.render.MapsRenderClient.yml
@@ -26,23 +26,25 @@ constructor:
examples:
- "Creating the MapsRenderClient with an subscription key.<!--[!code-python[Main](les\\\
sample_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\":\
- \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\\samples\\\\\
- sample_authentication.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
- : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
- \n````python\n\n from azure.core.credentials import AzureKeyCredential\n from\
- \ azure.maps.render import MapsRenderClient\n\n subscription_key = os.getenv(\"\
- AZURE_SUBSCRIPTION_KEY\")\n\n maps_render_client = MapsRenderClient(credential=AzureKeyCredential(subscription_key))\n\
- \n ````\n\nCreating the MapsRenderClient with a token credential.<!--[!code-python[Main](les\\\
+ \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\56\\\\azure-maps-render-1.0.0b2\\\\samples\\\\sample_authentication.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
+ \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
+ \ import AzureKeyCredential\n from azure.maps.render import MapsRenderClient\n\
+ \n subscription_key = os.getenv(\"AZURE_SUBSCRIPTION_KEY\")\n\n maps_render_client\
+ \ = MapsRenderClient(credential=AzureKeyCredential(subscription_key))\n\n ````\n\
+ \nCreating the MapsRenderClient with a token credential.<!--[!code-python[Main](les\\\
sample_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\":\
- \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\\samples\\\\\
- sample_authentication.py\", \"xml:space\": \"preserve\", \"force\": false, \"language\"\
- : \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\
- \n````python\n\n from azure.identity import DefaultAzureCredential\n from azure.maps.render\
- \ import MapsRenderClient\n\n credential = DefaultAzureCredential()\n maps_client_id\
- \ = os.getenv(\"AZURE_MAPS_CLIENT_ID\")\n\n maps_render_client = MapsRenderClient(client_id=maps_client_id,\
- \ credential=credential)\n\n ````\n"
+ \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\56\\\\azure-maps-render-1.0.0b2\\\\samples\\\\sample_authentication.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
+ \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
+ \ import DefaultAzureCredential\n from azure.maps.render import MapsRenderClient\n\
+ \n credential = DefaultAzureCredential()\n maps_client_id = os.getenv(\"AZURE_MAPS_CLIENT_ID\"\
+ )\n\n maps_render_client = MapsRenderClient(client_id=maps_client_id, credential=credential)\n\
+ \n ````\n"
methods:
- uid: azure.maps.render.MapsRenderClient.get_copyright_caption
name: get_copyright_caption
@@ -66,15 +68,15 @@ methods:
examples:
- "Return serve copyright information for Render Tile service.<!--[!code-python[Main](les\\\
sample_get_copyright_caption.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\\samples\\\
- \\sample_get_copyright_caption.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
- \ from azure.maps.render import MapsRenderClient\n\n maps_render_client =\
- \ MapsRenderClient(credential=AzureKeyCredential(subscription_key))\n\n result\
- \ = maps_render_client.get_copyright_caption()\n\n print(\"Get copyright caption\
- \ result:\")\n print(result.copyrights_caption)\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\\samples\\\\sample_get_copyright_caption.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.core.credentials import AzureKeyCredential\n from azure.maps.render\
+ \ import MapsRenderClient\n\n maps_render_client = MapsRenderClient(credential=AzureKeyCredential(subscription_key))\n\
+ \n result = maps_render_client.get_copyright_caption()\n\n print(\"Get copyright\
+ \ caption result:\")\n print(result.copyrights_caption)\n\n ````\n"
- uid: azure.maps.render.MapsRenderClient.get_copyright_for_tile
name: get_copyright_for_tile
summary: 'Copyrights API is designed to serve copyright information for Render Tile service.
@@ -126,12 +128,12 @@ methods:
- "Returns the copyright information for a given tile.<!--[!code-python[Main](les\\\
sample_get_copyright_for_tile.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\
- \\samples\\\\sample_get_copyright_for_tile.py\", \"xml:space\": \"preserve\",\
- \ \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.maps.render import MapsRenderClient\n\
- \n maps_render_client = MapsRenderClient(credential=AzureKeyCredential(subscription_key))\n\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\\samples\\\\sample_get_copyright_for_tile.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.core.credentials import AzureKeyCredential\n from azure.maps.render\
+ \ import MapsRenderClient\n\n maps_render_client = MapsRenderClient(credential=AzureKeyCredential(subscription_key))\n\
\n result = maps_render_client.get_copyright_for_tile(z=6, x=9, y=22)\n\n \
\ print(\"Get copyright for tile result:\")\n print(result.general_copyrights[0])\n\
\n ````\n"
@@ -168,12 +170,12 @@ methods:
- "Returns the copyright information for the world.<!--[!code-python[Main](les\\\
sample_get_copyright_for_world.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\
- \\samples\\\\sample_get_copyright_for_world.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.maps.render import MapsRenderClient\n\
- \n maps_render_client = MapsRenderClient(credential=AzureKeyCredential(subscription_key))\n\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\\samples\\\\sample_get_copyright_for_world.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.core.credentials import AzureKeyCredential\n from azure.maps.render\
+ \ import MapsRenderClient\n\n maps_render_client = MapsRenderClient(credential=AzureKeyCredential(subscription_key))\n\
\n result = maps_render_client.get_copyright_for_world()\n\n print(\"Get copyright\
\ for the world result:\")\n print(result.general_copyrights[0])\n\n ````\n"
- uid: azure.maps.render.MapsRenderClient.get_copyright_from_bounding_box
@@ -209,14 +211,14 @@ methods:
- "Return copyright information for a given bounding box.<!--[!code-python[Main](les\\\
sample_get_copyright_from_bounding_box.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\
- \\samples\\\\sample_get_copyright_from_bounding_box.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.maps.render import MapsRenderClient\n\
- \ from azure.maps.render.models import BoundingBox\n\n maps_render_client\
- \ = MapsRenderClient(credential=AzureKeyCredential(subscription_key))\n\n result\
- \ = maps_render_client.get_copyright_from_bounding_box(\n bounding_box=BoundingBox(\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\\samples\\\\sample_get_copyright_from_bounding_box.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.core.credentials import AzureKeyCredential\n from azure.maps.render\
+ \ import MapsRenderClient\n from azure.maps.render.models import BoundingBox\n\
+ \n maps_render_client = MapsRenderClient(credential=AzureKeyCredential(subscription_key))\n\
+ \n result = maps_render_client.get_copyright_from_bounding_box(\n bounding_box=BoundingBox(\n\
\ south=42.982261,\n west=24.980233,\n north=56.526017,\n\
\ east=1.355233\n )\n )\n\n print(\"Get copyright from bounding\
\ box result:\")\n print(result.general_copyrights[0])\n print(\"Result country\
@@ -265,13 +267,14 @@ methods:
examples:
- "Return map copyright attribution information for a section of a tileset.<!--[!code-python[Main](les\\\
sample_get_map_attribution.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\\samples\\\
- \\sample_get_map_attribution.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
- \ from azure.maps.render import MapsRenderClient\n from azure.maps.render.models\
- \ import TilesetID, BoundingBox\n\n maps_render_client = MapsRenderClient(credential=AzureKeyCredential(subscription_key))\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\\samples\\\\sample_get_map_attribution.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.core.credentials import AzureKeyCredential\n from azure.maps.render\
+ \ import MapsRenderClient\n from azure.maps.render.models import TilesetID,\
+ \ BoundingBox\n\n maps_render_client = MapsRenderClient(credential=AzureKeyCredential(subscription_key))\n\
\n result = maps_render_client.get_map_attribution(\n tileset_id=TilesetID.MICROSOFT_BASE,\n\
\ zoom=6,\n bounds=BoundingBox(\n south=42.982261,\n \
\ west=24.980233,\n north=56.526017,\n east=1.355233\n\
@@ -418,13 +421,14 @@ methods:
- "Return static image service renders a user-defined,\nrectangular image containing\
\ a map section using a zoom level from 0 to 20.<!--[!code-python[Main](les\\\
sample_get_map_static_image.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\\samples\\\
- \\sample_get_map_static_image.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
- \ from azure.maps.render import MapsRenderClient\n from azure.maps.render.models\
- \ import BoundingBox\n\n maps_render_client = MapsRenderClient(credential=AzureKeyCredential(subscription_key))\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\\samples\\\\sample_get_map_static_image.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.core.credentials import AzureKeyCredential\n from azure.maps.render\
+ \ import MapsRenderClient\n from azure.maps.render.models import BoundingBox\n\
+ \n maps_render_client = MapsRenderClient(credential=AzureKeyCredential(subscription_key))\n\
\n result = maps_render_client.get_map_static_image(\n img_format=\"png\"\
,\n layer=\"basic\",\n style=\"dark\",\n zoom=10,\n bounding_box_private=\
\ BoundingBox(\n 13.228, 52.4559, 13.5794, 52.629\n )\n )\n\n\
@@ -504,14 +508,15 @@ methods:
examples:
- "Return map tiles in vector or raster formats.<!--[!code-python[Main](les\\sample_get_map_tile.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\\samples\\\\sample_get_map_tile.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.core.credentials import AzureKeyCredential\n from azure.maps.render\
- \ import MapsRenderClient\n from azure.maps.render.models import TilesetID\n\
- \n maps_render_client = MapsRenderClient(credential=AzureKeyCredential(subscription_key))\n\
- \n result = maps_render_client.get_map_tile(\n tileset_id=TilesetID.MICROSOFT_BASE,\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 56\\\\azure-maps-render-1.0.0b2\\\\samples\\\\sample_get_map_tile.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
+ \ import AzureKeyCredential\n from azure.maps.render import MapsRenderClient\n\
+ \ from azure.maps.render.models import TilesetID\n\n maps_render_client =\
+ \ MapsRenderClient(credential=AzureKeyCredential(subscription_key))\n\n result\
+ \ = maps_render_client.get_map_tile(\n tileset_id=TilesetID.MICROSOFT_BASE,\n\
\ z=6,\n x=9,\n y=22,\n tile_size=\"512\"\n )\n\n \
\ print(\"Get map tile result store in file name 'map_tile.png'\")\n # print(result)\n\
\ with open('map_tile.png', 'wb') as file:\n file.write(next(result))\n\
@@ -542,13 +547,14 @@ methods:
examples:
- "Return metadata for a tileset.<!--[!code-python[Main](les\\sample_get_map_tileset.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\\samples\\\\sample_get_map_tileset.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.core.credentials import AzureKeyCredential\n from azure.maps.render\
- \ import MapsRenderClient\n from azure.maps.render.models import TilesetID\n\
- \n maps_render_client = MapsRenderClient(credential=AzureKeyCredential(subscription_key))\n\
- \n result = maps_render_client.get_map_tileset(tileset_id=TilesetID.MICROSOFT_BASE)\n\
- \n print(\"Get map tileset result:\")\n print(result.map_attribution)\n \
- \ print(result.bounds)\n print(result.version)\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 56\\\\azure-maps-render-1.0.0b2\\\\samples\\\\sample_get_map_tileset.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
+ \ import AzureKeyCredential\n from azure.maps.render import MapsRenderClient\n\
+ \ from azure.maps.render.models import TilesetID\n\n maps_render_client =\
+ \ MapsRenderClient(credential=AzureKeyCredential(subscription_key))\n\n result\
+ \ = maps_render_client.get_map_tileset(tileset_id=TilesetID.MICROSOFT_BASE)\n\n\
+ \ print(\"Get map tileset result:\")\n print(result.map_attribution)\n print(result.bounds)\n\
+ \ print(result.version)\n\n ````\n"
diff --git a/preview/docs-ref-autogen/azure-maps-render/azure.maps.render.aio.MapsRenderClient.yml b/preview/docs-ref-autogen/azure-maps-render/azure.maps.render.aio.MapsRenderClient.yml
index b8d3211a89de..b6c3c6a0d085 100644
--- a/preview/docs-ref-autogen/azure-maps-render/azure.maps.render.aio.MapsRenderClient.yml
+++ b/preview/docs-ref-autogen/azure-maps-render/azure.maps.render.aio.MapsRenderClient.yml
@@ -27,24 +27,24 @@ examples:
- "Creating the MapsRenderClient with an subscription key.<!--[!code-python[Main](les\\\
async_samples\\sample_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\
- \\samples\\\\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.maps.render.aio import MapsRenderClient\n\
- \n subscription_key = os.getenv(\"AZURE_SUBSCRIPTION_KEY\")\n\n maps_render_client\
- \ = MapsRenderClient(credential=AzureKeyCredential(subscription_key))\n\n ````\n\
- \nCreating the MapsRenderClient with a token credential.<!--[!code-python[Main](les\\\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\\samples\\\\async_samples\\\
+ \\sample_authentication_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.maps.render.aio import MapsRenderClient\n\n subscription_key =\
+ \ os.getenv(\"AZURE_SUBSCRIPTION_KEY\")\n\n maps_render_client = MapsRenderClient(credential=AzureKeyCredential(subscription_key))\n\
+ \n ````\n\nCreating the MapsRenderClient with a token credential.<!--[!code-python[Main](les\\\
async_samples\\sample_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\
- \\samples\\\\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import DefaultAzureCredential\n from azure.maps.render.aio import MapsRenderClient\n\
- \n credential = DefaultAzureCredential()\n maps_client_id = os.getenv(\"AZURE_MAPS_CLIENT_ID\"\
- )\n\n maps_render_client = MapsRenderClient(client_id=maps_client_id, credential=credential)\n\
- \n ````\n"
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\\samples\\\\async_samples\\\
+ \\sample_authentication_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.identity.aio import DefaultAzureCredential\n\
+ \ from azure.maps.render.aio import MapsRenderClient\n\n credential = DefaultAzureCredential()\n\
+ \ maps_client_id = os.getenv(\"AZURE_MAPS_CLIENT_ID\")\n\n maps_render_client\
+ \ = MapsRenderClient(client_id=maps_client_id, credential=credential)\n\n ````\n"
methods:
- uid: azure.maps.render.aio.MapsRenderClient.get_copyright_caption
name: get_copyright_caption
@@ -69,7 +69,8 @@ methods:
- "Return serve copyright information for Render Tile service.<!--[!code-python[Main](les\\\
async_samples\\sample_get_copyright_caption_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\
\\samples\\\\async_samples\\\\sample_get_copyright_caption_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
@@ -130,7 +131,8 @@ methods:
- "Returns the copyright information for a given tile.<!--[!code-python[Main](les\\\
async_samples\\sample_get_copyright_for_tile_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\
\\samples\\\\async_samples\\\\sample_get_copyright_for_tile_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
@@ -172,7 +174,8 @@ methods:
- "Returns the copyright information for the world.<!--[!code-python[Main](les\\\
async_samples\\sample_get_copyright_for_world_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\
\\samples\\\\async_samples\\\\sample_get_copyright_for_world_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
@@ -255,7 +258,8 @@ methods:
- "Return map copyright attribution information for a section of a tileset.<!--[!code-python[Main](les\\\
async_samples\\sample_get_map_attribution_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\
\\samples\\\\async_samples\\\\sample_get_map_attribution_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
@@ -410,7 +414,8 @@ methods:
\ a map section using a zoom level from 0 to 20.<!--[!code-python[Main](les\\\
async_samples\\sample_get_map_static_image_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\
\\samples\\\\async_samples\\\\sample_get_map_static_image_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
@@ -491,15 +496,15 @@ methods:
examples:
- "Return map tiles in vector or raster formats.<!--[!code-python[Main](les\\async_samples\\\
sample_get_map_tile_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\\samples\\\
- \\async_samples\\\\sample_get_map_tile_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.maps.render.aio import MapsRenderClient\n\
- \ from azure.maps.render.models import TilesetID\n\n maps_render_client =\
- \ MapsRenderClient(credential=AzureKeyCredential(subscription_key))\n\n\n async\
- \ with maps_render_client:\n result = await maps_render_client.get_map_tile(tileset_id=TilesetID.MICROSOFT_BASE,\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\56\\\\azure-maps-render-1.0.0b2\\\\samples\\\\async_samples\\\
+ \\sample_get_map_tile_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.maps.render.aio import MapsRenderClient\n from azure.maps.render.models\
+ \ import TilesetID\n\n maps_render_client = MapsRenderClient(credential=AzureKeyCredential(subscription_key))\n\
+ \n\n async with maps_render_client:\n result = await maps_render_client.get_map_tile(tileset_id=TilesetID.MICROSOFT_BASE,\
\ z=6, x=9, y=22, tile_size=\"512\")\n\n\n ````\n"
- uid: azure.maps.render.aio.MapsRenderClient.get_map_tileset
name: get_map_tileset
diff --git a/preview/docs-ref-autogen/azure-mgmt-datalake-analytics/azure.mgmt.datalake.analytics.yml b/preview/docs-ref-autogen/azure-mgmt-datalake-analytics/azure.mgmt.datalake.analytics.yml
new file mode 100644
index 000000000000..30ea1093ee22
--- /dev/null
+++ b/preview/docs-ref-autogen/azure-mgmt-datalake-analytics/azure.mgmt.datalake.analytics.yml
@@ -0,0 +1,7 @@
+### YamlMime:PythonPackage
+uid: azure.mgmt.datalake.analytics
+name: analytics
+fullName: azure.mgmt.datalake.analytics
+type: import
+packages:
+- azure.mgmt.datalake.analytics.account
diff --git a/preview/docs-ref-autogen/azure-mgmt-datalake-analytics/index.yml b/preview/docs-ref-autogen/azure-mgmt-datalake-analytics/index.yml
index c45ed4bfee63..ba0f79335628 100644
--- a/preview/docs-ref-autogen/azure-mgmt-datalake-analytics/index.yml
+++ b/preview/docs-ref-autogen/azure-mgmt-datalake-analytics/index.yml
@@ -4,4 +4,4 @@ name: azure-mgmt-datalake-analytics
fullName: azure-mgmt-datalake-analytics
type: distribution
packages:
-- azure.mgmt.datalake.analytics.account
+- azure.mgmt.datalake.analytics
diff --git a/preview/docs-ref-autogen/azure-mgmt-rdbms/azure.mgmt.rdbms.yml b/preview/docs-ref-autogen/azure-mgmt-rdbms/azure.mgmt.rdbms.yml
new file mode 100644
index 000000000000..9522fa867487
--- /dev/null
+++ b/preview/docs-ref-autogen/azure-mgmt-rdbms/azure.mgmt.rdbms.yml
@@ -0,0 +1,11 @@
+### YamlMime:PythonPackage
+uid: azure.mgmt.rdbms
+name: rdbms
+fullName: azure.mgmt.rdbms
+type: import
+packages:
+- azure.mgmt.rdbms.mariadb
+- azure.mgmt.rdbms.mysql
+- azure.mgmt.rdbms.mysql_flexibleservers
+- azure.mgmt.rdbms.postgresql
+- azure.mgmt.rdbms.postgresql_flexibleservers
diff --git a/preview/docs-ref-autogen/azure-mgmt-rdbms/index.yml b/preview/docs-ref-autogen/azure-mgmt-rdbms/index.yml
index c5ed5a473217..4013c5b2aa71 100644
--- a/preview/docs-ref-autogen/azure-mgmt-rdbms/index.yml
+++ b/preview/docs-ref-autogen/azure-mgmt-rdbms/index.yml
@@ -4,8 +4,4 @@ name: azure-mgmt-rdbms
fullName: azure-mgmt-rdbms
type: distribution
packages:
-- azure.mgmt.rdbms.mariadb
-- azure.mgmt.rdbms.mysql
-- azure.mgmt.rdbms.mysql_flexibleservers
-- azure.mgmt.rdbms.postgresql
-- azure.mgmt.rdbms.postgresql_flexibleservers
+- azure.mgmt.rdbms
diff --git a/preview/docs-ref-autogen/azure-mgmt-recoveryservicesbackup/azure.mgmt.recoveryservicesbackup.yml b/preview/docs-ref-autogen/azure-mgmt-recoveryservicesbackup/azure.mgmt.recoveryservicesbackup.yml
new file mode 100644
index 000000000000..725e57b89eb0
--- /dev/null
+++ b/preview/docs-ref-autogen/azure-mgmt-recoveryservicesbackup/azure.mgmt.recoveryservicesbackup.yml
@@ -0,0 +1,8 @@
+### YamlMime:PythonPackage
+uid: azure.mgmt.recoveryservicesbackup
+name: recoveryservicesbackup
+fullName: azure.mgmt.recoveryservicesbackup
+type: import
+packages:
+- azure.mgmt.recoveryservicesbackup.activestamp
+- azure.mgmt.recoveryservicesbackup.passivestamp
diff --git a/preview/docs-ref-autogen/azure-mgmt-recoveryservicesbackup/index.yml b/preview/docs-ref-autogen/azure-mgmt-recoveryservicesbackup/index.yml
index 84fb1e9b0f48..aa50fe5ed5fb 100644
--- a/preview/docs-ref-autogen/azure-mgmt-recoveryservicesbackup/index.yml
+++ b/preview/docs-ref-autogen/azure-mgmt-recoveryservicesbackup/index.yml
@@ -4,5 +4,4 @@ name: azure-mgmt-recoveryservicesbackup
fullName: azure-mgmt-recoveryservicesbackup
type: distribution
packages:
-- azure.mgmt.recoveryservicesbackup.activestamp
-- azure.mgmt.recoveryservicesbackup.passivestamp
+- azure.mgmt.recoveryservicesbackup
diff --git a/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.LogsQueryClient.yml b/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.LogsQueryClient.yml
index 122401377069..4c5f3ec42968 100644
--- a/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.LogsQueryClient.yml
+++ b/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.LogsQueryClient.yml
@@ -35,13 +35,14 @@ constructor:
examples:
- "Creating the LogsQueryClient with a TokenCredential.<!--[!code-python[Main](les\\\
sample_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\":\
- \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\source_code\\\\233\\\\azure-monitor-query-1.3.0b1\\\\samples\\\
- \\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
- language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false}\
- \ -->\n\n````python\n\n from azure.identity import DefaultAzureCredential\n \
- \ from azure.monitor.query import LogsQueryClient\n\n credential = DefaultAzureCredential()\n\
- \ client = LogsQueryClient(credential)\n\n ````\n"
+ \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\233\\\\azure-monitor-query-1.3.0b1\\\\samples\\\\sample_authentication.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
+ \ import DefaultAzureCredential\n from azure.monitor.query import LogsQueryClient\n\
+ \n credential = DefaultAzureCredential()\n client = LogsQueryClient(credential)\n\
+ \n ````\n"
methods:
- uid: azure.monitor.query.LogsQueryClient.close
name: close
@@ -81,35 +82,36 @@ methods:
examples:
- "Execute multiple queries in a batch.<!--[!code-python[Main](les\\sample_batch_query.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\233\\\\azure-monitor-query-1.3.0b1\\\\samples\\\\sample_batch_query.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from datetime import datetime, timedelta, timezone\n import os\n\n from\
- \ azure.core.exceptions import HttpResponseError\n from azure.identity import\
- \ DefaultAzureCredential\n from azure.monitor.query import LogsQueryClient,\
- \ LogsBatchQuery, LogsQueryStatus\n import pandas as pd\n\n\n credential =\
- \ DefaultAzureCredential()\n client = LogsQueryClient(credential)\n\n requests\
- \ = [\n LogsBatchQuery(\n query=\"AzureActivity | summarize count()\"\
- ,\n timespan=timedelta(hours=1),\n workspace_id=os.environ[\"\
- LOGS_WORKSPACE_ID\"],\n ),\n LogsBatchQuery(query=\"bad query\", timespan=timedelta(days=1),\
- \ workspace_id=os.environ[\"LOGS_WORKSPACE_ID\"]),\n LogsBatchQuery(\n \
- \ query=\"\"\"let Weight = 92233720368547758;\n range x from\
- \ 1 to 3 step 1\n | summarize percentilesw(x, Weight * 100, 50)\"\"\"\
- ,\n workspace_id=os.environ[\"LOGS_WORKSPACE_ID\"],\n timespan=(datetime(2021,\
- \ 6, 2, tzinfo=timezone.utc), datetime(2021, 6, 5, tzinfo=timezone.utc)), # (start,\
- \ end)\n include_statistics=True,\n ),\n ]\n\n try:\n \
- \ results = client.query_batch(requests)\n\n for res in results:\n \
- \ if res.status == LogsQueryStatus.FAILURE:\n # This will\
- \ be a LogsQueryError\n print(res)\n elif res.status ==\
- \ LogsQueryStatus.PARTIAL:\n # This will be a LogsQueryPartialResult\n\
- \ print(res.partial_error)\n for table in res.partial_data:\n\
- \ df = pd.DataFrame(table.rows, columns=table.columns)\n \
- \ print(df)\n elif res.status == LogsQueryStatus.SUCCESS:\n\
- \ # This will be a LogsQueryResult\n table = res.tables[0]\n\
- \ df = pd.DataFrame(table.rows, columns=table.columns)\n \
- \ print(df)\n except HttpResponseError as err:\n print(\"something\
- \ fatal happened\")\n print(err)\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 233\\\\azure-monitor-query-1.3.0b1\\\\samples\\\\sample_batch_query.py\", \"xml:space\"\
+ : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from datetime\
+ \ import datetime, timedelta, timezone\n import os\n\n from azure.core.exceptions\
+ \ import HttpResponseError\n from azure.identity import DefaultAzureCredential\n\
+ \ from azure.monitor.query import LogsQueryClient, LogsBatchQuery, LogsQueryStatus\n\
+ \ import pandas as pd\n\n\n credential = DefaultAzureCredential()\n client\
+ \ = LogsQueryClient(credential)\n\n requests = [\n LogsBatchQuery(\n \
+ \ query=\"AzureActivity | summarize count()\",\n timespan=timedelta(hours=1),\n\
+ \ workspace_id=os.environ[\"LOGS_WORKSPACE_ID\"],\n ),\n \
+ \ LogsBatchQuery(query=\"bad query\", timespan=timedelta(days=1), workspace_id=os.environ[\"\
+ LOGS_WORKSPACE_ID\"]),\n LogsBatchQuery(\n query=\"\"\"let Weight\
+ \ = 92233720368547758;\n range x from 1 to 3 step 1\n | summarize\
+ \ percentilesw(x, Weight * 100, 50)\"\"\",\n workspace_id=os.environ[\"\
+ LOGS_WORKSPACE_ID\"],\n timespan=(datetime(2021, 6, 2, tzinfo=timezone.utc),\
+ \ datetime(2021, 6, 5, tzinfo=timezone.utc)), # (start, end)\n include_statistics=True,\n\
+ \ ),\n ]\n\n try:\n results = client.query_batch(requests)\n\n\
+ \ for res in results:\n if res.status == LogsQueryStatus.FAILURE:\n\
+ \ # This will be a LogsQueryError\n print(res)\n \
+ \ elif res.status == LogsQueryStatus.PARTIAL:\n # This\
+ \ will be a LogsQueryPartialResult\n print(res.partial_error)\n\
+ \ for table in res.partial_data:\n df = pd.DataFrame(table.rows,\
+ \ columns=table.columns)\n print(df)\n elif res.status\
+ \ == LogsQueryStatus.SUCCESS:\n # This will be a LogsQueryResult\n\
+ \ table = res.tables[0]\n df = pd.DataFrame(table.rows,\
+ \ columns=table.columns)\n print(df)\n except HttpResponseError\
+ \ as err:\n print(\"something fatal happened\")\n print(err)\n\n \
+ \ ````\n"
- uid: azure.monitor.query.LogsQueryClient.query_resource
name: query_resource
summary: 'Execute a Kusto query on a resource.
@@ -182,23 +184,23 @@ methods:
examples:
- "Get a response for a single query on a resource's logs.<!--[!code-python[Main](les\\\
sample_resource_logs_query.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\233\\\\azure-monitor-query-1.3.0b1\\\\\
- samples\\\\sample_resource_logs_query.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n from datetime import timedelta\n import\
- \ os\n\n from azure.core.exceptions import HttpResponseError\n from azure.identity\
- \ import DefaultAzureCredential\n from azure.monitor.query import LogsQueryClient,\
- \ LogsQueryStatus\n import pandas as pd\n\n\n credential = DefaultAzureCredential()\n\
- \ client = LogsQueryClient(credential)\n\n query = \"AzureActivity | take\
- \ 5\"\n\n try:\n response = client.query_resource(os.environ[\"LOGS_RESOURCE_ID\"\
- ], query, timespan=timedelta(days=1))\n if response.status == LogsQueryStatus.PARTIAL:\n\
- \ error = response.partial_error\n data = response.partial_data\n\
- \ print(error)\n elif response.status == LogsQueryStatus.SUCCESS:\n\
- \ data = response.tables\n for table in data:\n df =\
- \ pd.DataFrame(data=table.rows, columns=table.columns)\n print(df)\n\
- \ except HttpResponseError as err:\n print(\"something fatal happened\"\
- )\n print(err)\n\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\233\\\\azure-monitor-query-1.3.0b1\\\\samples\\\\sample_resource_logs_query.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from datetime import timedelta\n import os\n\n from azure.core.exceptions\
+ \ import HttpResponseError\n from azure.identity import DefaultAzureCredential\n\
+ \ from azure.monitor.query import LogsQueryClient, LogsQueryStatus\n import\
+ \ pandas as pd\n\n\n credential = DefaultAzureCredential()\n client = LogsQueryClient(credential)\n\
+ \n query = \"AzureActivity | take 5\"\n\n try:\n response = client.query_resource(os.environ[\"\
+ LOGS_RESOURCE_ID\"], query, timespan=timedelta(days=1))\n if response.status\
+ \ == LogsQueryStatus.PARTIAL:\n error = response.partial_error\n \
+ \ data = response.partial_data\n print(error)\n elif response.status\
+ \ == LogsQueryStatus.SUCCESS:\n data = response.tables\n for table\
+ \ in data:\n df = pd.DataFrame(data=table.rows, columns=table.columns)\n\
+ \ print(df)\n except HttpResponseError as err:\n print(\"something\
+ \ fatal happened\")\n print(err)\n\n\n ````\n"
- uid: azure.monitor.query.LogsQueryClient.query_workspace
name: query_workspace
summary: 'Execute a Kusto query.
@@ -271,8 +273,9 @@ methods:
examples:
- "Get a response for a single log query.<!--[!code-python[Main](les\\sample_logs_single_query.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\233\\\\azure-monitor-query-1.3.0b1\\\\samples\\\\sample_logs_single_query.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 233\\\\azure-monitor-query-1.3.0b1\\\\samples\\\\sample_logs_single_query.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from datetime import timedelta\n import os\n\n from azure.core.exceptions\
diff --git a/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.MetricsBatchQueryClient.yml b/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.MetricsBatchQueryClient.yml
index 3a762020bb56..ae9919b6cb53 100644
--- a/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.MetricsBatchQueryClient.yml
+++ b/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.MetricsBatchQueryClient.yml
@@ -137,8 +137,9 @@ methods:
examples:
- "Get a response for a batch metrics query.<!--[!code-python[Main](les\\sample_metrics_batch_query.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\233\\\\azure-monitor-query-1.3.0b1\\\\samples\\\\sample_metrics_batch_query.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 233\\\\azure-monitor-query-1.3.0b1\\\\samples\\\\sample_metrics_batch_query.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from datetime import timedelta\n import os\n\n from azure.core.exceptions\
diff --git a/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.MetricsQueryClient.yml b/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.MetricsQueryClient.yml
index 28dba9f95650..4163ad8cc111 100644
--- a/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.MetricsQueryClient.yml
+++ b/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.MetricsQueryClient.yml
@@ -33,13 +33,14 @@ constructor:
examples:
- "Creating the MetricsQueryClient with a TokenCredential.<!--[!code-python[Main](les\\\
sample_authentication.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\":\
- \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\source_code\\\\233\\\\azure-monitor-query-1.3.0b1\\\\samples\\\
- \\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\": false, \"\
- language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\": false}\
- \ -->\n\n````python\n\n from azure.identity import DefaultAzureCredential\n \
- \ from azure.monitor.query import MetricsQueryClient\n\n credential = DefaultAzureCredential()\n\
- \ client = MetricsQueryClient(credential)\n\n ````\n"
+ \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\233\\\\azure-monitor-query-1.3.0b1\\\\samples\\\\sample_authentication.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity\
+ \ import DefaultAzureCredential\n from azure.monitor.query import MetricsQueryClient\n\
+ \n credential = DefaultAzureCredential()\n client = MetricsQueryClient(credential)\n\
+ \n ````\n"
methods:
- uid: azure.monitor.query.MetricsQueryClient.close
name: close
@@ -69,14 +70,15 @@ methods:
examples:
- "Get a response for a single metric definitions query.<!--[!code-python[Main](les\\\
sample_metric_definitions.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\233\\\\azure-monitor-query-1.3.0b1\\\\\
- samples\\\\sample_metric_definitions.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n import os\n\n from azure.identity\
- \ import DefaultAzureCredential\n from azure.monitor.query import MetricsQueryClient\n\
- \n\n credential = DefaultAzureCredential()\n client = MetricsQueryClient(credential)\n\
- \n metrics_uri = os.environ[\"METRICS_RESOURCE_URI\"]\n response = client.list_metric_definitions(metrics_uri,\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\233\\\\azure-monitor-query-1.3.0b1\\\\samples\\\\sample_metric_definitions.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n import os\n\n from azure.identity import DefaultAzureCredential\n from\
+ \ azure.monitor.query import MetricsQueryClient\n\n\n credential = DefaultAzureCredential()\n\
+ \ client = MetricsQueryClient(credential)\n\n metrics_uri = os.environ[\"\
+ METRICS_RESOURCE_URI\"]\n response = client.list_metric_definitions(metrics_uri,\
\ namespace=\"microsoft.eventgrid/topics\")\n\n for item in response:\n \
\ print(item.name)\n for availability in item.metric_availabilities:\n\
\ print(availability.granularity)\n\n\n ````\n"
@@ -106,14 +108,15 @@ methods:
examples:
- "Get a response for a single metric namespaces query.<!--[!code-python[Main](les\\\
sample_metric_namespaces.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\233\\\\azure-monitor-query-1.3.0b1\\\\\
- samples\\\\sample_metric_namespaces.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n import os\n\n from azure.identity\
- \ import DefaultAzureCredential\n from azure.monitor.query import MetricsQueryClient\n\
- \n\n credential = DefaultAzureCredential()\n client = MetricsQueryClient(credential)\n\
- \n metrics_uri = os.environ[\"METRICS_RESOURCE_URI\"]\n response = client.list_metric_namespaces(metrics_uri)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\233\\\\azure-monitor-query-1.3.0b1\\\\samples\\\\sample_metric_namespaces.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n import os\n\n from azure.identity import DefaultAzureCredential\n from\
+ \ azure.monitor.query import MetricsQueryClient\n\n\n credential = DefaultAzureCredential()\n\
+ \ client = MetricsQueryClient(credential)\n\n metrics_uri = os.environ[\"\
+ METRICS_RESOURCE_URI\"]\n response = client.list_metric_namespaces(metrics_uri)\n\
\n for item in response:\n print(item.fully_qualified_namespace)\n \
\ print(item.type)\n\n\n ````\n"
- uid: azure.monitor.query.MetricsQueryClient.query_resource
@@ -215,18 +218,19 @@ methods:
examples:
- "Get a response for a single metrics query.<!--[!code-python[Main](les\\sample_metrics_query.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\233\\\\azure-monitor-query-1.3.0b1\\\\samples\\\\sample_metrics_query.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from datetime import timedelta\n import os\n\n from azure.identity import\
- \ DefaultAzureCredential\n from azure.monitor.query import MetricsQueryClient,\
- \ MetricAggregationType\n\n\n credential = DefaultAzureCredential()\n client\
- \ = MetricsQueryClient(credential)\n\n metrics_uri = os.environ[\"METRICS_RESOURCE_URI\"\
- ]\n response = client.query_resource(\n metrics_uri,\n metric_names=[\"\
- Ingress\"],\n timespan=timedelta(hours=2),\n granularity=timedelta(minutes=5),\n\
- \ aggregations=[MetricAggregationType.AVERAGE],\n )\n\n for metric in\
- \ response.metrics:\n print(metric.name + \" -- \" + metric.display_description)\n\
- \ for time_series_element in metric.timeseries:\n for metric_value\
- \ in time_series_element.data:\n print(\"The ingress at {} is {}\"\
- .format(metric_value.timestamp, metric_value.average))\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 233\\\\azure-monitor-query-1.3.0b1\\\\samples\\\\sample_metrics_query.py\", \"\
+ xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from datetime\
+ \ import timedelta\n import os\n\n from azure.identity import DefaultAzureCredential\n\
+ \ from azure.monitor.query import MetricsQueryClient, MetricAggregationType\n\
+ \n\n credential = DefaultAzureCredential()\n client = MetricsQueryClient(credential)\n\
+ \n metrics_uri = os.environ[\"METRICS_RESOURCE_URI\"]\n response = client.query_resource(\n\
+ \ metrics_uri,\n metric_names=[\"Ingress\"],\n timespan=timedelta(hours=2),\n\
+ \ granularity=timedelta(minutes=5),\n aggregations=[MetricAggregationType.AVERAGE],\n\
+ \ )\n\n for metric in response.metrics:\n print(metric.name + \" --\
+ \ \" + metric.display_description)\n for time_series_element in metric.timeseries:\n\
+ \ for metric_value in time_series_element.data:\n print(\"\
+ The ingress at {} is {}\".format(metric_value.timestamp, metric_value.average))\n\
+ \n ````\n"
diff --git a/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.aio.LogsQueryClient.yml b/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.aio.LogsQueryClient.yml
index 6cd07e2b669a..efea5ddf2723 100644
--- a/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.aio.LogsQueryClient.yml
+++ b/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.aio.LogsQueryClient.yml
@@ -36,13 +36,13 @@ examples:
- "Creating the asynchronous LogsQueryClient with a TokenCredential.<!--[!code-python[Main](les\\\
async_samples\\sample_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\233\\\\azure-monitor-query-1.3.0b1\\\
- \\samples\\\\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import DefaultAzureCredential\n from azure.monitor.query.aio import LogsQueryClient\n\
- \n credential = DefaultAzureCredential()\n client = LogsQueryClient(credential)\n\
- \n ````\n"
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\233\\\\azure-monitor-query-1.3.0b1\\\\samples\\\\async_samples\\\
+ \\sample_authentication_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.identity.aio import DefaultAzureCredential\n\
+ \ from azure.monitor.query.aio import LogsQueryClient\n\n credential = DefaultAzureCredential()\n\
+ \ client = LogsQueryClient(credential)\n\n ````\n"
methods:
- uid: azure.monitor.query.aio.LogsQueryClient.close
name: close
@@ -84,13 +84,14 @@ methods:
examples:
- "Execute multiple queries in a batch.<!--[!code-python[Main](les\\async_samples\\\
sample_batch_query_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\233\\\\azure-monitor-query-1.3.0b1\\\\\
- samples\\\\async_samples\\\\sample_batch_query_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from datetime import datetime,\
- \ timedelta, timezone\n import os\n\n from azure.core.exceptions import HttpResponseError\n\
- \ from azure.identity.aio import DefaultAzureCredential\n from azure.monitor.query.aio\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\233\\\\azure-monitor-query-1.3.0b1\\\\samples\\\\async_samples\\\
+ \\sample_batch_query_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from datetime import datetime, timedelta, timezone\n\
+ \ import os\n\n from azure.core.exceptions import HttpResponseError\n from\
+ \ azure.identity.aio import DefaultAzureCredential\n from azure.monitor.query.aio\
\ import LogsQueryClient\n from azure.monitor.query import LogsBatchQuery,\
\ LogsQueryStatus\n import pandas as pd\n\n\n async def logs_batch_query():\n\
\ credential = DefaultAzureCredential()\n client = LogsQueryClient(credential)\n\
@@ -190,7 +191,8 @@ methods:
- "Get a response for a single query on a resource's logs.<!--[!code-python[Main](les\\\
async_samples\\sample_resource_logs_query_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\233\\\\azure-monitor-query-1.3.0b1\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\233\\\\azure-monitor-query-1.3.0b1\\\
\\samples\\\\async_samples\\\\sample_resource_logs_query_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from datetime\
@@ -283,16 +285,17 @@ methods:
examples:
- "Get a response for a single log query.<!--[!code-python[Main](les\\async_samples\\\
sample_log_query_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\233\\\\azure-monitor-query-1.3.0b1\\\\\
- samples\\\\async_samples\\\\sample_log_query_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from datetime import timedelta\n\
- \ import os\n\n from azure.core.exceptions import HttpResponseError\n from\
- \ azure.identity.aio import DefaultAzureCredential\n from azure.monitor.query.aio\
- \ import LogsQueryClient\n from azure.monitor.query import LogsQueryStatus\n\
- \ import pandas as pd\n\n\n async def logs_query():\n credential = DefaultAzureCredential()\n\
- \ client = LogsQueryClient(credential)\n\n query = \"AppRequests |\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\233\\\\azure-monitor-query-1.3.0b1\\\\samples\\\\async_samples\\\
+ \\sample_log_query_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from datetime import timedelta\n import os\n\
+ \n from azure.core.exceptions import HttpResponseError\n from azure.identity.aio\
+ \ import DefaultAzureCredential\n from azure.monitor.query.aio import LogsQueryClient\n\
+ \ from azure.monitor.query import LogsQueryStatus\n import pandas as pd\n\n\
+ \n async def logs_query():\n credential = DefaultAzureCredential()\n \
+ \ client = LogsQueryClient(credential)\n\n query = \"AppRequests |\
\ take 5\"\n\n async with client:\n try:\n response\
\ = await client.query_workspace(os.environ[\"LOGS_WORKSPACE_ID\"], query, timespan=timedelta(days=1))\n\
\ if response.status == LogsQueryStatus.PARTIAL:\n \
diff --git a/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.aio.MetricsBatchQueryClient.yml b/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.aio.MetricsBatchQueryClient.yml
index 8661b7274824..f233351c78b8 100644
--- a/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.aio.MetricsBatchQueryClient.yml
+++ b/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.aio.MetricsBatchQueryClient.yml
@@ -138,14 +138,15 @@ methods:
- "Get a response for a batch metrics query.<!--[!code-python[Main](les\\async_samples\\\
sample_metrics_batch_query_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\233\\\\azure-monitor-query-1.3.0b1\\\
- \\samples\\\\async_samples\\\\sample_metrics_batch_query_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from datetime\
- \ import timedelta\n import os\n\n from azure.core.exceptions import HttpResponseError\n\
- \ from azure.identity.aio import DefaultAzureCredential\n from azure.monitor.query\
- \ import MetricAggregationType\n from azure.monitor.query.aio import MetricsBatchQueryClient\n\
- \n\n async def query_metrics_batch():\n endpoint = os.environ[\"AZURE_METRICS_ENDPOINT\"\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\233\\\\azure-monitor-query-1.3.0b1\\\\samples\\\\async_samples\\\
+ \\sample_metrics_batch_query_async.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from datetime import timedelta\n import\
+ \ os\n\n from azure.core.exceptions import HttpResponseError\n from azure.identity.aio\
+ \ import DefaultAzureCredential\n from azure.monitor.query import MetricAggregationType\n\
+ \ from azure.monitor.query.aio import MetricsBatchQueryClient\n\n\n async\
+ \ def query_metrics_batch():\n endpoint = os.environ[\"AZURE_METRICS_ENDPOINT\"\
]\n\n credential = DefaultAzureCredential()\n client = MetricsBatchQueryClient(endpoint,\
\ credential)\n\n resource_uris = [\n '/subscriptions/<id>/resourceGroups/<rg>/providers/Microsoft.Storage/storageAccounts/<account-1>',\n\
\ '/subscriptions/<id>/resourceGroups/<rg>/providers/Microsoft.Storage/storageAccounts/<account-2>'\n\
diff --git a/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.aio.MetricsQueryClient.yml b/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.aio.MetricsQueryClient.yml
index 2bf7d33601c4..f487fcdbd671 100644
--- a/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.aio.MetricsQueryClient.yml
+++ b/preview/docs-ref-autogen/azure-monitor-query/azure.monitor.query.aio.MetricsQueryClient.yml
@@ -21,13 +21,13 @@ examples:
- "Creating the asynchronous MetricsQueryClient with a TokenCredential.<!--[!code-python[Main](les\\\
async_samples\\sample_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\233\\\\azure-monitor-query-1.3.0b1\\\
- \\samples\\\\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.identity.aio\
- \ import DefaultAzureCredential\n from azure.monitor.query.aio import MetricsQueryClient\n\
- \n credential = DefaultAzureCredential()\n client = MetricsQueryClient(credential)\n\
- \n ````\n"
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\233\\\\azure-monitor-query-1.3.0b1\\\\samples\\\\async_samples\\\
+ \\sample_authentication_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from azure.identity.aio import DefaultAzureCredential\n\
+ \ from azure.monitor.query.aio import MetricsQueryClient\n\n credential = DefaultAzureCredential()\n\
+ \ client = MetricsQueryClient(credential)\n\n ````\n"
methods:
- uid: azure.monitor.query.aio.MetricsQueryClient.close
name: close
@@ -58,7 +58,8 @@ methods:
- "Get a response for a single metric definitions query.<!--[!code-python[Main](les\\\
async_samples\\sample_metric_definitions_async.py )]-->\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\233\\\\azure-monitor-query-1.3.0b1\\\
+ : [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\
+ \\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\233\\\\azure-monitor-query-1.3.0b1\\\
\\samples\\\\async_samples\\\\sample_metric_definitions_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -100,7 +101,8 @@ methods:
- "Get a response for a single metric namespaces query.<!--[!code-python[Main](les\\\
async_samples\\sample_metric_namespaces_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\233\\\\azure-monitor-query-1.3.0b1\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\233\\\\azure-monitor-query-1.3.0b1\\\
\\samples\\\\async_samples\\\\sample_metric_namespaces_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -220,23 +222,24 @@ methods:
examples:
- "Get a response for a single metrics query.<!--[!code-python[Main](les\\async_samples\\\
sample_metrics_query_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\233\\\\azure-monitor-query-1.3.0b1\\\\\
- samples\\\\async_samples\\\\sample_metrics_query_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from datetime import\
- \ timedelta\n import os\n\n from azure.core.exceptions import HttpResponseError\n\
- \ from azure.identity.aio import DefaultAzureCredential\n from azure.monitor.query.aio\
- \ import MetricsQueryClient\n from azure.monitor.query import MetricAggregationType\n\
- \n\n async def query_metrics():\n credential = DefaultAzureCredential()\n\
- \ client = MetricsQueryClient(credential)\n\n metrics_uri = os.environ[\"\
- METRICS_RESOURCE_URI\"]\n async with client:\n try:\n \
- \ response = await client.query_resource(\n metrics_uri,\n\
- \ metric_names=[\"Ingress\"],\n timespan=timedelta(hours=2),\n\
- \ granularity=timedelta(minutes=15),\n aggregations=[MetricAggregationType.AVERAGE],\n\
- \ )\n\n for metric in response.metrics:\n \
- \ print(metric.name)\n for time_series_element in\
- \ metric.timeseries:\n for metric_value in time_series_element.data:\n\
- \ print(metric_value.timestamp)\n except HttpResponseError\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\233\\\\azure-monitor-query-1.3.0b1\\\\samples\\\\async_samples\\\
+ \\sample_metrics_query_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n from datetime import timedelta\n import os\n\
+ \n from azure.core.exceptions import HttpResponseError\n from azure.identity.aio\
+ \ import DefaultAzureCredential\n from azure.monitor.query.aio import MetricsQueryClient\n\
+ \ from azure.monitor.query import MetricAggregationType\n\n\n async def query_metrics():\n\
+ \ credential = DefaultAzureCredential()\n client = MetricsQueryClient(credential)\n\
+ \n metrics_uri = os.environ[\"METRICS_RESOURCE_URI\"]\n async with\
+ \ client:\n try:\n response = await client.query_resource(\n\
+ \ metrics_uri,\n metric_names=[\"Ingress\"\
+ ],\n timespan=timedelta(hours=2),\n granularity=timedelta(minutes=15),\n\
+ \ aggregations=[MetricAggregationType.AVERAGE],\n \
+ \ )\n\n for metric in response.metrics:\n \
+ \ print(metric.name)\n for time_series_element in metric.timeseries:\n\
+ \ for metric_value in time_series_element.data:\n \
+ \ print(metric_value.timestamp)\n except HttpResponseError\
\ as err:\n print(\"something fatal happened\")\n \
\ print(err)\n await credential.close()\n\n\n ````\n"
diff --git a/preview/docs-ref-autogen/azure-purview-administration/azure.purview.administration.yml b/preview/docs-ref-autogen/azure-purview-administration/azure.purview.administration.yml
new file mode 100644
index 000000000000..edd7de2a2967
--- /dev/null
+++ b/preview/docs-ref-autogen/azure-purview-administration/azure.purview.administration.yml
@@ -0,0 +1,8 @@
+### YamlMime:PythonPackage
+uid: azure.purview.administration
+name: administration
+fullName: azure.purview.administration
+type: import
+packages:
+- azure.purview.administration.account
+- azure.purview.administration.metadatapolicies
diff --git a/preview/docs-ref-autogen/azure-purview-administration/index.yml b/preview/docs-ref-autogen/azure-purview-administration/index.yml
index bfc08e58cf1a..834fecdc3326 100644
--- a/preview/docs-ref-autogen/azure-purview-administration/index.yml
+++ b/preview/docs-ref-autogen/azure-purview-administration/index.yml
@@ -4,5 +4,4 @@ name: azure-purview-administration
fullName: azure-purview-administration
type: distribution
packages:
-- azure.purview.administration.account
-- azure.purview.administration.metadatapolicies
+- azure.purview.administration
diff --git a/preview/docs-ref-autogen/azure-schemaregistry-avroserializer/azure.schemaregistry.serializer.yml b/preview/docs-ref-autogen/azure-schemaregistry-avroserializer/azure.schemaregistry.serializer.yml
new file mode 100644
index 000000000000..33da6d4dc131
--- /dev/null
+++ b/preview/docs-ref-autogen/azure-schemaregistry-avroserializer/azure.schemaregistry.serializer.yml
@@ -0,0 +1,7 @@
+### YamlMime:PythonPackage
+uid: azure.schemaregistry.serializer
+name: serializer
+fullName: azure.schemaregistry.serializer
+type: import
+packages:
+- azure.schemaregistry.serializer.avroserializer
diff --git a/preview/docs-ref-autogen/azure-schemaregistry-avroserializer/index.yml b/preview/docs-ref-autogen/azure-schemaregistry-avroserializer/index.yml
index 9c405fc23028..a4064bdfa31c 100644
--- a/preview/docs-ref-autogen/azure-schemaregistry-avroserializer/index.yml
+++ b/preview/docs-ref-autogen/azure-schemaregistry-avroserializer/index.yml
@@ -4,6 +4,6 @@ name: azure-schemaregistry-avroserializer
fullName: azure-schemaregistry-avroserializer
type: distribution
packages:
-- azure.schemaregistry.serializer.avroserializer
+- azure.schemaregistry.serializer
modules:
- azure.schemaregistry.serializer.avroserializer.exceptions
diff --git a/preview/docs-ref-autogen/azure-schemaregistry/azure.schemaregistry.SchemaRegistryClient.yml b/preview/docs-ref-autogen/azure-schemaregistry/azure.schemaregistry.SchemaRegistryClient.yml
index 3b92e7390ad0..558828a978b9 100644
--- a/preview/docs-ref-autogen/azure-schemaregistry/azure.schemaregistry.SchemaRegistryClient.yml
+++ b/preview/docs-ref-autogen/azure-schemaregistry/azure.schemaregistry.SchemaRegistryClient.yml
@@ -33,12 +33,12 @@ examples:
- "Create a new instance of the SchemaRegistryClient.<!--[!code-python[Main](les\\\
sync_samples\\sample_code_schemaregistry.py )]-->\n\n<!-- literal_block {\"ids\"\
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\240\\\\azure-schemaregistry-1.3.0b2\\\
- \\samples\\\\sync_samples\\\\sample_code_schemaregistry.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n SCHEMAREGISTRY_FQN\
- \ = os.environ[\"SCHEMAREGISTRY_AVRO_FULLY_QUALIFIED_NAMESPACE\"]\n token_credential\
- \ = DefaultAzureCredential()\n schema_registry_client = SchemaRegistryClient(\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\240\\\\azure-schemaregistry-1.3.0b2\\\\samples\\\\sync_samples\\\
+ \\sample_code_schemaregistry.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n SCHEMAREGISTRY_FQN = os.environ[\"SCHEMAREGISTRY_AVRO_FULLY_QUALIFIED_NAMESPACE\"\
+ ]\n token_credential = DefaultAzureCredential()\n schema_registry_client = SchemaRegistryClient(\n\
\ fully_qualified_namespace=SCHEMAREGISTRY_FQN, credential=token_credential\n\
\ )\n\n ````\n"
methods:
@@ -95,19 +95,20 @@ methods:
examples:
- "Get schema by id.<!--[!code-python[Main](les\\sync_samples\\sample_code_schemaregistry.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\240\\\\azure-schemaregistry-1.3.0b2\\\\samples\\\\sync_samples\\\\\
- sample_code_schemaregistry.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n schema = schema_registry_client.get_schema(schema_id)\n\
- \ definition = schema.definition\n properties = schema.properties\n\n ````\n\
- \nGet schema by version.<!--[!code-python[Main](les\\sync_samples\\sample_code_schemaregistry.py\
- \ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\240\\\\azure-schemaregistry-1.3.0b2\\\\samples\\\\sync_samples\\\\\
- sample_code_schemaregistry.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n group_name = os.environ[\"SCHEMAREGISTRY_GROUP\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 240\\\\azure-schemaregistry-1.3.0b2\\\\samples\\\\sync_samples\\\\sample_code_schemaregistry.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n schema = schema_registry_client.get_schema(schema_id)\n definition = schema.definition\n\
+ \ properties = schema.properties\n\n ````\n\nGet schema by version.<!--[!code-python[Main](les\\\
+ sync_samples\\sample_code_schemaregistry.py )]-->\n\n<!-- literal_block {\"ids\"\
+ : [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\240\\\\azure-schemaregistry-1.3.0b2\\\\samples\\\\\
+ sync_samples\\\\sample_code_schemaregistry.py\", \"xml:space\": \"preserve\",\
+ \ \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n group_name = os.environ[\"SCHEMAREGISTRY_GROUP\"\
]\n name = \"your-schema-name\"\n schema = schema_registry_client.get_schema(group_name=group_name,\
\ name=name, version=version)\n definition = schema.definition\n properties\
\ = schema.properties\n\n ````\n"
@@ -150,20 +151,20 @@ methods:
examples:
- "Get schema id.<!--[!code-python[Main](les\\sync_samples\\sample_code_schemaregistry.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\240\\\\azure-schemaregistry-1.3.0b2\\\\samples\\\\sync_samples\\\\\
- sample_code_schemaregistry.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n group_name = os.environ[\"SCHEMAREGISTRY_GROUP\"\
- ]\n name = \"your-schema-name\"\n format = \"Avro\"\n schema_json = {\n\
- \ \"namespace\": \"example.avro\",\n \"type\": \"record\",\n \
- \ \"name\": \"User\",\n \"fields\": [\n {\"name\": \"name\",\
- \ \"type\": \"string\"},\n {\"name\": \"favorite_number\", \"type\"\
- : [\"int\", \"null\"]},\n {\"name\": \"favorite_color\", \"type\": [\"\
- string\", \"null\"]},\n ],\n }\n definition = json.dumps(schema_json,\
- \ separators=(\",\", \":\"))\n schema_properties = schema_registry_client.get_schema_properties(\n\
- \ group_name, name, definition, format\n )\n schema_id = schema_properties.id\n\
- \n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 240\\\\azure-schemaregistry-1.3.0b2\\\\samples\\\\sync_samples\\\\sample_code_schemaregistry.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n group_name = os.environ[\"SCHEMAREGISTRY_GROUP\"]\n name = \"your-schema-name\"\
+ \n format = \"Avro\"\n schema_json = {\n \"namespace\": \"example.avro\"\
+ ,\n \"type\": \"record\",\n \"name\": \"User\",\n \"fields\"\
+ : [\n {\"name\": \"name\", \"type\": \"string\"},\n {\"name\"\
+ : \"favorite_number\", \"type\": [\"int\", \"null\"]},\n {\"name\":\
+ \ \"favorite_color\", \"type\": [\"string\", \"null\"]},\n ],\n }\n \
+ \ definition = json.dumps(schema_json, separators=(\",\", \":\"))\n schema_properties\
+ \ = schema_registry_client.get_schema_properties(\n group_name, name, definition,\
+ \ format\n )\n schema_id = schema_properties.id\n\n ````\n"
- uid: azure.schemaregistry.SchemaRegistryClient.register_schema
name: register_schema
summary: 'Register new schema. If schema of specified name does not exist in specified
@@ -207,17 +208,17 @@ methods:
examples:
- "Register a new schema.<!--[!code-python[Main](les\\sync_samples\\sample_code_schemaregistry.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\240\\\\azure-schemaregistry-1.3.0b2\\\\samples\\\\sync_samples\\\\\
- sample_code_schemaregistry.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n GROUP_NAME = os.environ[\"SCHEMAREGISTRY_GROUP\"\
- ]\n NAME = \"your-schema-name\"\n FORMAT = \"Avro\"\n SCHEMA_JSON = {\n\
- \ \"namespace\": \"example.avro\",\n \"type\": \"record\",\n \
- \ \"name\": \"User\",\n \"fields\": [\n {\"name\": \"name\",\
- \ \"type\": \"string\"},\n {\"name\": \"favorite_number\", \"type\"\
- : [\"int\", \"null\"]},\n {\"name\": \"favorite_color\", \"type\": [\"\
- string\", \"null\"]},\n ],\n }\n DEFINITION = json.dumps(SCHEMA_JSON,\
- \ separators=(\",\", \":\"))\n schema_properties = schema_registry_client.register_schema(\n\
- \ GROUP_NAME, NAME, DEFINITION, FORMAT\n )\n schema_id = schema_properties.id\n\
- \n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 240\\\\azure-schemaregistry-1.3.0b2\\\\samples\\\\sync_samples\\\\sample_code_schemaregistry.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n GROUP_NAME = os.environ[\"SCHEMAREGISTRY_GROUP\"]\n NAME = \"your-schema-name\"\
+ \n FORMAT = \"Avro\"\n SCHEMA_JSON = {\n \"namespace\": \"example.avro\"\
+ ,\n \"type\": \"record\",\n \"name\": \"User\",\n \"fields\"\
+ : [\n {\"name\": \"name\", \"type\": \"string\"},\n {\"name\"\
+ : \"favorite_number\", \"type\": [\"int\", \"null\"]},\n {\"name\":\
+ \ \"favorite_color\", \"type\": [\"string\", \"null\"]},\n ],\n }\n \
+ \ DEFINITION = json.dumps(SCHEMA_JSON, separators=(\",\", \":\"))\n schema_properties\
+ \ = schema_registry_client.register_schema(\n GROUP_NAME, NAME, DEFINITION,\
+ \ FORMAT\n )\n schema_id = schema_properties.id\n\n ````\n"
diff --git a/preview/docs-ref-autogen/azure-schemaregistry/azure.schemaregistry.aio.SchemaRegistryClient.yml b/preview/docs-ref-autogen/azure-schemaregistry/azure.schemaregistry.aio.SchemaRegistryClient.yml
index 820745f873a6..45dc99c80898 100644
--- a/preview/docs-ref-autogen/azure-schemaregistry/azure.schemaregistry.aio.SchemaRegistryClient.yml
+++ b/preview/docs-ref-autogen/azure-schemaregistry/azure.schemaregistry.aio.SchemaRegistryClient.yml
@@ -33,7 +33,8 @@ examples:
- "Create a new instance of the SchemaRegistryClient.<!--[!code-python[Main](les\\\
async_samples\\sample_code_schemaregistry_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"\
- source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\240\\\\azure-schemaregistry-1.3.0b2\\\
+ source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\
+ \\site-packages\\\\py2docfx\\\\dist_temp\\\\240\\\\azure-schemaregistry-1.3.0b2\\\
\\samples\\\\async_samples\\\\sample_code_schemaregistry_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
\ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n SCHEMAREGISTRY_FQN\
@@ -95,22 +96,24 @@ methods:
examples:
- "Get schema by id.<!--[!code-python[Main](les\\async_samples\\sample_code_schemaregistry_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\240\\\\azure-schemaregistry-1.3.0b2\\\\samples\\\\async_samples\\\
- \\sample_code_schemaregistry_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n schema = await schema_registry_client.get_schema(schema_id)\n\
- \ definition = schema.definition\n properties = schema.properties\n\n ````\n\
- \nGet schema by version.<!--[!code-python[Main](les\\async_samples\\sample_code_schemaregistry_async.py\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 240\\\\azure-schemaregistry-1.3.0b2\\\\samples\\\\async_samples\\\\sample_code_schemaregistry_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n schema = await schema_registry_client.get_schema(schema_id)\n definition\
+ \ = schema.definition\n properties = schema.properties\n\n ````\n\nGet schema\
+ \ by version.<!--[!code-python[Main](les\\async_samples\\sample_code_schemaregistry_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\240\\\\azure-schemaregistry-1.3.0b2\\\\samples\\\\async_samples\\\
- \\sample_code_schemaregistry_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n group_name = os.environ[\"SCHEMAREGISTRY_GROUP\"\
- ]\n name = \"your-schema-name\"\n schema = await schema_registry_client.get_schema(group_name=group_name,\
- \ name=name, version=version)\n definition = schema.definition\n properties\
- \ = schema.properties\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 240\\\\azure-schemaregistry-1.3.0b2\\\\samples\\\\async_samples\\\\sample_code_schemaregistry_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n group_name = os.environ[\"SCHEMAREGISTRY_GROUP\"]\n name = \"your-schema-name\"\
+ \n schema = await schema_registry_client.get_schema(group_name=group_name, name=name,\
+ \ version=version)\n definition = schema.definition\n properties = schema.properties\n\
+ \n ````\n"
- uid: azure.schemaregistry.aio.SchemaRegistryClient.get_schema_properties
name: get_schema_properties
summary: 'Gets the schema properties corresponding to an existing schema within
@@ -150,20 +153,20 @@ methods:
examples:
- "Get schema by id.<!--[!code-python[Main](les\\async_samples\\sample_code_schemaregistry_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\240\\\\azure-schemaregistry-1.3.0b2\\\\samples\\\\async_samples\\\
- \\sample_code_schemaregistry_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n group_name = os.environ[\"SCHEMAREGISTRY_GROUP\"\
- ]\n name = \"your-schema-name\"\n format = \"Avro\"\n schema_json = {\n\
- \ \"namespace\": \"example.avro\",\n \"type\": \"record\",\n \
- \ \"name\": \"User\",\n \"fields\": [\n {\"name\": \"name\",\
- \ \"type\": \"string\"},\n {\"name\": \"favorite_number\", \"type\"\
- : [\"int\", \"null\"]},\n {\"name\": \"favorite_color\", \"type\": [\"\
- string\", \"null\"]},\n ],\n }\n definition = json.dumps(schema_json,\
- \ separators=(\",\", \":\"))\n schema_properties = await schema_registry_client.get_schema_properties(\n\
- \ group_name, name, definition, format\n )\n schema_id = schema_properties.id\n\
- \n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 240\\\\azure-schemaregistry-1.3.0b2\\\\samples\\\\async_samples\\\\sample_code_schemaregistry_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n group_name = os.environ[\"SCHEMAREGISTRY_GROUP\"]\n name = \"your-schema-name\"\
+ \n format = \"Avro\"\n schema_json = {\n \"namespace\": \"example.avro\"\
+ ,\n \"type\": \"record\",\n \"name\": \"User\",\n \"fields\"\
+ : [\n {\"name\": \"name\", \"type\": \"string\"},\n {\"name\"\
+ : \"favorite_number\", \"type\": [\"int\", \"null\"]},\n {\"name\":\
+ \ \"favorite_color\", \"type\": [\"string\", \"null\"]},\n ],\n }\n \
+ \ definition = json.dumps(schema_json, separators=(\",\", \":\"))\n schema_properties\
+ \ = await schema_registry_client.get_schema_properties(\n group_name, name,\
+ \ definition, format\n )\n schema_id = schema_properties.id\n\n ````\n"
- uid: azure.schemaregistry.aio.SchemaRegistryClient.register_schema
name: register_schema
summary: 'Register new schema. If schema of specified name does not exist in specified
@@ -207,17 +210,17 @@ methods:
examples:
- "Register a new schema.<!--[!code-python[Main](les\\async_samples\\sample_code_schemaregistry_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\240\\\\azure-schemaregistry-1.3.0b2\\\\samples\\\\async_samples\\\
- \\sample_code_schemaregistry_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n GROUP_NAME = os.environ[\"SCHEMAREGISTRY_GROUP\"\
- ]\n NAME = \"your-schema-name\"\n FORMAT = \"Avro\"\n SCHEMA_JSON = {\n\
- \ \"namespace\": \"example.avro\",\n \"type\": \"record\",\n \
- \ \"name\": \"User\",\n \"fields\": [\n {\"name\": \"name\",\
- \ \"type\": \"string\"},\n {\"name\": \"favorite_number\", \"type\"\
- : [\"int\", \"null\"]},\n {\"name\": \"favorite_color\", \"type\": [\"\
- string\", \"null\"]},\n ],\n }\n DEFINITION = json.dumps(SCHEMA_JSON,\
- \ separators=(\",\", \":\"))\n schema_properties = await schema_registry_client.register_schema(\n\
- \ GROUP_NAME, NAME, DEFINITION, FORMAT\n )\n schema_id = schema_properties.id\n\
- \n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 240\\\\azure-schemaregistry-1.3.0b2\\\\samples\\\\async_samples\\\\sample_code_schemaregistry_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n GROUP_NAME = os.environ[\"SCHEMAREGISTRY_GROUP\"]\n NAME = \"your-schema-name\"\
+ \n FORMAT = \"Avro\"\n SCHEMA_JSON = {\n \"namespace\": \"example.avro\"\
+ ,\n \"type\": \"record\",\n \"name\": \"User\",\n \"fields\"\
+ : [\n {\"name\": \"name\", \"type\": \"string\"},\n {\"name\"\
+ : \"favorite_number\", \"type\": [\"int\", \"null\"]},\n {\"name\":\
+ \ \"favorite_color\", \"type\": [\"string\", \"null\"]},\n ],\n }\n \
+ \ DEFINITION = json.dumps(SCHEMA_JSON, separators=(\",\", \":\"))\n schema_properties\
+ \ = await schema_registry_client.register_schema(\n GROUP_NAME, NAME, DEFINITION,\
+ \ FORMAT\n )\n schema_id = schema_properties.id\n\n ````\n"
diff --git a/preview/docs-ref-autogen/azure-schemaregistry/azure.schemaregistry.encoder.yml b/preview/docs-ref-autogen/azure-schemaregistry/azure.schemaregistry.encoder.yml
new file mode 100644
index 000000000000..2247f059237c
--- /dev/null
+++ b/preview/docs-ref-autogen/azure-schemaregistry/azure.schemaregistry.encoder.yml
@@ -0,0 +1,7 @@
+### YamlMime:PythonPackage
+uid: azure.schemaregistry.encoder
+name: encoder
+fullName: azure.schemaregistry.encoder
+type: import
+packages:
+- azure.schemaregistry.encoder.jsonencoder
diff --git a/preview/docs-ref-autogen/azure-schemaregistry/azure.schemaregistry.yml b/preview/docs-ref-autogen/azure-schemaregistry/azure.schemaregistry.yml
index 5c2087d9c19b..dbf62dad30d4 100644
--- a/preview/docs-ref-autogen/azure-schemaregistry/azure.schemaregistry.yml
+++ b/preview/docs-ref-autogen/azure-schemaregistry/azure.schemaregistry.yml
@@ -13,6 +13,7 @@ classes:
- azure.schemaregistry.SchemaRegistryClient
packages:
- azure.schemaregistry.aio
+- azure.schemaregistry.encoder
enums:
- azure.schemaregistry.ApiVersion
- azure.schemaregistry.SchemaFormat
diff --git a/preview/docs-ref-autogen/azure-schemaregistry/index.yml b/preview/docs-ref-autogen/azure-schemaregistry/index.yml
index 0acd2934800c..029dc065c1d8 100644
--- a/preview/docs-ref-autogen/azure-schemaregistry/index.yml
+++ b/preview/docs-ref-autogen/azure-schemaregistry/index.yml
@@ -5,4 +5,3 @@ fullName: azure-schemaregistry
type: distribution
packages:
- azure.schemaregistry
-- azure.schemaregistry.encoder.jsonencoder
diff --git a/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.SearchClient.yml b/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.SearchClient.yml
index 7813d0cd2305..22a9b73e1e62 100644
--- a/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.SearchClient.yml
+++ b/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.SearchClient.yml
@@ -43,15 +43,15 @@ constructor:
examples:
- "Creating the SearchClient with an API key.<!--[!code-python[Main](les\\sample_authentication.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_authentication.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
- \ import AzureKeyCredential\n from azure.search.documents import SearchClient\n\
- \n service_endpoint = os.getenv(\"AZURE_SEARCH_SERVICE_ENDPOINT\")\n index_name\
- \ = os.getenv(\"AZURE_SEARCH_INDEX_NAME\")\n key = os.getenv(\"AZURE_SEARCH_API_KEY\"\
- )\n\n search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key))\n\
- \n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\242\\\\azure-search-documents-11.4.0b9\\\
+ \\samples\\\\sample_authentication.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.search.documents import SearchClient\n\n service_endpoint = os.getenv(\"\
+ AZURE_SEARCH_SERVICE_ENDPOINT\")\n index_name = os.getenv(\"AZURE_SEARCH_INDEX_NAME\"\
+ )\n key = os.getenv(\"AZURE_SEARCH_API_KEY\")\n\n search_client = SearchClient(service_endpoint,\
+ \ index_name, AzureKeyCredential(key))\n\n ````\n"
methods:
- uid: azure.search.documents.SearchClient.autocomplete
name: autocomplete
@@ -132,13 +132,13 @@ methods:
examples:
- "Get a auto-completions.<!--[!code-python[Main](les\\sample_autocomplete.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_autocomplete.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.core.credentials import AzureKeyCredential\n from azure.search.documents\
- \ import SearchClient\n\n search_client = SearchClient(service_endpoint, index_name,\
- \ AzureKeyCredential(key))\n\n results = search_client.autocomplete(search_text=\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\242\\\\azure-search-documents-11.4.0b9\\\
+ \\samples\\\\sample_autocomplete.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.search.documents import SearchClient\n\n search_client = SearchClient(service_endpoint,\
+ \ index_name, AzureKeyCredential(key))\n\n results = search_client.autocomplete(search_text=\"\
bo\", suggester_name=\"sg\")\n\n print(\"Autocomplete suggestions for 'bo'\"\
)\n for result in results:\n print(\" Completion: {}\".format(result[\"\
text\"]))\n\n ````\n"
@@ -179,8 +179,9 @@ methods:
examples:
- "Delete existing documents to an index<!--[!code-python[Main](les\\sample_crud_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_crud_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_crud_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n result = search_client.delete_documents(documents=[{\"hotelId\": \"1000\"\
@@ -209,8 +210,9 @@ methods:
examples:
- "Get a specific document from the search index.<!--[!code-python[Main](les\\sample_get_document.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_get_document.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_get_document.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n from azure.core.credentials import AzureKeyCredential\n from azure.search.documents\
@@ -271,11 +273,12 @@ methods:
examples:
- "Merge fields into existing documents to an index<!--[!code-python[Main](les\\\
sample_crud_operations.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\
- \\samples\\\\sample_crud_operations.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n result = search_client.merge_documents(documents=[{\"\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\
+ \\sample_crud_operations.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n result = search_client.merge_documents(documents=[{\"\
hotelId\": \"1000\", \"rating\": 4.5}])\n\n print(\"Merge into new document\
\ succeeded: {}\".format(result[0].succeeded))\n\n ````\n"
- uid: azure.search.documents.SearchClient.merge_or_upload_documents
@@ -637,13 +640,13 @@ methods:
examples:
- "Get search result facets.<!--[!code-python[Main](les\\sample_facet_query.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_facet_query.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.core.credentials import AzureKeyCredential\n from azure.search.documents\
- \ import SearchClient\n\n search_client = SearchClient(service_endpoint, index_name,\
- \ AzureKeyCredential(key))\n\n results = search_client.search(search_text=\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\242\\\\azure-search-documents-11.4.0b9\\\
+ \\samples\\\\sample_facet_query.py\", \"xml:space\": \"preserve\", \"force\":\
+ \ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.search.documents import SearchClient\n\n search_client = SearchClient(service_endpoint,\
+ \ index_name, AzureKeyCredential(key))\n\n results = search_client.search(search_text=\"\
WiFi\", facets=[\"category,count:3\", \"parkingIncluded\"])\n\n facets = results.get_facets()\n\
\n print(\"Catgory facet counts for hotels:\")\n for facet in facets[\"category\"\
]:\n print(\" {}\".format(facet))\n\n ````\n"
@@ -737,13 +740,13 @@ methods:
examples:
- "Get search suggestions.<!--[!code-python[Main](les\\sample_suggestions.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_suggestions.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.core.credentials import AzureKeyCredential\n from azure.search.documents\
- \ import SearchClient\n\n search_client = SearchClient(service_endpoint, index_name,\
- \ AzureKeyCredential(key))\n\n results = search_client.suggest(search_text=\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\242\\\\azure-search-documents-11.4.0b9\\\
+ \\samples\\\\sample_suggestions.py\", \"xml:space\": \"preserve\", \"force\":\
+ \ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.search.documents import SearchClient\n\n search_client = SearchClient(service_endpoint,\
+ \ index_name, AzureKeyCredential(key))\n\n results = search_client.suggest(search_text=\"\
coffee\", suggester_name=\"sg\")\n\n print(\"Search suggestions for 'coffee'\"\
)\n for result in results:\n hotel = search_client.get_document(key=result[\"\
hotelId\"])\n print(\" Text: {} for Hotel: {}\".format(repr(result[\"\
@@ -772,8 +775,9 @@ methods:
examples:
- "Upload new documents to an index<!--[!code-python[Main](les\\sample_crud_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_crud_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_crud_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n DOCUMENT = {\n \"category\": \"Hotel\",\n \"hotelId\": \"1000\"\
diff --git a/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.aio.SearchClient.yml b/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.aio.SearchClient.yml
index ee468abcc81f..d9f6006e9435 100644
--- a/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.aio.SearchClient.yml
+++ b/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.aio.SearchClient.yml
@@ -43,13 +43,13 @@ constructor:
examples:
- "Creating the SearchClient with an API key.<!--[!code-python[Main](les\\async_samples\\\
sample_authentication_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\
- \\async_samples\\\\sample_authentication_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials import\
- \ AzureKeyCredential\n from azure.search.documents.aio import SearchClient\n\n\
- \ service_endpoint = os.getenv(\"AZURE_SEARCH_SERVICE_ENDPOINT\")\n index_name\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\\sample_authentication_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
+ \ import AzureKeyCredential\n from azure.search.documents.aio import SearchClient\n\
+ \n service_endpoint = os.getenv(\"AZURE_SEARCH_SERVICE_ENDPOINT\")\n index_name\
\ = os.getenv(\"AZURE_SEARCH_INDEX_NAME\")\n key = os.getenv(\"AZURE_SEARCH_API_KEY\"\
)\n\n search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key))\n\
\n ````\n"
@@ -133,17 +133,17 @@ methods:
examples:
- "Get a auto-completions.<!--[!code-python[Main](les\\async_samples\\sample_autocomplete_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\
- \\sample_autocomplete_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
- \ from azure.search.documents.aio import SearchClient\n\n search_client =\
- \ SearchClient(service_endpoint, index_name, AzureKeyCredential(key))\n\n async\
- \ with search_client:\n results = await search_client.autocomplete(search_text=\"\
- bo\", suggester_name=\"sg\")\n\n print(\"Autocomplete suggestions for 'bo'\"\
- )\n for result in results:\n print(\" Completion: {}\".format(result[\"\
- text\"]))\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\\sample_autocomplete_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.core.credentials import AzureKeyCredential\n from azure.search.documents.aio\
+ \ import SearchClient\n\n search_client = SearchClient(service_endpoint, index_name,\
+ \ AzureKeyCredential(key))\n\n async with search_client:\n results = await\
+ \ search_client.autocomplete(search_text=\"bo\", suggester_name=\"sg\")\n\n \
+ \ print(\"Autocomplete suggestions for 'bo'\")\n for result in results:\n\
+ \ print(\" Completion: {}\".format(result[\"text\"]))\n\n ````\n"
- uid: azure.search.documents.aio.SearchClient.close
name: close
summary: Close the <xref:azure.search.documents.aio.SearchClient> session.
@@ -185,13 +185,14 @@ methods:
examples:
- "Delete existing documents to an index<!--[!code-python[Main](les\\async_samples\\\
sample_crud_operations_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\
- \\samples\\\\async_samples\\\\sample_crud_operations_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n result = await\
- \ search_client.upload_documents(documents=[{\"hotelId\": \"1000\"}])\n\n print(\"\
- Delete new document succeeded: {}\".format(result[0].succeeded))\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\
+ \\async_samples\\\\sample_crud_operations_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n result = await search_client.upload_documents(documents=[{\"\
+ hotelId\": \"1000\"}])\n\n print(\"Delete new document succeeded: {}\".format(result[0].succeeded))\n\
+ \n ````\n"
- uid: azure.search.documents.aio.SearchClient.get_document
name: get_document
summary: Retrieve a document from the Azure search index by its key.
@@ -215,11 +216,12 @@ methods:
examples:
- "Get a specific document from the search index.<!--[!code-python[Main](les\\async_samples\\\
sample_get_document_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\
- \\samples\\\\async_samples\\\\sample_get_document_async.py\", \"xml:space\": \"\
- preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
- linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\
+ \\async_samples\\\\sample_get_document_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.core.credentials\
\ import AzureKeyCredential\n from azure.search.documents.aio import SearchClient\n\
\n search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key))\n\
\n async with search_client:\n result = await search_client.get_document(key=\"\
@@ -280,7 +282,8 @@ methods:
- "Merge fields into existing documents to an index<!--[!code-python[Main](les\\\
async_samples\\sample_crud_operations_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\242\\\\azure-search-documents-11.4.0b9\\\
\\samples\\\\async_samples\\\\sample_crud_operations_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n result = await\
@@ -648,18 +651,18 @@ methods:
examples:
- "Get search result facets.<!--[!code-python[Main](les\\async_samples\\sample_facet_query_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\
- \\sample_facet_query_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
- \ from azure.search.documents.aio import SearchClient\n\n search_client =\
- \ SearchClient(service_endpoint, index_name, AzureKeyCredential(key))\n\n async\
- \ with search_client:\n results = await search_client.search(search_text=\"\
- WiFi\", facets=[\"category,count:3\", \"parkingIncluded\"])\n\n facets =\
- \ await results.get_facets()\n\n print(\"Catgory facet counts for hotels:\"\
- )\n for facet in facets[\"category\"]:\n print(\" {}\".format(facet))\n\
- \n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\\sample_facet_query_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.core.credentials import AzureKeyCredential\n from azure.search.documents.aio\
+ \ import SearchClient\n\n search_client = SearchClient(service_endpoint, index_name,\
+ \ AzureKeyCredential(key))\n\n async with search_client:\n results = await\
+ \ search_client.search(search_text=\"WiFi\", facets=[\"category,count:3\", \"\
+ parkingIncluded\"])\n\n facets = await results.get_facets()\n\n print(\"\
+ Catgory facet counts for hotels:\")\n for facet in facets[\"category\"]:\n\
+ \ print(\" {}\".format(facet))\n\n ````\n"
- uid: azure.search.documents.aio.SearchClient.suggest
name: suggest
summary: "Get search suggestion results from the Azure search index.\n\ncharacter,\
@@ -750,18 +753,19 @@ methods:
examples:
- "Get search suggestions.<!--[!code-python[Main](les\\async_samples\\sample_suggestions_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\
- \\sample_suggestions_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
- \ from azure.search.documents.aio import SearchClient\n\n search_client =\
- \ SearchClient(service_endpoint, index_name, AzureKeyCredential(key))\n\n async\
- \ with search_client:\n results = await search_client.suggest(search_text=\"\
- coffee\", suggester_name=\"sg\")\n\n print(\"Search suggestions for 'coffee'\"\
- )\n for result in results:\n hotel = await search_client.get_document(key=result[\"\
- hotelId\"])\n print(\" Text: {} for Hotel: {}\".format(repr(result[\"\
- text\"]), hotel[\"hotelName\"]))\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\\sample_suggestions_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.core.credentials import AzureKeyCredential\n from azure.search.documents.aio\
+ \ import SearchClient\n\n search_client = SearchClient(service_endpoint, index_name,\
+ \ AzureKeyCredential(key))\n\n async with search_client:\n results = await\
+ \ search_client.suggest(search_text=\"coffee\", suggester_name=\"sg\")\n\n \
+ \ print(\"Search suggestions for 'coffee'\")\n for result in results:\n\
+ \ hotel = await search_client.get_document(key=result[\"hotelId\"])\n\
+ \ print(\" Text: {} for Hotel: {}\".format(repr(result[\"text\"]),\
+ \ hotel[\"hotelName\"]))\n\n ````\n"
- uid: azure.search.documents.aio.SearchClient.upload_documents
name: upload_documents
summary: 'Upload documents to the Azure search index.
@@ -786,13 +790,13 @@ methods:
examples:
- "Upload new documents to an index<!--[!code-python[Main](les\\async_samples\\\
sample_crud_operations_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\
- \\samples\\\\async_samples\\\\sample_crud_operations_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n DOCUMENT =\
- \ {\n \"category\": \"Hotel\",\n \"hotelId\": \"1000\",\n \"\
- rating\": 4.0,\n \"rooms\": [],\n \"hotelName\": \"Azure Inn\",\n\
- \ }\n\n result = await search_client.upload_documents(documents=[DOCUMENT])\n\
- \n print(\"Upload of new document succeeded: {}\".format(result[0].succeeded))\n\
- \n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\
+ \\async_samples\\\\sample_crud_operations_async.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n DOCUMENT = {\n \"category\"\
+ : \"Hotel\",\n \"hotelId\": \"1000\",\n \"rating\": 4.0,\n \"\
+ rooms\": [],\n \"hotelName\": \"Azure Inn\",\n }\n\n result = await\
+ \ search_client.upload_documents(documents=[DOCUMENT])\n\n print(\"Upload of\
+ \ new document succeeded: {}\".format(result[0].succeeded))\n\n ````\n"
diff --git a/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.SearchIndexClient.yml b/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.SearchIndexClient.yml
index 2b46439ef305..003b9faabcb3 100644
--- a/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.SearchIndexClient.yml
+++ b/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.SearchIndexClient.yml
@@ -61,16 +61,16 @@ methods:
examples:
- "Analyze text<!--[!code-python[Main](les\\sample_analyze_text.py )]-->\n\n<!--\
\ literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [],\
- \ \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\\
- 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_analyze_text.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n from azure.core.credentials import AzureKeyCredential\n from azure.search.documents.indexes\
- \ import SearchIndexClient\n from azure.search.documents.indexes.models import\
- \ AnalyzeTextOptions\n\n client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))\n\
- \n analyze_request = AnalyzeTextOptions(text=\"One's <two/>\", analyzer_name=\"\
- standard.lucene\")\n\n result = client.analyze_text(index_name, analyze_request)\n\
- \ print(result.as_dict())\n\n ````\n"
+ \ \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\242\\\\azure-search-documents-11.4.0b9\\\
+ \\samples\\\\sample_analyze_text.py\", \"xml:space\": \"preserve\", \"force\"\
+ : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
+ \ from azure.search.documents.indexes import SearchIndexClient\n from azure.search.documents.indexes.models\
+ \ import AnalyzeTextOptions\n\n client = SearchIndexClient(service_endpoint,\
+ \ AzureKeyCredential(key))\n\n analyze_request = AnalyzeTextOptions(text=\"\
+ One's <two/>\", analyzer_name=\"standard.lucene\")\n\n result = client.analyze_text(index_name,\
+ \ analyze_request)\n print(result.as_dict())\n\n ````\n"
- uid: azure.search.documents.indexes.SearchIndexClient.close
name: close
summary: Close the <xref:azure.search.documents.indexes.SearchIndexClient> session.
@@ -94,8 +94,9 @@ methods:
examples:
- "Creating a new alias.<!--[!code-python[Main](les\\sample_index_alias_crud_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_index_alias_crud_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_index_alias_crud_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n alias = SearchAlias(name=alias_name, indexes=[index_name])\n result = client.create_alias(alias)\n\
@@ -119,8 +120,9 @@ methods:
examples:
- "Creating a new index.<!--[!code-python[Main](les\\sample_index_crud_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_index_crud_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_index_crud_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))\n \
@@ -162,8 +164,9 @@ methods:
examples:
- "Updating an alias.<!--[!code-python[Main](les\\sample_index_alias_crud_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_index_alias_crud_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_index_alias_crud_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n new_index_name = \"hotels\"\n fields = [\n SimpleField(name=\"hotelId\"\
@@ -227,8 +230,9 @@ methods:
examples:
- "Update an index.<!--[!code-python[Main](les\\sample_index_crud_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_index_crud_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_index_crud_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))\n \
@@ -284,8 +288,9 @@ methods:
examples:
- "Create a Synonym Map<!--[!code-python[Main](les\\sample_synonym_map_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_synonym_map_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_synonym_map_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n synonyms = [\n \"USA, United States, United States of America\",\n\
@@ -316,8 +321,9 @@ methods:
examples:
- "Deleting an alias.<!--[!code-python[Main](les\\sample_index_alias_crud_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_index_alias_crud_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_index_alias_crud_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n\n client.delete_alias(alias_name)\n\n ````\n"
@@ -345,8 +351,9 @@ methods:
examples:
- "Delete an index.<!--[!code-python[Main](les\\sample_index_crud_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_index_crud_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_index_crud_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))\n \
@@ -378,8 +385,9 @@ methods:
examples:
- "Delete a Synonym Map<!--[!code-python[Main](les\\sample_synonym_map_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_synonym_map_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_synonym_map_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n client.delete_synonym_map(\"test-syn-map\")\n print(\"Synonym Map 'test-syn-map'\
@@ -417,12 +425,13 @@ methods:
examples:
- "Get an index.<!--[!code-python[Main](les\\sample_index_crud_operations.py )]-->\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\
- \\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_index_crud_operations.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
- highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
- \n client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))\n \
- \ name = \"hotels\"\n result = client.get_index(name)\n\n ````\n"
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\242\\\\azure-search-documents-11.4.0b9\\\
+ \\samples\\\\sample_index_crud_operations.py\", \"xml:space\": \"preserve\", \"\
+ force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n client = SearchIndexClient(service_endpoint,\
+ \ AzureKeyCredential(key))\n name = \"hotels\"\n result = client.get_index(name)\n\
+ \n ````\n"
- uid: azure.search.documents.indexes.SearchIndexClient.get_index_statistics
name: get_index_statistics
summary: 'Returns statistics for the given index, including a document count
@@ -483,8 +492,9 @@ methods:
examples:
- "Get a Synonym Map<!--[!code-python[Main](les\\sample_synonym_map_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_synonym_map_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_synonym_map_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n result = client.get_synonym_map(\"test-syn-map\")\n print(\"Retrived Synonym\
@@ -523,8 +533,9 @@ methods:
examples:
- "List Synonym Maps<!--[!code-python[Main](les\\sample_synonym_map_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_synonym_map_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_synonym_map_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n result = client.get_synonym_maps()\n names = [x.name for x in result]\n\
diff --git a/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.SearchIndexerClient.yml b/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.SearchIndexerClient.yml
index ca4f28819d0c..5b4f0ef6bf49 100644
--- a/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.SearchIndexerClient.yml
+++ b/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.SearchIndexerClient.yml
@@ -58,8 +58,9 @@ methods:
examples:
- "Create a Data Source<!--[!code-python[Main](les\\sample_data_source_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_data_source_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_data_source_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n container = SearchIndexerDataContainer(name=\"searchcontainer\")\n data_source_connection\
@@ -210,8 +211,9 @@ methods:
examples:
- "Delete a SearchIndexerDataSourceConnection<!--[!code-python[Main](les\\sample_data_source_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_data_source_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_data_source_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n client.delete_data_source_connection(\"sample-data-source-connection\")\n\
@@ -280,8 +282,9 @@ methods:
examples:
- "Retrieve a SearchIndexerDataSourceConnection<!--[!code-python[Main](les\\sample_data_source_operations.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_data_source_operations.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\sample_data_source_operations.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n result = client.get_data_source_connection(\"sample-data-source-connection\"\
@@ -318,10 +321,11 @@ methods:
- "List all the SearchIndexerDataSourceConnections<!--[!code-python[Main](les\\\
sample_data_source_operations.py )]-->\n\n<!-- literal_block {\"ids\": [], \"\
classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\":\
- \ \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\
- \\samples\\\\sample_data_source_operations.py\", \"xml:space\": \"preserve\",\
- \ \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n result = client.get_data_source_connections()\n\
+ \ \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\
+ \\sample_data_source_operations.py\", \"xml:space\": \"preserve\", \"force\":\
+ \ false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
+ linenos\": false} -->\n\n````python\n\n result = client.get_data_source_connections()\n\
\ names = [ds.name for ds in result]\n print(\"Found {} Data Source Connections\
\ in the service: {}\".format(len(result), \", \".join(names)))\n\n ````\n"
- uid: azure.search.documents.indexes.SearchIndexerClient.get_indexer
diff --git a/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.aio.SearchIndexClient.yml b/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.aio.SearchIndexClient.yml
index 973e83cbf187..2e3d4db0795d 100644
--- a/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.aio.SearchIndexClient.yml
+++ b/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.aio.SearchIndexClient.yml
@@ -61,16 +61,16 @@ methods:
examples:
- "Analyze text<!--[!code-python[Main](les\\async_samples\\sample_analyze_text_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\
- \\sample_analyze_text_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n from azure.core.credentials import AzureKeyCredential\n\
- \ from azure.search.documents.indexes.aio import SearchIndexClient\n from\
- \ azure.search.documents.indexes.models import AnalyzeTextOptions\n\n client\
- \ = SearchIndexClient(service_endpoint, AzureKeyCredential(key))\n\n analyze_request\
- \ = AnalyzeTextOptions(text=\"One's <two/>\", analyzer_name=\"standard.lucene\"\
- )\n\n async with client:\n result = await client.analyze_text(index_name,\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\\sample_analyze_text_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n from azure.core.credentials import AzureKeyCredential\n from azure.search.documents.indexes.aio\
+ \ import SearchIndexClient\n from azure.search.documents.indexes.models import\
+ \ AnalyzeTextOptions\n\n client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))\n\
+ \n analyze_request = AnalyzeTextOptions(text=\"One's <two/>\", analyzer_name=\"\
+ standard.lucene\")\n\n async with client:\n result = await client.analyze_text(index_name,\
\ analyze_request)\n print(result.as_dict())\n\n ````\n"
- uid: azure.search.documents.indexes.aio.SearchIndexClient.close
name: close
@@ -97,12 +97,13 @@ methods:
examples:
- "Create an alias.<!--[!code-python[Main](les\\async_samples\\sample_index_alias_crud_operations_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\
- \\sample_index_alias_crud_operations_async.py\", \"xml:space\": \"preserve\",\
- \ \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n alias = SearchAlias(name=alias_name,\
- \ indexes=[index_name])\n result = await client.create_alias(alias)\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\\sample_index_alias_crud_operations_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n alias = SearchAlias(name=alias_name, indexes=[index_name])\n result = await\
+ \ client.create_alias(alias)\n\n ````\n"
- uid: azure.search.documents.indexes.aio.SearchIndexClient.create_index
name: create_index
summary: Creates a new search index.
@@ -122,20 +123,21 @@ methods:
examples:
- "Creating a new index.<!--[!code-python[Main](les\\async_samples\\sample_index_crud_operations_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\
- \\sample_index_crud_operations_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n client = SearchIndexClient(service_endpoint,\
- \ AzureKeyCredential(key))\n name = \"hotels\"\n fields = [\n SimpleField(name=\"\
- hotelId\", type=SearchFieldDataType.String, key=True),\n SimpleField(name=\"\
- baseRate\", type=SearchFieldDataType.Double),\n SearchableField(name=\"\
- description\", type=SearchFieldDataType.String, collection=True),\n ComplexField(\n\
- \ name=\"address\",\n fields=[\n SimpleField(name=\"\
- streetAddress\", type=SearchFieldDataType.String),\n SimpleField(name=\"\
- city\", type=SearchFieldDataType.String),\n ],\n collection=True,\n\
- \ ),\n ]\n\n cors_options = CorsOptions(allowed_origins=[\"*\"], max_age_in_seconds=60)\n\
- \ scoring_profiles = []\n index = SearchIndex(name=name, fields=fields, scoring_profiles=scoring_profiles,\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\\sample_index_crud_operations_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))\n \
+ \ name = \"hotels\"\n fields = [\n SimpleField(name=\"hotelId\", type=SearchFieldDataType.String,\
+ \ key=True),\n SimpleField(name=\"baseRate\", type=SearchFieldDataType.Double),\n\
+ \ SearchableField(name=\"description\", type=SearchFieldDataType.String,\
+ \ collection=True),\n ComplexField(\n name=\"address\",\n \
+ \ fields=[\n SimpleField(name=\"streetAddress\", type=SearchFieldDataType.String),\n\
+ \ SimpleField(name=\"city\", type=SearchFieldDataType.String),\n\
+ \ ],\n collection=True,\n ),\n ]\n\n cors_options\
+ \ = CorsOptions(allowed_origins=[\"*\"], max_age_in_seconds=60)\n scoring_profiles\
+ \ = []\n index = SearchIndex(name=name, fields=fields, scoring_profiles=scoring_profiles,\
\ cors_options=cors_options)\n\n result = await client.create_index(index)\n\
\ await client.close()\n\n ````\n"
- uid: azure.search.documents.indexes.aio.SearchIndexClient.create_or_update_alias
@@ -166,23 +168,24 @@ methods:
examples:
- "Update an alias.<!--[!code-python[Main](les\\async_samples\\sample_index_alias_crud_operations_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\
- \\sample_index_alias_crud_operations_async.py\", \"xml:space\": \"preserve\",\
- \ \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n new_index_name = \"hotels\"\n\
- \ fields = [\n SimpleField(name=\"hotelId\", type=SearchFieldDataType.String,\
- \ key=True),\n SimpleField(name=\"baseRate\", type=SearchFieldDataType.Double),\n\
- \ SearchableField(name=\"description\", type=SearchFieldDataType.String,\
- \ collection=True),\n SearchableField(name=\"hotelName\", type=SearchFieldDataType.String),\n\
- \ ComplexField(\n name=\"address\",\n fields=[\n \
- \ SimpleField(name=\"streetAddress\", type=SearchFieldDataType.String),\n\
- \ SimpleField(name=\"city\", type=SearchFieldDataType.String),\n\
- \ SimpleField(name=\"state\", type=SearchFieldDataType.String),\n\
- \ ],\n collection=True,\n ),\n ]\n cors_options\
- \ = CorsOptions(allowed_origins=[\"*\"], max_age_in_seconds=60)\n scoring_profile\
- \ = ScoringProfile(name=\"MyProfile\")\n scoring_profiles = []\n scoring_profiles.append(scoring_profile)\n\
- \ index = SearchIndex(\n name=new_index_name, fields=fields, scoring_profiles=scoring_profiles,\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\\sample_index_alias_crud_operations_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n new_index_name = \"hotels\"\n fields = [\n SimpleField(name=\"hotelId\"\
+ , type=SearchFieldDataType.String, key=True),\n SimpleField(name=\"baseRate\"\
+ , type=SearchFieldDataType.Double),\n SearchableField(name=\"description\"\
+ , type=SearchFieldDataType.String, collection=True),\n SearchableField(name=\"\
+ hotelName\", type=SearchFieldDataType.String),\n ComplexField(\n \
+ \ name=\"address\",\n fields=[\n SimpleField(name=\"\
+ streetAddress\", type=SearchFieldDataType.String),\n SimpleField(name=\"\
+ city\", type=SearchFieldDataType.String),\n SimpleField(name=\"\
+ state\", type=SearchFieldDataType.String),\n ],\n collection=True,\n\
+ \ ),\n ]\n cors_options = CorsOptions(allowed_origins=[\"*\"], max_age_in_seconds=60)\n\
+ \ scoring_profile = ScoringProfile(name=\"MyProfile\")\n scoring_profiles\
+ \ = []\n scoring_profiles.append(scoring_profile)\n index = SearchIndex(\n\
+ \ name=new_index_name, fields=fields, scoring_profiles=scoring_profiles,\
\ cors_options=cors_options\n )\n\n result_index = await client.create_or_update_index(index=index)\n\
\n alias = SearchAlias(name=alias_name, indexes=[new_index_name])\n result\
\ = await client.create_or_update_alias(alias)\n\n\n ````\n"
@@ -231,26 +234,26 @@ methods:
examples:
- "Update an index.<!--[!code-python[Main](les\\async_samples\\sample_index_crud_operations_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\
- \\sample_index_crud_operations_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n client = SearchIndexClient(service_endpoint,\
- \ AzureKeyCredential(key))\n name = \"hotels\"\n fields = [\n SimpleField(name=\"\
- hotelId\", type=SearchFieldDataType.String, key=True),\n SimpleField(name=\"\
- baseRate\", type=SearchFieldDataType.Double),\n SearchableField(name=\"\
- description\", type=SearchFieldDataType.String, collection=True),\n SearchableField(name=\"\
- hotelName\", type=SearchFieldDataType.String),\n ComplexField(\n \
- \ name=\"address\",\n fields=[\n SimpleField(name=\"\
- streetAddress\", type=SearchFieldDataType.String),\n SimpleField(name=\"\
- city\", type=SearchFieldDataType.String),\n SimpleField(name=\"\
- state\", type=SearchFieldDataType.String),\n ],\n collection=True,\n\
- \ ),\n ]\n\n cors_options = CorsOptions(allowed_origins=[\"*\"], max_age_in_seconds=60)\n\
- \ scoring_profile = ScoringProfile(name=\"MyProfile\")\n scoring_profiles\
- \ = []\n scoring_profiles.append(scoring_profile)\n index = SearchIndex(name=name,\
- \ fields=fields, scoring_profiles=scoring_profiles, cors_options=cors_options)\n\
- \n result = await client.create_or_update_index(index=index)\n await client.close()\n\
- \n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\\sample_index_crud_operations_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))\n \
+ \ name = \"hotels\"\n fields = [\n SimpleField(name=\"hotelId\", type=SearchFieldDataType.String,\
+ \ key=True),\n SimpleField(name=\"baseRate\", type=SearchFieldDataType.Double),\n\
+ \ SearchableField(name=\"description\", type=SearchFieldDataType.String,\
+ \ collection=True),\n SearchableField(name=\"hotelName\", type=SearchFieldDataType.String),\n\
+ \ ComplexField(\n name=\"address\",\n fields=[\n \
+ \ SimpleField(name=\"streetAddress\", type=SearchFieldDataType.String),\n\
+ \ SimpleField(name=\"city\", type=SearchFieldDataType.String),\n\
+ \ SimpleField(name=\"state\", type=SearchFieldDataType.String),\n\
+ \ ],\n collection=True,\n ),\n ]\n\n cors_options\
+ \ = CorsOptions(allowed_origins=[\"*\"], max_age_in_seconds=60)\n scoring_profile\
+ \ = ScoringProfile(name=\"MyProfile\")\n scoring_profiles = []\n scoring_profiles.append(scoring_profile)\n\
+ \ index = SearchIndex(name=name, fields=fields, scoring_profiles=scoring_profiles,\
+ \ cors_options=cors_options)\n\n result = await client.create_or_update_index(index=index)\n\
+ \ await client.close()\n\n ````\n"
- uid: azure.search.documents.indexes.aio.SearchIndexClient.create_or_update_synonym_map
name: create_or_update_synonym_map
summary: 'Create a new Synonym Map in an Azure Search service, or update an
@@ -290,13 +293,14 @@ methods:
examples:
- "Create a Synonym Map<!--[!code-python[Main](les\\async_samples\\sample_synonym_map_operations_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\
- \\sample_synonym_map_operations_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n synonyms = [\n \"USA, United States,\
- \ United States of America\",\n \"Washington, Wash. => WA\",\n ]\n synonym_map\
- \ = SynonymMap(name=\"test-syn-map\", synonyms=synonyms)\n result = await client.create_synonym_map(synonym_map)\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\\sample_synonym_map_operations_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n synonyms = [\n \"USA, United States, United States of America\",\n\
+ \ \"Washington, Wash. => WA\",\n ]\n synonym_map = SynonymMap(name=\"\
+ test-syn-map\", synonyms=synonyms)\n result = await client.create_synonym_map(synonym_map)\n\
\ print(\"Create new Synonym Map 'test-syn-map succeeded\")\n\n ````\n"
- uid: azure.search.documents.indexes.aio.SearchIndexClient.delete_alias
name: delete_alias
@@ -319,12 +323,12 @@ methods:
examples:
- "Delete an alias.<!--[!code-python[Main](les\\async_samples\\sample_index_alias_crud_operations_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\
- \\sample_index_alias_crud_operations_async.py\", \"xml:space\": \"preserve\",\
- \ \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n\n await client.delete_alias(alias_name)\n\
- \n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\\sample_index_alias_crud_operations_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n\n await client.delete_alias(alias_name)\n\n ````\n"
- uid: azure.search.documents.indexes.aio.SearchIndexClient.delete_index
name: delete_index
summary: 'Deletes a search index and all the documents it contains. The model must
@@ -347,13 +351,14 @@ methods:
examples:
- "Delete an index.<!--[!code-python[Main](les\\async_samples\\sample_index_crud_operations_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\
- \\sample_index_crud_operations_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n client = SearchIndexClient(service_endpoint,\
- \ AzureKeyCredential(key))\n name = \"hotels\"\n await client.delete_index(name)\n\
- \ await client.close()\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\\sample_index_crud_operations_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))\n \
+ \ name = \"hotels\"\n await client.delete_index(name)\n await client.close()\n\
+ \n ````\n"
- uid: azure.search.documents.indexes.aio.SearchIndexClient.delete_synonym_map
name: delete_synonym_map
summary: 'Delete a named Synonym Map in an Azure Search service. To use access conditions,
@@ -381,12 +386,13 @@ methods:
examples:
- "Delete a Synonym Map<!--[!code-python[Main](les\\async_samples\\sample_synonym_map_operations_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\
- \\sample_synonym_map_operations_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n await client.delete_synonym_map(\"test-syn-map\"\
- )\n print(\"Synonym Map 'test-syn-map' deleted\")\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\\sample_synonym_map_operations_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n await client.delete_synonym_map(\"test-syn-map\")\n print(\"Synonym Map\
+ \ 'test-syn-map' deleted\")\n\n ````\n"
- uid: azure.search.documents.indexes.aio.SearchIndexClient.get_alias
name: get_alias
signature: 'async get_alias(name: str, **kwargs) -> SearchAlias'
@@ -420,13 +426,14 @@ methods:
examples:
- "Get an index.<!--[!code-python[Main](les\\async_samples\\sample_index_crud_operations_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\
- \\sample_index_crud_operations_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n client = SearchIndexClient(service_endpoint,\
- \ AzureKeyCredential(key))\n name = \"hotels\"\n result = await client.get_index(name)\n\
- \ await client.close()\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\\sample_index_crud_operations_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))\n \
+ \ name = \"hotels\"\n result = await client.get_index(name)\n await client.close()\n\
+ \n ````\n"
- uid: azure.search.documents.indexes.aio.SearchIndexClient.get_index_statistics
name: get_index_statistics
summary: 'Returns statistics for the given index, including a document count
@@ -487,14 +494,14 @@ methods:
examples:
- "Get a Synonym Map<!--[!code-python[Main](les\\async_samples\\sample_synonym_map_operations_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\
- \\sample_synonym_map_operations_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n result = await client.get_synonym_map(\"\
- test-syn-map\")\n print(\"Retrived Synonym Map 'test-syn-map' with synonyms\"\
- )\n for syn in result.synonyms:\n print(\" {}\".format(syn))\n\n \
- \ ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\\sample_synonym_map_operations_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n result = await client.get_synonym_map(\"test-syn-map\")\n print(\"Retrived\
+ \ Synonym Map 'test-syn-map' with synonyms\")\n for syn in result.synonyms:\n\
+ \ print(\" {}\".format(syn))\n\n ````\n"
- uid: azure.search.documents.indexes.aio.SearchIndexClient.get_synonym_map_names
name: get_synonym_map_names
summary: List the Synonym Map names in an Azure Search service.
@@ -529,13 +536,14 @@ methods:
examples:
- "List Synonym Maps<!--[!code-python[Main](les\\async_samples\\sample_synonym_map_operations_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\
- \\sample_synonym_map_operations_async.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n result = await client.get_synonym_maps()\n\
- \ names = [x.name for x in result]\n print(\"Found {} Synonym Maps in the\
- \ service: {}\".format(len(result), \", \".join(names)))\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 242\\\\azure-search-documents-11.4.0b9\\\\samples\\\\async_samples\\\\sample_synonym_map_operations_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n result = await client.get_synonym_maps()\n names = [x.name for x in result]\n\
+ \ print(\"Found {} Synonym Maps in the service: {}\".format(len(result), \"\
+ , \".join(names)))\n\n ````\n"
- uid: azure.search.documents.indexes.aio.SearchIndexClient.list_alias_names
name: list_alias_names
summary: List the alias names in an Azure Search service.
diff --git a/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.aio.SearchIndexerClient.yml b/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.aio.SearchIndexerClient.yml
index 31138a03b868..987c6fe1e48f 100644
--- a/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.aio.SearchIndexerClient.yml
+++ b/preview/docs-ref-autogen/azure-search-documents/azure.search.documents.indexes.aio.SearchIndexerClient.yml
@@ -63,16 +63,17 @@ methods:
- "Create a SearchIndexerDataSourceConnection<!--[!code-python[Main](les\\async_samples\\\
sample_data_source_operations_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\
- \\samples\\\\async_samples\\\\sample_data_source_operations_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n container\
- \ = SearchIndexerDataContainer(name=\"searchcontainer\")\n data_source = SearchIndexerDataSourceConnection(\n\
- \ name=\"async-sample-data-source-connection\",\n type=\"azureblob\"\
- ,\n connection_string=connection_string,\n container=container,\n\
- \ )\n result = await client.create_data_source_connection(data_source)\n \
- \ print(\"Create new Data Source Connection - async-sample-data-source-connection\"\
- )\n\n ````\n"
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\
+ \\async_samples\\\\sample_data_source_operations_async.py\", \"xml:space\": \"\
+ preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
+ linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n container = SearchIndexerDataContainer(name=\"\
+ searchcontainer\")\n data_source = SearchIndexerDataSourceConnection(\n \
+ \ name=\"async-sample-data-source-connection\",\n type=\"azureblob\",\n\
+ \ connection_string=connection_string,\n container=container,\n \
+ \ )\n result = await client.create_data_source_connection(data_source)\n print(\"\
+ Create new Data Source Connection - async-sample-data-source-connection\")\n\n\
+ \ ````\n"
- uid: azure.search.documents.indexes.aio.SearchIndexerClient.create_indexer
name: create_indexer
summary: Creates a new SearchIndexer.
@@ -281,7 +282,7 @@ methods:
- '<xref:azure.search.documents.indexes.models.SearchIndexerDataSourceConnectionRetrieve
a SearchIndexerDataSourceConnection<!-->[<xref:!code-python>[<xref:Main>](<xref:les\async_samples\sample_data_source_operations_async.py
>)]<xref:--<!-- literal_block {"ids": >[], <xref:"classes": >[], <xref:"names":
- >[], <xref:"dupnames": >[], <xref:"backrefs": >[], <xref:"source": "D:\\a\\_work\\1\\s\\source_code\\242\\azure-search-documents-11.4.0b9\\samples\\async_samples\\sample_data_source_operations_async.py">,
+ >[], <xref:"dupnames": >[], <xref:"backrefs": >[], <xref:"source": "C:\\hostedtoolcache\\windows\\Python\\3.11.5\\x64\\Lib\\site-packages\\py2docfx\\dist_temp\\242\\azure-search-documents-11.4.0b9\\samples\\async_samples\\sample_data_source_operations_async.py">,
<xref:"xml:space": "preserve">, <xref:"force": false>, <xref:"language": "python">,
<xref:"highlight_args": {"linenostart": 1}>, <xref:"linenos": false} --````python result
= await client.get_data_source_connection>(<xref:"async-sample-data-source-connection">)<xref: print>(<xref:"Retrived
@@ -307,10 +308,11 @@ methods:
- "List all SearchIndexerDataSourceConnections<!--[!code-python[Main](les\\async_samples\\\
sample_data_source_operations_async.py )]-->\n\n<!-- literal_block {\"ids\": [],\
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\source_code\\\\242\\\\azure-search-documents-11.4.0b9\\\
- \\samples\\\\async_samples\\\\sample_data_source_operations_async.py\", \"xml:space\"\
- : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n result = await\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\242\\\\azure-search-documents-11.4.0b9\\\\samples\\\
+ \\async_samples\\\\sample_data_source_operations_async.py\", \"xml:space\": \"\
+ preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\": {\"\
+ linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n result = await\
\ client.get_data_source_connections()\n names = [x.name for x in result]\n\
\ print(\"Found {} Data Source Connections in the service: {}\".format(len(result),\
\ \", \".join(names)))\n\n ````\n"
diff --git a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.AutoLockRenewer.yml b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.AutoLockRenewer.yml
index d92d2fcf1f7d..3af1f5e96f2d 100644
--- a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.AutoLockRenewer.yml
+++ b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.AutoLockRenewer.yml
@@ -85,19 +85,20 @@ constructor:
examples:
- "Automatically renew a message lock<!--[!code-python[Main](les\\sync_samples\\sample_code_servicebus.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.servicebus\
- \ import AutoLockRenewer\n lock_renewal = AutoLockRenewer(max_workers=4)\n with\
- \ servicebus_receiver:\n for message in servicebus_receiver:\n #\
- \ Auto renew message for 1 minute.\n lock_renewal.register(servicebus_receiver,\
- \ message, max_lock_renewal_duration=60)\n process_message(message)\n\
- \ servicebus_receiver.complete_message(message)\n\n ````\n\nAutomatically\
- \ renew a session lock<!--[!code-python[Main](les\\sync_samples\\sample_code_servicebus.py\
- \ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
+ \\samples\\\\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.servicebus import AutoLockRenewer\n\
+ \ lock_renewal = AutoLockRenewer(max_workers=4)\n with servicebus_receiver:\n\
+ \ for message in servicebus_receiver:\n # Auto renew message for\
+ \ 1 minute.\n lock_renewal.register(servicebus_receiver, message, max_lock_renewal_duration=60)\n\
+ \ process_message(message)\n servicebus_receiver.complete_message(message)\n\
+ \n ````\n\nAutomatically renew a session lock<!--[!code-python[Main](les\\sync_samples\\\
+ sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.servicebus\
\ import AutoLockRenewer\n\n lock_renewal = AutoLockRenewer(max_workers=4)\n\
diff --git a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusClient.yml b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusClient.yml
index ed84f617ffc1..e50b57d70145 100644
--- a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusClient.yml
+++ b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusClient.yml
@@ -132,15 +132,15 @@ variables:
examples:
- "Create a new instance of the ServiceBusClient.<!--[!code-python[Main](les\\sync_samples\\\
sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\\
- sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n import os\n from azure.identity import\
- \ DefaultAzureCredential\n from azure.servicebus import ServiceBusClient\n fully_qualified_namespace\
- \ = os.environ['SERVICEBUS_FULLY_QUALIFIED_NAMESPACE']\n servicebus_client = ServiceBusClient(\n\
- \ fully_qualified_namespace=fully_qualified_namespace,\n credential=DefaultAzureCredential()\n\
- \ )\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
+ \ from azure.identity import DefaultAzureCredential\n from azure.servicebus\
+ \ import ServiceBusClient\n fully_qualified_namespace = os.environ['SERVICEBUS_FULLY_QUALIFIED_NAMESPACE']\n\
+ \ servicebus_client = ServiceBusClient(\n fully_qualified_namespace=fully_qualified_namespace,\n\
+ \ credential=DefaultAzureCredential()\n )\n\n ````\n"
methods:
- uid: azure.servicebus.ServiceBusClient.close
name: close
@@ -255,12 +255,13 @@ methods:
- "Create a new instance of the ServiceBusClient from connection string.<!--[!code-python[Main](les\\\
sync_samples\\sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
- \\samples\\\\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.servicebus\
- \ import ServiceBusClient\n servicebus_connection_str = os.environ['SERVICEBUS_CONNECTION_STR']\n\
- \ servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.servicebus import ServiceBusClient\n\
+ \ servicebus_connection_str = os.environ['SERVICEBUS_CONNECTION_STR']\n servicebus_client\
+ \ = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)\n\
\n ````\n"
- uid: azure.servicebus.ServiceBusClient.get_queue_receiver
name: get_queue_receiver
@@ -373,12 +374,13 @@ methods:
- "Create a new instance of the ServiceBusReceiver from ServiceBusClient.<!--[!code-python[Main](les\\\
sync_samples\\sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
- \\samples\\\\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.servicebus\
- \ import ServiceBusClient\n servicebus_connection_str = os.environ['SERVICEBUS_CONNECTION_STR']\n\
- \ queue_name = os.environ['SERVICEBUS_QUEUE_NAME']\n servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.servicebus import ServiceBusClient\n\
+ \ servicebus_connection_str = os.environ['SERVICEBUS_CONNECTION_STR']\n queue_name\
+ \ = os.environ['SERVICEBUS_QUEUE_NAME']\n servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)\n\
\ with servicebus_client:\n queue_receiver = servicebus_client.get_queue_receiver(queue_name=queue_name)\n\
\n ````\n"
- uid: azure.servicebus.ServiceBusClient.get_queue_sender
@@ -407,12 +409,13 @@ methods:
- "Create a new instance of the ServiceBusSender from ServiceBusClient.<!--[!code-python[Main](les\\\
sync_samples\\sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
- \\samples\\\\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.servicebus\
- \ import ServiceBusClient\n servicebus_connection_str = os.environ['SERVICEBUS_CONNECTION_STR']\n\
- \ queue_name = os.environ['SERVICEBUS_QUEUE_NAME']\n servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.servicebus import ServiceBusClient\n\
+ \ servicebus_connection_str = os.environ['SERVICEBUS_CONNECTION_STR']\n queue_name\
+ \ = os.environ['SERVICEBUS_QUEUE_NAME']\n servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)\n\
\ with servicebus_client:\n queue_sender = servicebus_client.get_queue_sender(queue_name=queue_name)\n\
\n ````\n"
- uid: azure.servicebus.ServiceBusClient.get_subscription_receiver
@@ -534,13 +537,14 @@ methods:
- "Create a new instance of the ServiceBusReceiver from ServiceBusClient.<!--[!code-python[Main](les\\\
sync_samples\\sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
- \\samples\\\\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.servicebus\
- \ import ServiceBusClient\n servicebus_connection_str = os.environ['SERVICEBUS_CONNECTION_STR']\n\
- \ topic_name = os.environ[\"SERVICEBUS_TOPIC_NAME\"]\n subscription_name =\
- \ os.environ[\"SERVICEBUS_SUBSCRIPTION_NAME\"]\n servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.servicebus import ServiceBusClient\n\
+ \ servicebus_connection_str = os.environ['SERVICEBUS_CONNECTION_STR']\n topic_name\
+ \ = os.environ[\"SERVICEBUS_TOPIC_NAME\"]\n subscription_name = os.environ[\"\
+ SERVICEBUS_SUBSCRIPTION_NAME\"]\n servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)\n\
\ with servicebus_client:\n subscription_receiver = servicebus_client.get_subscription_receiver(\n\
\ topic_name=topic_name,\n subscription_name=subscription_name,\n\
\ )\n\n ````\n"
@@ -570,11 +574,12 @@ methods:
- "Create a new instance of the ServiceBusSender from ServiceBusClient.<!--[!code-python[Main](les\\\
sync_samples\\sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
- \\samples\\\\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.servicebus\
- \ import ServiceBusClient\n servicebus_connection_str = os.environ['SERVICEBUS_CONNECTION_STR']\n\
- \ topic_name = os.environ['SERVICEBUS_TOPIC_NAME']\n servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)\n\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n import os\n from azure.servicebus import ServiceBusClient\n\
+ \ servicebus_connection_str = os.environ['SERVICEBUS_CONNECTION_STR']\n topic_name\
+ \ = os.environ['SERVICEBUS_TOPIC_NAME']\n servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)\n\
\ with servicebus_client:\n topic_sender = servicebus_client.get_topic_sender(topic_name=topic_name)\n\
\n ````\n"
diff --git a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusMessage.yml b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusMessage.yml
index b9a167b17f24..9c3fd2a4a4ee 100644
--- a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusMessage.yml
+++ b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusMessage.yml
@@ -78,12 +78,12 @@ constructor:
examples:
- "Sending a message with additional properties<!--[!code-python[Main](les\\sync_samples\\\
sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\\
- sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n message = ServiceBusMessage(\n \"\
- Hello World!!\",\n session_id=\"MySessionID\",\n application_properties={'data':\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n message = ServiceBusMessage(\n\
+ \ \"Hello World!!\",\n session_id=\"MySessionID\",\n application_properties={'data':\
\ 'custom_data'},\n time_to_live=datetime.timedelta(seconds=30),\n label='MyLabel'\n\
\ )\n\n ````\n"
attributes:
diff --git a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusReceivedMessage.yml b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusReceivedMessage.yml
index 781880efde69..fca91b0edbac 100644
--- a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusReceivedMessage.yml
+++ b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusReceivedMessage.yml
@@ -26,22 +26,22 @@ variables:
examples:
- "Checking the properties on a received message.<!--[!code-python[Main](les\\sync_samples\\\
sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\\
- sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\"\
- : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
- linenos\": false} -->\n\n````python\n\n messages = servicebus_receiver.receive_messages(max_wait_time=5)\n\
- \ for message in messages:\n print(\"Receiving: {}\".format(message))\n\
- \ print(\"Time to live: {}\".format(message.time_to_live))\n \
- \ print(\"Sequence number: {}\".format(message.sequence_number))\n print(\"\
- Enqueued Sequence number: {}\".format(message.enqueued_sequence_number))\n \
- \ print(\"Partition Key: {}\".format(message.partition_key))\n print(\"\
- Application Properties: {}\".format(message.application_properties))\n \
- \ print(\"Delivery count: {}\".format(message.delivery_count))\n print(\"\
- Message ID: {}\".format(message.message_id))\n print(\"Locked until: {}\"\
- .format(message.locked_until_utc))\n print(\"Lock Token: {}\".format(message.lock_token))\n\
- \ print(\"Enqueued time: {}\".format(message.enqueued_time_utc))\n\n \
- \ ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n messages\
+ \ = servicebus_receiver.receive_messages(max_wait_time=5)\n for message in\
+ \ messages:\n print(\"Receiving: {}\".format(message))\n print(\"\
+ Time to live: {}\".format(message.time_to_live))\n print(\"Sequence number:\
+ \ {}\".format(message.sequence_number))\n print(\"Enqueued Sequence number:\
+ \ {}\".format(message.enqueued_sequence_number))\n print(\"Partition Key:\
+ \ {}\".format(message.partition_key))\n print(\"Application Properties:\
+ \ {}\".format(message.application_properties))\n print(\"Delivery count:\
+ \ {}\".format(message.delivery_count))\n print(\"Message ID: {}\".format(message.message_id))\n\
+ \ print(\"Locked until: {}\".format(message.locked_until_utc))\n \
+ \ print(\"Lock Token: {}\".format(message.lock_token))\n print(\"\
+ Enqueued time: {}\".format(message.enqueued_time_utc))\n\n ````\n"
attributes:
- uid: azure.servicebus.ServiceBusReceivedMessage.dead_letter_error_description
name: dead_letter_error_description
diff --git a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusReceiver.yml b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusReceiver.yml
index 4bb179c7946b..6a9d3cf4714a 100644
--- a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusReceiver.yml
+++ b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusReceiver.yml
@@ -193,8 +193,9 @@ methods:
examples:
- "Abandon a received message.<!--[!code-python[Main](les\\sync_samples\\sample_code_servicebus.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n messages = servicebus_receiver.receive_messages(max_wait_time=5)\n \
@@ -228,8 +229,9 @@ methods:
examples:
- "Complete a received message.<!--[!code-python[Main](les\\sync_samples\\sample_code_servicebus.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n messages = servicebus_receiver.receive_messages(max_wait_time=5)\n \
@@ -277,8 +279,9 @@ methods:
examples:
- "Dead letter a received message.<!--[!code-python[Main](les\\sync_samples\\sample_code_servicebus.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n messages = servicebus_receiver.receive_messages(max_wait_time=5)\n \
@@ -311,8 +314,9 @@ methods:
examples:
- "Defer a received message.<!--[!code-python[Main](les\\sync_samples\\sample_code_servicebus.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n messages = servicebus_receiver.receive_messages(max_wait_time=5)\n \
@@ -357,13 +361,14 @@ methods:
examples:
- "Look at pending messages in the queue.<!--[!code-python[Main](les\\sync_samples\\\
sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\
- \\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n with servicebus_receiver:\n\
- \ messages = servicebus_receiver.peek_messages()\n for message in\
- \ messages:\n print(str(message))\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n with servicebus_receiver:\n messages =\
+ \ servicebus_receiver.peek_messages()\n for message in messages:\n \
+ \ print(str(message))\n\n ````\n"
- uid: azure.servicebus.ServiceBusReceiver.receive_deferred_messages
name: receive_deferred_messages
summary: 'Receive messages that have previously been deferred.
@@ -395,12 +400,13 @@ methods:
examples:
- "Receive deferred messages from ServiceBus.<!--[!code-python[Main](les\\sync_samples\\\
sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\
- \\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n with servicebus_receiver:\n\
- \ deferred_sequenced_numbers = []\n messages = servicebus_receiver.receive_messages(max_wait_time=5)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n with servicebus_receiver:\n deferred_sequenced_numbers\
+ \ = []\n messages = servicebus_receiver.receive_messages(max_wait_time=5)\n\
\ for message in messages:\n deferred_sequenced_numbers.append(message.sequence_number)\n\
\ print(str(message))\n servicebus_receiver.defer_message(message)\n\
\n received_deferred_msg = servicebus_receiver.receive_deferred_messages(\n\
@@ -465,13 +471,14 @@ methods:
examples:
- "Receive messages from ServiceBus.<!--[!code-python[Main](les\\sync_samples\\\
sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\
- \\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n with servicebus_receiver:\n\
- \ messages = servicebus_receiver.receive_messages(max_wait_time=5)\n \
- \ for message in messages:\n print(str(message))\n servicebus_receiver.complete_message(message)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n with servicebus_receiver:\n messages =\
+ \ servicebus_receiver.receive_messages(max_wait_time=5)\n for message in\
+ \ messages:\n print(str(message))\n servicebus_receiver.complete_message(message)\n\
\n ````\n"
- uid: azure.servicebus.ServiceBusReceiver.renew_message_lock
name: renew_message_lock
@@ -521,11 +528,12 @@ methods:
examples:
- "Renew the lock on a received message.<!--[!code-python[Main](les\\sync_samples\\\
sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\
- \\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n messages = servicebus_receiver.receive_messages(max_wait_time=5)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n messages = servicebus_receiver.receive_messages(max_wait_time=5)\n\
\ for message in messages:\n servicebus_receiver.renew_message_lock(message)\n\
\n ````\n"
attributes:
@@ -548,8 +556,9 @@ attributes:
examples:
- "Get session from a receiver<!--[!code-python[Main](les\\sync_samples\\sample_code_servicebus.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n with servicebus_client.get_queue_receiver(queue_name=queue_name, session_id=session_id)\
diff --git a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusSender.yml b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusSender.yml
index f82dfee37e2e..35085a7ee5b9 100644
--- a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusSender.yml
+++ b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusSender.yml
@@ -125,11 +125,12 @@ methods:
- "Cancelling messages scheduled to be sent in future<!--[!code-python[Main](les\\\
sync_samples\\sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
- \\samples\\\\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n with servicebus_sender:\n \
- \ servicebus_sender.cancel_scheduled_messages(sequence_nums)\n\n ````\n"
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n with servicebus_sender:\n servicebus_sender.cancel_scheduled_messages(sequence_nums)\n\
+ \n ````\n"
- uid: azure.servicebus.ServiceBusSender.create_message_batch
name: create_message_batch
summary: 'Create a ServiceBusMessageBatch object with the max size of all content
@@ -154,11 +155,12 @@ methods:
- "Create ServiceBusMessageBatch object within limited size<!--[!code-python[Main](les\\\
sync_samples\\sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\":\
\ [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
- : \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
- \\samples\\\\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n with servicebus_sender:\n \
- \ batch_message = servicebus_sender.create_message_batch()\n batch_message.add_message(ServiceBusMessage(\"\
+ : \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n with servicebus_sender:\n batch_message\
+ \ = servicebus_sender.create_message_batch()\n batch_message.add_message(ServiceBusMessage(\"\
Single message inside batch\"))\n\n ````\n"
- uid: azure.servicebus.ServiceBusSender.schedule_messages
name: schedule_messages
@@ -193,15 +195,16 @@ methods:
examples:
- "Schedule a message to be sent in future<!--[!code-python[Main](les\\sync_samples\\\
sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\
- \\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n with servicebus_sender:\n \
- \ scheduled_time_utc = datetime.datetime.utcnow() + datetime.timedelta(seconds=30)\n\
- \ scheduled_messages = [ServiceBusMessage(\"Scheduled message\") for _ in\
- \ range(10)]\n sequence_nums = servicebus_sender.schedule_messages(scheduled_messages,\
- \ scheduled_time_utc)\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n with servicebus_sender:\n scheduled_time_utc\
+ \ = datetime.datetime.utcnow() + datetime.timedelta(seconds=30)\n scheduled_messages\
+ \ = [ServiceBusMessage(\"Scheduled message\") for _ in range(10)]\n sequence_nums\
+ \ = servicebus_sender.schedule_messages(scheduled_messages, scheduled_time_utc)\n\
+ \n ````\n"
- uid: azure.servicebus.ServiceBusSender.send_messages
name: send_messages
summary: 'Sends message and blocks until acknowledgement is received or operation
@@ -237,8 +240,9 @@ methods:
examples:
- "Send message.<!--[!code-python[Main](les\\sync_samples\\sample_code_servicebus.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n with servicebus_sender:\n message = ServiceBusMessage(\"Hello World\"\
diff --git a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusSession.yml b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusSession.yml
index 5df087032131..09d89b8f0026 100644
--- a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusSession.yml
+++ b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.ServiceBusSession.yml
@@ -28,10 +28,11 @@ variables:
examples:
- "Get session from a receiver<!--[!code-python[Main](les\\sync_samples\\sample_code_servicebus.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n with servicebus_client.get_queue_receiver(queue_name=queue_name,\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
+ \\samples\\\\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\"\
+ , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
+ : 1}, \"linenos\": false} -->\n\n````python\n\n with servicebus_client.get_queue_receiver(queue_name=queue_name,\
\ session_id=session_id) as receiver:\n session = receiver.session\n\n\
\ ````\n"
methods:
@@ -56,8 +57,9 @@ methods:
examples:
- "Get the session state<!--[!code-python[Main](les\\sync_samples\\sample_code_servicebus.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n with servicebus_client.get_queue_receiver(queue_name=queue_name, session_id=session_id)\
@@ -97,11 +99,12 @@ methods:
examples:
- "Renew the session lock before it expires<!--[!code-python[Main](les\\sync_samples\\\
sample_code_servicebus.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\
- \\sync_samples\\\\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"\
- force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n with servicebus_client.get_queue_receiver(queue_name=queue_name,\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\
+ \\sample_code_servicebus.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n with servicebus_client.get_queue_receiver(queue_name=queue_name,\
\ session_id=session_id) as receiver:\n session = receiver.session\n\
\ session.renew_lock()\n\n ````\n"
- uid: azure.servicebus.ServiceBusSession.set_state
@@ -125,8 +128,9 @@ methods:
examples:
- "Set the session state<!--[!code-python[Main](les\\sync_samples\\sample_code_servicebus.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\sync_samples\\\\sample_code_servicebus.py\"\
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
\n with servicebus_client.get_queue_receiver(queue_name=queue_name, session_id=session_id)\
diff --git a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.AutoLockRenewer.yml b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.AutoLockRenewer.yml
index 74e2d258d8aa..56543a796a29 100644
--- a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.AutoLockRenewer.yml
+++ b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.AutoLockRenewer.yml
@@ -36,21 +36,22 @@ constructor:
examples:
- "Automatically renew a message lock<!--[!code-python[Main](les\\async_samples\\\
sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\\
- async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n from azure.servicebus.aio import\
- \ AutoLockRenewer\n\n lock_renewal = AutoLockRenewer()\n async with servicebus_receiver:\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.servicebus.aio\
+ \ import AutoLockRenewer\n\n lock_renewal = AutoLockRenewer()\n async with servicebus_receiver:\n\
\ async for message in servicebus_receiver:\n lock_renewal.register(servicebus_receiver,\
\ message, max_lock_renewal_duration=60)\n await process_message(message)\n\
\ await servicebus_receiver.complete_message(message)\n\n ````\n\nAutomatically\
\ renew a session lock<!--[!code-python[Main](les\\async_samples\\sample_code_servicebus_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.servicebus.aio\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
+ \\samples\\\\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\":\
+ \ \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
+ \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.servicebus.aio\
\ import AutoLockRenewer\n\n lock_renewal = AutoLockRenewer()\n async\
\ with servicebus_client.get_queue_receiver(queue_name=queue_name, session_id=session_id)\
\ as receiver:\n session = receiver.session\n # Auto renew session\
diff --git a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusClient.yml b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusClient.yml
index 808d23d3e766..a1f85c63b216 100644
--- a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusClient.yml
+++ b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusClient.yml
@@ -132,13 +132,13 @@ variables:
examples:
- "Create a new instance of the ServiceBusClient.<!--[!code-python[Main](les\\async_samples\\\
sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\
- \\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\\
- async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n import os\n from azure.identity.aio\
- \ import DefaultAzureCredential\n from azure.servicebus.aio import ServiceBusClient\n\
- \ fully_qualified_namespace = os.environ['SERVICEBUS_FULLY_QUALIFIED_NAMESPACE']\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
+ \\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
+ \\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
+ : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
+ \ from azure.identity.aio import DefaultAzureCredential\n from azure.servicebus.aio\
+ \ import ServiceBusClient\n fully_qualified_namespace = os.environ['SERVICEBUS_FULLY_QUALIFIED_NAMESPACE']\n\
\ servicebus_client = ServiceBusClient(\n fully_qualified_namespace=fully_qualified_namespace,\n\
\ credential=DefaultAzureCredential()\n )\n\n ````\n"
methods:
@@ -255,7 +255,8 @@ methods:
- "Create a new instance of the ServiceBusClient from connection string.<!--[!code-python[Main](les\\\
async_samples\\sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -375,7 +376,8 @@ methods:
- "Create a new instance of the ServiceBusSender from ServiceBusClient.<!--[!code-python[Main](les\\\
async_samples\\sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -410,7 +412,8 @@ methods:
- "Create a new instance of the ServiceBusClient from connection string.<!--[!code-python[Main](les\\\
async_samples\\sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -540,7 +543,8 @@ methods:
- "Create a new instance of the ServiceBusReceiver from ServiceBusClient.<!--[!code-python[Main](les\\\
async_samples\\sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
@@ -577,7 +581,8 @@ methods:
- "Create a new instance of the ServiceBusSender from ServiceBusClient.<!--[!code-python[Main](les\\\
async_samples\\sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
diff --git a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusReceiver.yml b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusReceiver.yml
index 68d46166f1fd..aaa69680f56d 100644
--- a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusReceiver.yml
+++ b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusReceiver.yml
@@ -194,11 +194,12 @@ methods:
examples:
- "Abandon a received message.<!--[!code-python[Main](les\\async_samples\\sample_code_servicebus_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\\\
- sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
\ for message in messages:\n await servicebus_receiver.abandon_message(message)\n\
\n ````\n"
- uid: azure.servicebus.aio.ServiceBusReceiver.close
@@ -229,11 +230,12 @@ methods:
examples:
- "Complete a received message.<!--[!code-python[Main](les\\async_samples\\sample_code_servicebus_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\\\
- sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
\ for message in messages:\n await servicebus_receiver.complete_message(message)\n\
\n ````\n"
- uid: azure.servicebus.aio.ServiceBusReceiver.dead_letter_message
@@ -278,11 +280,12 @@ methods:
examples:
- "Dead letter a received message.<!--[!code-python[Main](les\\async_samples\\sample_code_servicebus_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\\\
- sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
\ for message in messages:\n await servicebus_receiver.dead_letter_message(message)\n\
\n ````\n"
- uid: azure.servicebus.aio.ServiceBusReceiver.defer_message
@@ -312,11 +315,12 @@ methods:
examples:
- "Defer a received message.<!--[!code-python[Main](les\\async_samples\\sample_code_servicebus_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\\\
- sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
\ for message in messages:\n await servicebus_receiver.defer_message(message)\n\
\n ````\n"
- uid: azure.servicebus.aio.ServiceBusReceiver.peek_messages
@@ -355,13 +359,13 @@ methods:
examples:
- "Peek messages in the queue.<!--[!code-python[Main](les\\async_samples\\sample_code_servicebus_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\\\
- sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n async with servicebus_receiver:\n messages\
- \ = await servicebus_receiver.peek_messages()\n for message in messages:\n\
- \ print(str(message))\n\n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n async with servicebus_receiver:\n messages = await servicebus_receiver.peek_messages()\n\
+ \ for message in messages:\n print(str(message))\n\n ````\n"
- uid: azure.servicebus.aio.ServiceBusReceiver.receive_deferred_messages
name: receive_deferred_messages
summary: 'Receive messages that have previously been deferred.
@@ -393,12 +397,13 @@ methods:
examples:
- "Receive deferred messages from ServiceBus.<!--[!code-python[Main](les\\async_samples\\\
sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\
- \\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n async with servicebus_receiver:\n\
- \ deferred_sequenced_numbers = []\n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\
+ \\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n async with servicebus_receiver:\n deferred_sequenced_numbers\
+ \ = []\n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
\ for message in messages:\n deferred_sequenced_numbers.append(message.sequence_number)\n\
\ print(str(message))\n await servicebus_receiver.defer_message(message)\n\
\n received_deferred_msg = await servicebus_receiver.receive_deferred_messages(\n\
@@ -464,14 +469,15 @@ methods:
examples:
- "Receive messages from ServiceBus.<!--[!code-python[Main](les\\async_samples\\\
sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\
- \\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n async with servicebus_receiver:\n\
- \ messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
- \ for message in messages:\n print(str(message))\n await\
- \ servicebus_receiver.complete_message(message)\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\
+ \\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n async with servicebus_receiver:\n messages\
+ \ = await servicebus_receiver.receive_messages(max_wait_time=5)\n for message\
+ \ in messages:\n print(str(message))\n await servicebus_receiver.complete_message(message)\n\
+ \n ````\n"
- uid: azure.servicebus.aio.ServiceBusReceiver.renew_message_lock
name: renew_message_lock
summary: 'Renew the message lock.
@@ -520,11 +526,12 @@ methods:
examples:
- "Renew the lock on a received message.<!--[!code-python[Main](les\\async_samples\\\
sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\
- \\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\
+ \\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n messages = await servicebus_receiver.receive_messages(max_wait_time=5)\n\
\ for message in messages:\n await servicebus_receiver.renew_message_lock(message)\n\
\n ````\n"
attributes:
@@ -547,10 +554,11 @@ attributes:
examples:
- "Get session from a receiver<!--[!code-python[Main](les\\async_samples\\sample_code_servicebus_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\\\
- sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n async with servicebus_client.get_queue_receiver(queue_name=queue_name,\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n async with servicebus_client.get_queue_receiver(queue_name=queue_name,\
\ session_id=session_id) as receiver:\n session = receiver.session\n\
\n ````\n"
diff --git a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusSender.yml b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusSender.yml
index 1ccf9368e0ac..0cef74f95781 100644
--- a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusSender.yml
+++ b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusSender.yml
@@ -129,7 +129,8 @@ methods:
- "Cancelling messages scheduled to be sent in future<!--[!code-python[Main](les\\\
async_samples\\sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n async with\
@@ -160,7 +161,8 @@ methods:
- "Create ServiceBusMessageBatch object within limited size<!--[!code-python[Main](les\\\
async_samples\\sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"\
ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [],\
- \ \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
+ \ \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\\
+ Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n async with\
@@ -203,15 +205,16 @@ methods:
examples:
- "Schedule a message to be sent in future<!--[!code-python[Main](les\\async_samples\\\
sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\
- \\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n async with servicebus_sender:\n\
- \ scheduled_time_utc = datetime.datetime.utcnow() + datetime.timedelta(seconds=30)\n\
- \ scheduled_messages = [ServiceBusMessage(\"Scheduled message\") for _ in\
- \ range(10)]\n sequence_nums = await servicebus_sender.schedule_messages(scheduled_messages,\
- \ scheduled_time_utc)\n\n ````\n"
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\
+ \\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n async with servicebus_sender:\n scheduled_time_utc\
+ \ = datetime.datetime.utcnow() + datetime.timedelta(seconds=30)\n scheduled_messages\
+ \ = [ServiceBusMessage(\"Scheduled message\") for _ in range(10)]\n sequence_nums\
+ \ = await servicebus_sender.schedule_messages(scheduled_messages, scheduled_time_utc)\n\
+ \n ````\n"
- uid: azure.servicebus.aio.ServiceBusSender.send_messages
name: send_messages
summary: 'Sends message and blocks until acknowledgement is received or operation
@@ -248,13 +251,13 @@ methods:
examples:
- "Send message.<!--[!code-python[Main](les\\async_samples\\sample_code_servicebus_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\\\
- sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n async with servicebus_sender:\n message\
- \ = ServiceBusMessage(\"Hello World\")\n await servicebus_sender.send_messages(message)\n\
- \n ````\n"
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n async with servicebus_sender:\n message = ServiceBusMessage(\"Hello\
+ \ World\")\n await servicebus_sender.send_messages(message)\n\n ````\n"
attributes:
- uid: azure.servicebus.aio.ServiceBusSender.client_identifier
name: client_identifier
diff --git a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusSession.yml b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusSession.yml
index bb6f6c625eb2..df313b1d8e0c 100644
--- a/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusSession.yml
+++ b/preview/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.ServiceBusSession.yml
@@ -21,10 +21,11 @@ constructor:
examples:
- "Get session from a receiver<!--[!code-python[Main](les\\async_samples\\sample_code_servicebus_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\\
- 243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
- , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
- : {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n async with\
+ : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
+ \\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\
+ \\samples\\\\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\":\
+ \ \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
+ \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n async with\
\ servicebus_client.get_queue_receiver(queue_name=queue_name, session_id=session_id)\
\ as receiver:\n session = receiver.session\n\n ````\n"
methods:
@@ -49,11 +50,12 @@ methods:
examples:
- "Get the session state<!--[!code-python[Main](les\\async_samples\\sample_code_servicebus_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\\\
- sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n async with servicebus_client.get_queue_receiver(queue_name=queue_name,\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n async with servicebus_client.get_queue_receiver(queue_name=queue_name,\
\ session_id=session_id) as receiver:\n session = receiver.session\n\
\ session_state = await session.get_state()\n\n ````\n"
- uid: azure.servicebus.aio.ServiceBusSession.renew_lock
@@ -91,11 +93,12 @@ methods:
examples:
- "Renew the session lock before it expires<!--[!code-python[Main](les\\async_samples\\\
sample_code_servicebus_async.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\\
- a\\\\_work\\\\1\\\\s\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\
- \\async_samples\\\\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\"\
- , \"force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
- : 1}, \"linenos\": false} -->\n\n````python\n\n async with servicebus_client.get_queue_receiver(queue_name=queue_name,\
+ : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\\
+ hostedtoolcache\\\\windows\\\\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\
+ \\py2docfx\\\\dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\
+ \\sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
+ \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
+ : false} -->\n\n````python\n\n async with servicebus_client.get_queue_receiver(queue_name=queue_name,\
\ session_id=session_id) as receiver:\n session = receiver.session\n\
\ await session.renew_lock()\n\n ````\n"
- uid: azure.servicebus.aio.ServiceBusSession.set_state
@@ -122,10 +125,11 @@ methods:
examples:
- "Set the session state<!--[!code-python[Main](les\\async_samples\\sample_code_servicebus_async.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"\
- dupnames\": [], \"backrefs\": [], \"source\": \"D:\\\\a\\\\_work\\\\1\\\\s\\\\\
- dist_temp\\\\243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\\\
- sample_code_servicebus_async.py\", \"xml:space\": \"preserve\", \"force\": false,\
- \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
- : false} -->\n\n````python\n\n async with servicebus_client.get_queue_receiver(queue_name=queue_name,\
+ dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\
+ \\Python\\\\3.11.5\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\\
+ 243\\\\azure-servicebus-7.10.0b1\\\\samples\\\\async_samples\\\\sample_code_servicebus_async.py\"\
+ , \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"\
+ highlight_args\": {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\
+ \n async with servicebus_client.get_queue_receiver(queue_name=queue_name,\
\ session_id=session_id) as receiver:\n session = receiver.session\n\
\ await session.set_state(\"START\")\n\n ````\n"
diff --git a/preview/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.yml b/preview/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.yml
deleted file mode 100644
index fe7eb7588a49..000000000000
--- a/preview/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-### YamlMime:PythonPackage
-uid: azure.servicemanagement
-name: servicemanagement
-fullName: azure.servicemanagement
-type: import
-modules:
-- azure.servicemanagement.constants
-- azure.servicemanagement.models
-- azure.servicemanagement.publishsettings
-- azure.servicemanagement.schedulermanagementservice
-- azure.servicemanagement.servicebusmanagementservice
-- azure.servicemanagement.servicemanagementclient
-- azure.servicemanagement.servicemanagementservice
-- azure.servicemanagement.sqldatabasemanagementservice
-- azure.servicemanagement.websitemanagementservice
diff --git a/preview/docs-ref-autogen/azure-servicemanagement-legacy/index.yml b/preview/docs-ref-autogen/azure-servicemanagement-legacy/index.yml
index 3473d1f52d72..c3632700254f 100644
--- a/preview/docs-ref-autogen/azure-servicemanagement-legacy/index.yml
+++ b/preview/docs-ref-autogen/azure-servicemanagement-legacy/index.yml
@@ -3,8 +3,6 @@ uid: project-azure-servicemanagement-legacy
name: azure-servicemanagement-legacy
fullName: azure-servicemanagement-legacy
type: distribution
-packages:
-- azure.servicemanagement
modules:
- azure.servicemanagement.constants
- azure.servicemanagement.models
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.AccessControlClient.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.AccessControlClient.yml
index 297d67e0aa0e..e3f5960c09ca 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.AccessControlClient.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.AccessControlClient.yml
@@ -20,15 +20,16 @@ constructor:
isRequired: true
types:
- <xref:str>
+ - name: polling_interval
+ description: Default waiting time between two polls for LRO operations if no Retry-After
+ header is present.
+ types:
+ - <xref:int>
variables:
-- description: RoleAssignmentsOperations operations
- name: role_assignments
- types:
- - <xref:azure.synapse.accesscontrol.operations.RoleAssignmentsOperations>
-- description: RoleDefinitionsOperations operations
- name: role_definitions
+- description: AccessControlOperations operations
+ name: access_control
types:
- - <xref:azure.synapse.accesscontrol.operations.RoleDefinitionsOperations>
+ - <xref:azure.synapse.accesscontrol.operations.AccessControlOperations>
methods:
- uid: azure.synapse.accesscontrol.AccessControlClient.close
name: close
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.AccessControlClient.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.AccessControlClient.yml
index 8ab8c4f39a1d..fa118ed8f58f 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.AccessControlClient.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.AccessControlClient.yml
@@ -20,15 +20,16 @@ constructor:
isRequired: true
types:
- <xref:str>
+ - name: polling_interval
+ description: Default waiting time between two polls for LRO operations if no Retry-After
+ header is present.
+ types:
+ - <xref:int>
variables:
-- description: RoleAssignmentsOperations operations
- name: role_assignments
- types:
- - <xref:azure.synapse.accesscontrol.aio.operations.RoleAssignmentsOperations>
-- description: RoleDefinitionsOperations operations
- name: role_definitions
+- description: AccessControlOperations operations
+ name: access_control
types:
- - <xref:azure.synapse.accesscontrol.aio.operations.RoleDefinitionsOperations>
+ - <xref:azure.synapse.accesscontrol.aio.operations_async.AccessControlOperations>
methods:
- uid: azure.synapse.accesscontrol.aio.AccessControlClient.close
name: close
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.operations_async.AccessControlOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.operations_async.AccessControlOperations.yml
index 94d62cd5596a..2d95c64d7100 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.operations_async.AccessControlOperations.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.operations_async.AccessControlOperations.yml
@@ -34,8 +34,8 @@ 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: models.RoleAssignmentOptions,
- **kwargs) -> models.RoleAssignmentDetails'
+ 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.
@@ -144,7 +144,7 @@ methods:
- 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) -> models.SynapseRole'
+ signature: 'async get_role_definition_by_id(role_id: str, **kwargs) -> SynapseRole'
parameters:
- name: role_id
description: Synapse Built-In Role Id.
@@ -164,7 +164,7 @@ methods:
- uid: azure.synapse.accesscontrol.aio.operations_async.AccessControlOperations.get_role_definitions
name: get_role_definitions
summary: List roles.
- signature: get_role_definitions(**kwargs) -> AsyncIterable[models.RolesListResponse]
+ signature: get_role_definitions(**kwargs) -> AsyncIterable[RolesListResponse]
parameters:
- name: cls
description: A custom type or function that will be passed the direct response
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.CheckAccessDecision.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.CheckAccessDecision.yml
deleted file mode 100644
index ed673e75d1f9..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.CheckAccessDecision.yml
+++ /dev/null
@@ -1,27 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.accesscontrol.models.CheckAccessDecision
-name: CheckAccessDecision
-fullName: azure.synapse.accesscontrol.models.CheckAccessDecision
-module: azure.synapse.accesscontrol.models
-inheritances:
-- msrest.serialization.Model
-summary: Check access response details.
-constructor:
- syntax: 'CheckAccessDecision(*, access_decision: str | None = None, action_id: str
- | None = None, role_assignment: RoleAssignmentDetails | None = None, **kwargs)'
- parameters:
- - name: access_decision
- description: Access Decision.
- isRequired: true
- types:
- - <xref:str>
- - name: action_id
- description: Action Id.
- isRequired: true
- types:
- - <xref:str>
- - name: role_assignment
- description: Role Assignment response details.
- isRequired: true
- types:
- - <xref:azure.synapse.accesscontrol.models.RoleAssignmentDetails>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.CheckPrincipalAccessRequest.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.CheckPrincipalAccessRequest.yml
deleted file mode 100644
index 65adef5c33b1..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.CheckPrincipalAccessRequest.yml
+++ /dev/null
@@ -1,30 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.accesscontrol.models.CheckPrincipalAccessRequest
-name: CheckPrincipalAccessRequest
-fullName: azure.synapse.accesscontrol.models.CheckPrincipalAccessRequest
-module: azure.synapse.accesscontrol.models
-inheritances:
-- msrest.serialization.Model
-summary: 'Check access request details.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'CheckPrincipalAccessRequest(*, subject: SubjectInfo, actions: List[RequiredAction],
- scope: str, **kwargs)'
- parameters:
- - name: subject
- description: Required. Subject details.
- isRequired: true
- types:
- - <xref:azure.synapse.accesscontrol.models.SubjectInfo>
- - name: actions
- description: Required. List of actions.
- isRequired: true
- types:
- - <xref:list>[<xref:azure.synapse.accesscontrol.models.RequiredAction>]
- - name: scope
- description: Required. Scope at which the check access is done.
- isRequired: true
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.CheckPrincipalAccessResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.CheckPrincipalAccessResponse.yml
deleted file mode 100644
index 5e2dc864427f..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.CheckPrincipalAccessResponse.yml
+++ /dev/null
@@ -1,19 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.accesscontrol.models.CheckPrincipalAccessResponse
-name: CheckPrincipalAccessResponse
-fullName: azure.synapse.accesscontrol.models.CheckPrincipalAccessResponse
-module: azure.synapse.accesscontrol.models
-inheritances:
-- msrest.serialization.Model
-summary: Check access response details.
-constructor:
- syntax: 'CheckPrincipalAccessResponse(*, access_decisions: List[CheckAccessDecision]
- | None = None, **kwargs)'
- parameters:
- - name: access_decisions
- description: 'To check if the current user, group, or service principal has
-
- permission to read artifacts in the specified workspace.'
- isRequired: true
- types:
- - <xref:list>[<xref:azure.synapse.accesscontrol.models.CheckAccessDecision>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorAdditionalInfo.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorAdditionalInfo.yml
deleted file mode 100644
index 483ef4d8bc76..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorAdditionalInfo.yml
+++ /dev/null
@@ -1,22 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.accesscontrol.models.ErrorAdditionalInfo
-name: ErrorAdditionalInfo
-fullName: azure.synapse.accesscontrol.models.ErrorAdditionalInfo
-module: azure.synapse.accesscontrol.models
-inheritances:
-- msrest.serialization.Model
-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:
- - <xref:str>
-- description: The additional info.
- name: info
- types:
- - <xref:any>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorDetail.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorDetail.yml
new file mode 100644
index 000000000000..374334a07b60
--- /dev/null
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorDetail.yml
@@ -0,0 +1,28 @@
+### YamlMime:PythonClass
+uid: azure.synapse.accesscontrol.models.ErrorDetail
+name: ErrorDetail
+fullName: azure.synapse.accesscontrol.models.ErrorDetail
+module: azure.synapse.accesscontrol.models
+inheritances:
+- msrest.serialization.Model
+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:
+ - <xref:str>
+ - name: message
+ description: Required.
+ isRequired: true
+ types:
+ - <xref:str>
+ - name: target
+ isRequired: true
+ types:
+ - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorResponse.yml
index 505d779493a1..0e3da1531b69 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorResponse.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorResponse.yml
@@ -5,31 +5,29 @@ fullName: azure.synapse.accesscontrol.models.ErrorResponse
module: azure.synapse.accesscontrol.models
inheritances:
- msrest.serialization.Model
-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.).
+summary: '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: ErrorResponse(**kwargs)
-variables:
-- description: The error code.
- name: code
- types:
- - <xref:str>
-- description: The error message.
- name: message
- types:
- - <xref:str>
-- description: The error target.
- name: target
- types:
- - <xref:str>
-- description: The error details.
- name: details
- types:
- - <xref:list>[<xref:azure.synapse.accesscontrol.models.ErrorResponse>]
-- description: The error additional info.
- name: additional_info
- types:
- - <xref:list>[<xref:azure.synapse.accesscontrol.models.ErrorAdditionalInfo>]
+ syntax: 'ErrorResponse(*, code: str, message: str, target: str | None = None, details:
+ List[ErrorDetail] | None = None, **kwargs)'
+ parameters:
+ - name: code
+ description: Required.
+ isRequired: true
+ types:
+ - <xref:str>
+ - name: message
+ description: Required.
+ isRequired: true
+ types:
+ - <xref:str>
+ - name: target
+ isRequired: true
+ types:
+ - <xref:str>
+ - name: details
+ isRequired: true
+ types:
+ - <xref:list>[<xref:azure.synapse.accesscontrol.models.ErrorDetail>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RequiredAction.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RequiredAction.yml
deleted file mode 100644
index f470457a6d91..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RequiredAction.yml
+++ /dev/null
@@ -1,24 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.accesscontrol.models.RequiredAction
-name: RequiredAction
-fullName: azure.synapse.accesscontrol.models.RequiredAction
-module: azure.synapse.accesscontrol.models
-inheritances:
-- msrest.serialization.Model
-summary: 'Action Info.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'RequiredAction(*, id: str, is_data_action: bool, **kwargs)'
- parameters:
- - name: id
- description: Required. Action Id.
- isRequired: true
- types:
- - <xref:str>
- - name: is_data_action
- description: Required. Is a data action or not.
- isRequired: true
- types:
- - <xref:bool>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentDetails.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentDetails.yml
index e5fe64c6fde5..ab15504ad40d 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentDetails.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentDetails.yml
@@ -7,16 +7,15 @@ inheritances:
- msrest.serialization.Model
summary: Role Assignment response details.
constructor:
- syntax: 'RoleAssignmentDetails(*, id: str | None = None, role_definition_id: str
- | None = None, principal_id: str | None = None, scope: str | None = None, principal_type:
- str | None = None, **kwargs)'
+ 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:
- <xref:str>
- - name: role_definition_id
+ - name: role_id
description: Role ID of the Synapse Built-In Role.
isRequired: true
types:
@@ -26,13 +25,3 @@ constructor:
isRequired: true
types:
- <xref:str>
- - name: scope
- description: Scope at the role assignment is created.
- isRequired: true
- types:
- - <xref:str>
- - name: principal_type
- description: 'Type of the principal Id: User, Group or ServicePrincipal.'
- isRequired: true
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentDetailsList.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentDetailsList.yml
deleted file mode 100644
index f353b7669356..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentDetailsList.yml
+++ /dev/null
@@ -1,22 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.accesscontrol.models.RoleAssignmentDetailsList
-name: RoleAssignmentDetailsList
-fullName: azure.synapse.accesscontrol.models.RoleAssignmentDetailsList
-module: azure.synapse.accesscontrol.models
-inheritances:
-- msrest.serialization.Model
-summary: Role Assignment response details.
-constructor:
- syntax: 'RoleAssignmentDetailsList(*, count: int | None = None, value: List[RoleAssignmentDetails]
- | None = None, **kwargs)'
- parameters:
- - name: count
- description: Number of role assignments.
- isRequired: true
- types:
- - <xref:int>
- - name: value
- description: A list of role assignments.
- isRequired: true
- types:
- - <xref:list>[<xref:azure.synapse.accesscontrol.models.RoleAssignmentDetails>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentOptions.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentOptions.yml
new file mode 100644
index 000000000000..a470fde3d090
--- /dev/null
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentOptions.yml
@@ -0,0 +1,24 @@
+### YamlMime:PythonClass
+uid: azure.synapse.accesscontrol.models.RoleAssignmentOptions
+name: RoleAssignmentOptions
+fullName: azure.synapse.accesscontrol.models.RoleAssignmentOptions
+module: azure.synapse.accesscontrol.models
+inheritances:
+- msrest.serialization.Model
+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:
+ - <xref:str>
+ - name: principal_id
+ description: Required. Object ID of the AAD principal or security-group.
+ isRequired: true
+ types:
+ - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentRequest.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentRequest.yml
deleted file mode 100644
index f2be1dabca62..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentRequest.yml
+++ /dev/null
@@ -1,35 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.accesscontrol.models.RoleAssignmentRequest
-name: RoleAssignmentRequest
-fullName: azure.synapse.accesscontrol.models.RoleAssignmentRequest
-module: azure.synapse.accesscontrol.models
-inheritances:
-- msrest.serialization.Model
-summary: 'Role Assignment request details.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'RoleAssignmentRequest(*, role_id: str, principal_id: str, scope: str, principal_type:
- str | None = None, **kwargs)'
- parameters:
- - name: role_id
- description: Required. Role ID of the Synapse Built-In Role.
- isRequired: true
- types:
- - <xref:str>
- - name: principal_id
- description: Required. Object ID of the AAD principal or security-group.
- isRequired: true
- types:
- - <xref:str>
- - name: scope
- description: Required. Scope at which the role assignment is created.
- isRequired: true
- types:
- - <xref:str>
- - name: principal_type
- description: 'Type of the principal Id: User, Group or ServicePrincipal.'
- isRequired: true
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RolesListResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RolesListResponse.yml
new file mode 100644
index 000000000000..fe7905538bf6
--- /dev/null
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RolesListResponse.yml
@@ -0,0 +1,25 @@
+### YamlMime:PythonClass
+uid: azure.synapse.accesscontrol.models.RolesListResponse
+name: RolesListResponse
+fullName: azure.synapse.accesscontrol.models.RolesListResponse
+module: azure.synapse.accesscontrol.models
+inheritances:
+- msrest.serialization.Model
+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:
+ - <xref:list>[<xref:azure.synapse.accesscontrol.models.SynapseRole>]
+ - name: next_link
+ description: The link to the next page of results, if any remaining results exist.
+ isRequired: true
+ types:
+ - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.SubjectInfo.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.SubjectInfo.yml
deleted file mode 100644
index f6768dc2d690..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.SubjectInfo.yml
+++ /dev/null
@@ -1,24 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.accesscontrol.models.SubjectInfo
-name: SubjectInfo
-fullName: azure.synapse.accesscontrol.models.SubjectInfo
-module: azure.synapse.accesscontrol.models
-inheritances:
-- msrest.serialization.Model
-summary: 'Subject details.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SubjectInfo(*, principal_id: str, group_ids: List[str] | None = None, **kwargs)'
- parameters:
- - name: principal_id
- description: Required. Principal Id.
- isRequired: true
- types:
- - <xref:str>
- - name: group_ids
- description: List of group Ids that the principalId is part of.
- isRequired: true
- types:
- - <xref:list>[<xref:str>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.SynapseRbacPermission.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.SynapseRbacPermission.yml
deleted file mode 100644
index 80fff628dd7a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.SynapseRbacPermission.yml
+++ /dev/null
@@ -1,33 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.accesscontrol.models.SynapseRbacPermission
-name: SynapseRbacPermission
-fullName: azure.synapse.accesscontrol.models.SynapseRbacPermission
-module: azure.synapse.accesscontrol.models
-inheritances:
-- msrest.serialization.Model
-summary: Synapse role definition details.
-constructor:
- syntax: 'SynapseRbacPermission(*, actions: List[str] | None = None, not_actions:
- List[str] | None = None, data_actions: List[str] | None = None, not_data_actions:
- List[str] | None = None, **kwargs)'
- parameters:
- - name: actions
- description: List of actions.
- isRequired: true
- types:
- - <xref:list>[<xref:str>]
- - name: not_actions
- description: List of Not actions.
- isRequired: true
- types:
- - <xref:list>[<xref:str>]
- - name: data_actions
- description: List of data actions.
- isRequired: true
- types:
- - <xref:list>[<xref:str>]
- - name: not_data_actions
- description: List of Not data actions.
- isRequired: true
- types:
- - <xref:list>[<xref:str>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.SynapseRole.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.SynapseRole.yml
new file mode 100644
index 000000000000..70723804afb8
--- /dev/null
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.SynapseRole.yml
@@ -0,0 +1,30 @@
+### YamlMime:PythonClass
+uid: azure.synapse.accesscontrol.models.SynapseRole
+name: SynapseRole
+fullName: azure.synapse.accesscontrol.models.SynapseRole
+module: azure.synapse.accesscontrol.models
+inheritances:
+- msrest.serialization.Model
+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:
+ - <xref:str>
+ - name: name
+ description: Name of the Synapse role.
+ isRequired: true
+ types:
+ - <xref:str>
+ - name: is_built_in
+ description: Required. Is a built-in role or not.
+ isRequired: true
+ types:
+ - <xref:bool>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.SynapseRoleDefinition.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.SynapseRoleDefinition.yml
deleted file mode 100644
index 1033d33d926a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.SynapseRoleDefinition.yml
+++ /dev/null
@@ -1,49 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.accesscontrol.models.SynapseRoleDefinition
-name: SynapseRoleDefinition
-fullName: azure.synapse.accesscontrol.models.SynapseRoleDefinition
-module: azure.synapse.accesscontrol.models
-inheritances:
-- msrest.serialization.Model
-summary: Synapse role definition details.
-constructor:
- syntax: 'SynapseRoleDefinition(*, id: str | None = None, name: str | None = None,
- is_built_in: bool | None = None, description: str | None = None, permissions:
- List[SynapseRbacPermission] | None = None, scopes: List[str] | None = None, availability_status:
- str | None = None, **kwargs)'
- parameters:
- - name: id
- description: Role Definition ID.
- isRequired: true
- types:
- - <xref:str>
- - name: name
- description: Name of the Synapse role.
- isRequired: true
- types:
- - <xref:str>
- - name: is_built_in
- description: Is a built-in role or not.
- isRequired: true
- types:
- - <xref:bool>
- - name: description
- description: Description for the Synapse role.
- isRequired: true
- types:
- - <xref:str>
- - name: permissions
- description: Permissions for the Synapse role.
- isRequired: true
- types:
- - <xref:list>[<xref:azure.synapse.accesscontrol.models.SynapseRbacPermission>]
- - name: scopes
- description: Allowed scopes for the Synapse role.
- isRequired: true
- types:
- - <xref:list>[<xref:str>]
- - name: availability_status
- description: Availability of the Synapse role.
- isRequired: true
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.yml
index 8ab0153e058f..7d990b77c2ec 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.yml
@@ -4,16 +4,10 @@ name: models
fullName: azure.synapse.accesscontrol.models
type: import
classes:
-- azure.synapse.accesscontrol.models.CheckAccessDecision
-- azure.synapse.accesscontrol.models.CheckPrincipalAccessRequest
-- azure.synapse.accesscontrol.models.CheckPrincipalAccessResponse
-- azure.synapse.accesscontrol.models.ErrorAdditionalInfo
- azure.synapse.accesscontrol.models.ErrorContract
+- azure.synapse.accesscontrol.models.ErrorDetail
- azure.synapse.accesscontrol.models.ErrorResponse
-- azure.synapse.accesscontrol.models.RequiredAction
- azure.synapse.accesscontrol.models.RoleAssignmentDetails
-- azure.synapse.accesscontrol.models.RoleAssignmentDetailsList
-- azure.synapse.accesscontrol.models.RoleAssignmentRequest
-- azure.synapse.accesscontrol.models.SubjectInfo
-- azure.synapse.accesscontrol.models.SynapseRbacPermission
-- azure.synapse.accesscontrol.models.SynapseRoleDefinition
+- azure.synapse.accesscontrol.models.RoleAssignmentOptions
+- azure.synapse.accesscontrol.models.RolesListResponse
+- azure.synapse.accesscontrol.models.SynapseRole
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.operations.RoleAssignmentsOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.operations.AccessControlOperations.yml
similarity index 53%
rename from preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.operations.RoleAssignmentsOperations.yml
rename to preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.operations.AccessControlOperations.yml
index 6feb8047949a..80b7e42df927 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.operations.RoleAssignmentsOperations.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.operations.AccessControlOperations.yml
@@ -1,11 +1,11 @@
### YamlMime:PythonClass
-uid: azure.synapse.accesscontrol.operations.RoleAssignmentsOperations
-name: RoleAssignmentsOperations
-fullName: azure.synapse.accesscontrol.operations.RoleAssignmentsOperations
+uid: azure.synapse.accesscontrol.operations.AccessControlOperations
+name: AccessControlOperations
+fullName: azure.synapse.accesscontrol.operations.AccessControlOperations
module: azure.synapse.accesscontrol.operations
inheritances:
- builtins.object
-summary: 'RoleAssignmentsOperations operations.
+summary: 'AccessControlOperations operations.
You should not instantiate this class directly. Instead, you should create a Client
@@ -13,7 +13,7 @@ summary: 'RoleAssignmentsOperations operations.
instantiates it for you and attaches it as an attribute.'
constructor:
- syntax: RoleAssignmentsOperations(client, config, serializer, deserializer)
+ syntax: AccessControlOperations(client, config, serializer, deserializer)
parameters:
- name: client
description: Client for service requests.
@@ -31,110 +31,68 @@ variables:
- description: Alias to model classes used in this operation group.
name: models
methods:
-- uid: azure.synapse.accesscontrol.operations.RoleAssignmentsOperations.check_principal_access
- name: check_principal_access
- summary: Check if the given principalId has access to perform list of actions at
- a given scope.
- signature: 'check_principal_access(subject: ''_models.SubjectInfo'', actions: List[''_models.RequiredAction''],
- scope: str, **kwargs: Any) -> _models.CheckPrincipalAccessResponse'
+- 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: subject
- description: Subject details.
+ - name: create_role_assignment_options
+ description: Details of role id and object id.
isRequired: true
types:
- - <xref:azure.synapse.accesscontrol.models.SubjectInfo>
- - name: actions
- description: List of actions.
- isRequired: true
- types:
- - <xref:list>[<xref:azure.synapse.accesscontrol.models.RequiredAction>]
- - name: scope
- description: Scope at which the check access is done.
- isRequired: true
- types:
- - <xref:str>
+ - <xref:azure.synapse.accesscontrol.models.RoleAssignmentOptions>
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
- description: CheckPrincipalAccessResponse, or the result of cls(response)
+ description: RoleAssignmentDetails, or the result of cls(response)
types:
- - <xref:azure.synapse.accesscontrol.models.CheckPrincipalAccessResponse>
+ - <xref:azure.synapse.accesscontrol.models.RoleAssignmentDetails>
exceptions:
- type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.accesscontrol.operations.RoleAssignmentsOperations.create_role_assignment
- name: create_role_assignment
- summary: Create role assignment.
- signature: 'create_role_assignment(role_assignment_id: str, role_id: str, principal_id:
- str, scope: str, principal_type: str | None = None, **kwargs: Any) -> _models.RoleAssignmentDetails'
+- 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:
- <xref:str>
- - name: role_id
- description: Role ID of the Synapse Built-In Role.
- isRequired: true
- types:
- - <xref:str>
- - name: principal_id
- description: Object ID of the AAD principal or security-group.
- isRequired: true
- types:
- - <xref:str>
- - name: scope
- description: Scope at which the role assignment is created.
- isRequired: true
- types:
- - <xref:str>
- - name: principal_type
- description: 'Type of the principal Id: User, Group or ServicePrincipal.'
- defaultValue: None
- types:
- - <xref:str>
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
- description: RoleAssignmentDetails, or the result of cls(response)
+ description: None, or the result of cls(response)
types:
- - <xref:azure.synapse.accesscontrol.models.RoleAssignmentDetails>
+ - <xref:None>
exceptions:
- type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.accesscontrol.operations.RoleAssignmentsOperations.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, scope: str | None
- = None, **kwargs: Any) -> None'
+- 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]'
parameters:
- - name: role_assignment_id
- description: The ID of the role assignment.
- isRequired: true
- types:
- - <xref:str>
- - name: scope
- description: Scope of the Synapse Built-in Role.
- defaultValue: None
- types:
- - <xref:str>
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
- description: None, or the result of cls(response)
+ description: list of str, or the result of cls(response)
types:
- - <xref:None>
+ - <xref:list>[<xref:str>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.accesscontrol.operations.RoleAssignmentsOperations.get_role_assignment_by_id
+- 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'
+ models.RoleAssignmentDetails'
parameters:
- name: role_assignment_id
description: The ID of the role assignment.
@@ -151,12 +109,12 @@ methods:
- <xref:azure.synapse.accesscontrol.models.RoleAssignmentDetails>
exceptions:
- type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.accesscontrol.operations.RoleAssignmentsOperations.list_role_assignments
- name: list_role_assignments
+- uid: azure.synapse.accesscontrol.operations.AccessControlOperations.get_role_assignments
+ name: get_role_assignments
summary: List role assignments.
- signature: 'list_role_assignments(role_id: str | None = None, principal_id: str
- | None = None, scope: str | None = None, continuation_token_parameter: str | None
- = None, **kwargs: Any) -> _models.RoleAssignmentDetailsList'
+ 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.
@@ -168,11 +126,6 @@ methods:
defaultValue: None
types:
- <xref:str>
- - name: scope
- description: Scope of the Synapse Built-in Role.
- defaultValue: None
- types:
- - <xref:str>
- name: continuation_token_parameter
description: Continuation token.
defaultValue: None
@@ -183,12 +136,48 @@ methods:
types:
- <xref:callable>
return:
- description: RoleAssignmentDetailsList, or the result of cls(response)
+ description: list of RoleAssignmentDetails, or the result of cls(response)
+ types:
+ - <xref:list>[<xref:azure.synapse.accesscontrol.models.RoleAssignmentDetails>]
+ 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:
+ - <xref:str>
+ - name: cls
+ description: A custom type or function that will be passed the direct response
+ types:
+ - <xref:callable>
+ return:
+ description: SynapseRole, or the result of cls(response)
+ types:
+ - <xref:azure.synapse.accesscontrol.models.SynapseRole>
+ 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'']'
+ parameters:
+ - name: cls
+ description: A custom type or function that will be passed the direct response
+ types:
+ - <xref:callable>
+ return:
+ description: An iterator like instance of either RolesListResponse or the result
+ of cls(response)
types:
- - <xref:azure.synapse.accesscontrol.models.RoleAssignmentDetailsList>
+ - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.accesscontrol.models.RolesListResponse>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
-- uid: azure.synapse.accesscontrol.operations.RoleAssignmentsOperations.models
+- uid: azure.synapse.accesscontrol.operations.AccessControlOperations.models
name: models
signature: models = <module 'azure.synapse.accesscontrol.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.5\\x64\\Lib\\site-packages\\azure\\synapse\\accesscontrol\\models\\__init__.py'>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.operations.RoleDefinitionsOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.operations.RoleDefinitionsOperations.yml
deleted file mode 100644
index f42d4ac76c8e..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.operations.RoleDefinitionsOperations.yml
+++ /dev/null
@@ -1,99 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.accesscontrol.operations.RoleDefinitionsOperations
-name: RoleDefinitionsOperations
-fullName: azure.synapse.accesscontrol.operations.RoleDefinitionsOperations
-module: azure.synapse.accesscontrol.operations
-inheritances:
-- builtins.object
-summary: 'RoleDefinitionsOperations 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: RoleDefinitionsOperations(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.RoleDefinitionsOperations.get_role_definition_by_id
- name: get_role_definition_by_id
- summary: Get role definition by role definition Id.
- signature: 'get_role_definition_by_id(role_definition_id: str, **kwargs: Any) ->
- _models.SynapseRoleDefinition'
- parameters:
- - name: role_definition_id
- description: Synapse Built-In Role Definition Id.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: SynapseRoleDefinition, or the result of cls(response)
- types:
- - <xref:azure.synapse.accesscontrol.models.SynapseRoleDefinition>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.accesscontrol.operations.RoleDefinitionsOperations.list_role_definitions
- name: list_role_definitions
- summary: List role definitions.
- signature: 'list_role_definitions(is_built_in: bool | None = None, scope: str |
- None = None, **kwargs: Any) -> List[''_models.SynapseRoleDefinition'']'
- parameters:
- - name: is_built_in
- description: Is a Synapse Built-In Role or not.
- defaultValue: None
- types:
- - <xref:bool>
- - name: scope
- description: Scope of the Synapse Built-in Role.
- defaultValue: None
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: list of SynapseRoleDefinition, or the result of cls(response)
- types:
- - <xref:list>[<xref:azure.synapse.accesscontrol.models.SynapseRoleDefinition>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.accesscontrol.operations.RoleDefinitionsOperations.list_scopes
- name: list_scopes
- summary: List rbac scopes.
- signature: 'list_scopes(**kwargs: Any) -> List[str]'
- parameters:
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: list of str, or the result of cls(response)
- types:
- - <xref:list>[<xref:str>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-attributes:
-- uid: azure.synapse.accesscontrol.operations.RoleDefinitionsOperations.models
- name: models
- signature: models = <module 'azure.synapse.accesscontrol.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.5\\x64\\Lib\\site-packages\\azure\\synapse\\accesscontrol\\models\\__init__.py'>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.operations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.operations.yml
index 48a2056337fc..12155ffad692 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.operations.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.operations.yml
@@ -4,5 +4,4 @@ name: operations
fullName: azure.synapse.accesscontrol.operations
type: import
classes:
-- azure.synapse.accesscontrol.operations.RoleAssignmentsOperations
-- azure.synapse.accesscontrol.operations.RoleDefinitionsOperations
+- azure.synapse.accesscontrol.operations.AccessControlOperations
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.ArtifactsClient.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.ArtifactsClient.yml
index 3eaf68b74efc..37b7cdbf39b5 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.ArtifactsClient.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.ArtifactsClient.yml
@@ -7,92 +7,33 @@ inheritances:
- builtins.object
summary: ArtifactsClient.
constructor:
- syntax: 'ArtifactsClient(credential: TokenCredential, endpoint: str, **kwargs: Any)'
+ syntax: 'ArtifactsClient(credential: ''TokenCredential'', endpoint: str, **kwargs:
+ Any)'
parameters:
- name: credential
- description: Credential needed for the client to connect to Azure. Required.
+ description: Credential needed for the client to connect to Azure.
isRequired: true
types:
- <xref:azure.core.credentials.TokenCredential>
- name: endpoint
- description: 'The workspace development endpoint, for example
-
- [https://myworkspace.dev.azuresynapse.net](https://myworkspace.dev.azuresynapse.net).
- Required.'
+ description: The workspace development endpoint, for example [https://myworkspace.dev.azuresynapse.net](https://myworkspace.dev.azuresynapse.net).
isRequired: true
types:
- <xref:str>
- name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
+ description: Default waiting time between two polls for LRO operations if no Retry-After
+ header is present.
types:
- <xref:int>
variables:
-- description: LinkConnectionOperations operations
- name: link_connection
- types:
- - <xref:azure.synapse.artifacts.operations.LinkConnectionOperations>
-- description: RunNotebookOperations operations
- name: run_notebook
- types:
- - <xref:azure.synapse.artifacts.operations.RunNotebookOperations>
-- description: KqlScriptsOperations operations
- name: kql_scripts
- types:
- - <xref:azure.synapse.artifacts.operations.KqlScriptsOperations>
-- description: KqlScriptOperations operations
- name: kql_script
- types:
- - <xref:azure.synapse.artifacts.operations.KqlScriptOperations>
-- description: MetastoreOperations operations
- name: metastore
- types:
- - <xref:azure.synapse.artifacts.operations.MetastoreOperations>
-- description: SparkConfigurationOperations operations
- name: spark_configuration
- types:
- - <xref:azure.synapse.artifacts.operations.SparkConfigurationOperations>
-- description: BigDataPoolsOperations operations
- name: big_data_pools
- types:
- - <xref:azure.synapse.artifacts.operations.BigDataPoolsOperations>
-- description: DataFlowOperations operations
- name: data_flow
- types:
- - <xref:azure.synapse.artifacts.operations.DataFlowOperations>
-- description: DataFlowDebugSessionOperations operations
- name: data_flow_debug_session
- types:
- - <xref:azure.synapse.artifacts.operations.DataFlowDebugSessionOperations>
-- description: DatasetOperations operations
- name: dataset
- types:
- - <xref:azure.synapse.artifacts.operations.DatasetOperations>
-- description: WorkspaceGitRepoManagementOperations operations
- name: workspace_git_repo_management
- types:
- - <xref:azure.synapse.artifacts.operations.WorkspaceGitRepoManagementOperations>
-- description: IntegrationRuntimesOperations operations
- name: integration_runtimes
- types:
- - <xref:azure.synapse.artifacts.operations.IntegrationRuntimesOperations>
-- description: LibraryOperations operations
- name: library
- types:
- - <xref:azure.synapse.artifacts.operations.LibraryOperations>
- description: LinkedServiceOperations operations
name: linked_service
types:
- <xref:azure.synapse.artifacts.operations.LinkedServiceOperations>
-- description: NotebookOperations operations
- name: notebook
- types:
- - <xref:azure.synapse.artifacts.operations.NotebookOperations>
-- description: NotebookOperationResultOperations operations
- name: notebook_operation_result
+- description: DatasetOperations operations
+ name: dataset
types:
- - <xref:azure.synapse.artifacts.operations.NotebookOperationResultOperations>
+ - <xref:azure.synapse.artifacts.operations.DatasetOperations>
- description: PipelineOperations operations
name: pipeline
types:
@@ -101,18 +42,6 @@ variables:
name: pipeline_run
types:
- <xref:azure.synapse.artifacts.operations.PipelineRunOperations>
-- description: SparkJobDefinitionOperations operations
- name: spark_job_definition
- types:
- - <xref:azure.synapse.artifacts.operations.SparkJobDefinitionOperations>
-- description: SqlPoolsOperations operations
- name: sql_pools
- types:
- - <xref:azure.synapse.artifacts.operations.SqlPoolsOperations>
-- description: SqlScriptOperations operations
- name: sql_script
- types:
- - <xref:azure.synapse.artifacts.operations.SqlScriptOperations>
- description: TriggerOperations operations
name: trigger
types:
@@ -121,10 +50,26 @@ variables:
name: trigger_run
types:
- <xref:azure.synapse.artifacts.operations.TriggerRunOperations>
-- description: WorkspaceOperations operations
- name: workspace
+- description: DataFlowOperations operations
+ name: data_flow
+ types:
+ - <xref:azure.synapse.artifacts.operations.DataFlowOperations>
+- description: DataFlowDebugSessionOperations operations
+ name: data_flow_debug_session
+ types:
+ - <xref:azure.synapse.artifacts.operations.DataFlowDebugSessionOperations>
+- description: SqlScriptOperations operations
+ name: sql_script
+ types:
+ - <xref:azure.synapse.artifacts.operations.SqlScriptOperations>
+- description: SparkJobDefinitionOperations operations
+ name: spark_job_definition
types:
- - <xref:azure.synapse.artifacts.operations.WorkspaceOperations>
+ - <xref:azure.synapse.artifacts.operations.SparkJobDefinitionOperations>
+- description: NotebookOperations operations
+ name: notebook
+ types:
+ - <xref:azure.synapse.artifacts.operations.NotebookOperations>
methods:
- uid: azure.synapse.artifacts.ArtifactsClient.close
name: close
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.ArtifactsClient.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.ArtifactsClient.yml
index 12787b56855d..2dd38ca99485 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.ArtifactsClient.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.ArtifactsClient.yml
@@ -11,121 +11,65 @@ constructor:
Any)'
parameters:
- name: credential
- description: Credential needed for the client to connect to Azure. Required.
+ description: Credential needed for the client to connect to Azure.
isRequired: true
types:
- <xref:azure.core.credentials_async.AsyncTokenCredential>
- name: endpoint
- description: 'The workspace development endpoint, for example
-
- [https://myworkspace.dev.azuresynapse.net](https://myworkspace.dev.azuresynapse.net).
- Required.'
+ description: The workspace development endpoint, for example [https://myworkspace.dev.azuresynapse.net](https://myworkspace.dev.azuresynapse.net).
isRequired: true
types:
- <xref:str>
- name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
+ description: Default waiting time between two polls for LRO operations if no Retry-After
+ header is present.
types:
- <xref:int>
variables:
-- description: LinkConnectionOperations operations
- name: link_connection
- types:
- - <xref:azure.synapse.artifacts.aio.operations.LinkConnectionOperations>
-- description: RunNotebookOperations operations
- name: run_notebook
- types:
- - <xref:azure.synapse.artifacts.aio.operations.RunNotebookOperations>
-- description: KqlScriptsOperations operations
- name: kql_scripts
- types:
- - <xref:azure.synapse.artifacts.aio.operations.KqlScriptsOperations>
-- description: KqlScriptOperations operations
- name: kql_script
- types:
- - <xref:azure.synapse.artifacts.aio.operations.KqlScriptOperations>
-- description: MetastoreOperations operations
- name: metastore
- types:
- - <xref:azure.synapse.artifacts.aio.operations.MetastoreOperations>
-- description: SparkConfigurationOperations operations
- name: spark_configuration
- types:
- - <xref:azure.synapse.artifacts.aio.operations.SparkConfigurationOperations>
-- description: BigDataPoolsOperations operations
- name: big_data_pools
- types:
- - <xref:azure.synapse.artifacts.aio.operations.BigDataPoolsOperations>
-- description: DataFlowOperations operations
- name: data_flow
- types:
- - <xref:azure.synapse.artifacts.aio.operations.DataFlowOperations>
-- description: DataFlowDebugSessionOperations operations
- name: data_flow_debug_session
- types:
- - <xref:azure.synapse.artifacts.aio.operations.DataFlowDebugSessionOperations>
-- description: DatasetOperations operations
- name: dataset
- types:
- - <xref:azure.synapse.artifacts.aio.operations.DatasetOperations>
-- description: WorkspaceGitRepoManagementOperations operations
- name: workspace_git_repo_management
- types:
- - <xref:azure.synapse.artifacts.aio.operations.WorkspaceGitRepoManagementOperations>
-- description: IntegrationRuntimesOperations operations
- name: integration_runtimes
- types:
- - <xref:azure.synapse.artifacts.aio.operations.IntegrationRuntimesOperations>
-- description: LibraryOperations operations
- name: library
- types:
- - <xref:azure.synapse.artifacts.aio.operations.LibraryOperations>
- description: LinkedServiceOperations operations
name: linked_service
types:
- - <xref:azure.synapse.artifacts.aio.operations.LinkedServiceOperations>
-- description: NotebookOperations operations
- name: notebook
- types:
- - <xref:azure.synapse.artifacts.aio.operations.NotebookOperations>
-- description: NotebookOperationResultOperations operations
- name: notebook_operation_result
+ - <xref:azure.synapse.artifacts.aio.operations_async.LinkedServiceOperations>
+- description: DatasetOperations operations
+ name: dataset
types:
- - <xref:azure.synapse.artifacts.aio.operations.NotebookOperationResultOperations>
+ - <xref:azure.synapse.artifacts.aio.operations_async.DatasetOperations>
- description: PipelineOperations operations
name: pipeline
types:
- - <xref:azure.synapse.artifacts.aio.operations.PipelineOperations>
+ - <xref:azure.synapse.artifacts.aio.operations_async.PipelineOperations>
- description: PipelineRunOperations operations
name: pipeline_run
types:
- - <xref:azure.synapse.artifacts.aio.operations.PipelineRunOperations>
-- description: SparkJobDefinitionOperations operations
- name: spark_job_definition
- types:
- - <xref:azure.synapse.artifacts.aio.operations.SparkJobDefinitionOperations>
-- description: SqlPoolsOperations operations
- name: sql_pools
- types:
- - <xref:azure.synapse.artifacts.aio.operations.SqlPoolsOperations>
-- description: SqlScriptOperations operations
- name: sql_script
- types:
- - <xref:azure.synapse.artifacts.aio.operations.SqlScriptOperations>
+ - <xref:azure.synapse.artifacts.aio.operations_async.PipelineRunOperations>
- description: TriggerOperations operations
name: trigger
types:
- - <xref:azure.synapse.artifacts.aio.operations.TriggerOperations>
+ - <xref:azure.synapse.artifacts.aio.operations_async.TriggerOperations>
- description: TriggerRunOperations operations
name: trigger_run
types:
- - <xref:azure.synapse.artifacts.aio.operations.TriggerRunOperations>
-- description: WorkspaceOperations operations
- name: workspace
+ - <xref:azure.synapse.artifacts.aio.operations_async.TriggerRunOperations>
+- description: DataFlowOperations operations
+ name: data_flow
+ types:
+ - <xref:azure.synapse.artifacts.aio.operations_async.DataFlowOperations>
+- description: DataFlowDebugSessionOperations operations
+ name: data_flow_debug_session
+ types:
+ - <xref:azure.synapse.artifacts.aio.operations_async.DataFlowDebugSessionOperations>
+- description: SqlScriptOperations operations
+ name: sql_script
+ types:
+ - <xref:azure.synapse.artifacts.aio.operations_async.SqlScriptOperations>
+- description: SparkJobDefinitionOperations operations
+ name: spark_job_definition
+ types:
+ - <xref:azure.synapse.artifacts.aio.operations_async.SparkJobDefinitionOperations>
+- description: NotebookOperations operations
+ name: notebook
types:
- - <xref:azure.synapse.artifacts.aio.operations.WorkspaceOperations>
+ - <xref:azure.synapse.artifacts.aio.operations_async.NotebookOperations>
methods:
- uid: azure.synapse.artifacts.aio.ArtifactsClient.close
name: close
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActionOnExistingTargetTable.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActionOnExistingTargetTable.yml
deleted file mode 100644
index 8a07594f1f53..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActionOnExistingTargetTable.yml
+++ /dev/null
@@ -1,20 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.ActionOnExistingTargetTable
-name: ActionOnExistingTargetTable
-fullName: azure.synapse.artifacts.models.ActionOnExistingTargetTable
-summary: Action on existing target table. If not specified, 'FailOnNonEmptyTable'
- action is used.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: ActionOnExistingTargetTable(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: DROP_AND_RECREATE_TABLE
- uid: azure.synapse.artifacts.models.ActionOnExistingTargetTable.DROP_AND_RECREATE_TABLE
-- name: FAIL_ON_NON_EMPTY_TABLE
- uid: azure.synapse.artifacts.models.ActionOnExistingTargetTable.FAIL_ON_NON_EMPTY_TABLE
-- name: MERGE_WITH_EXISTING_DATA
- uid: azure.synapse.artifacts.models.ActionOnExistingTargetTable.MERGE_WITH_EXISTING_DATA
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Activity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Activity.yml
index 85b9244fe641..43d232a596db 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Activity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Activity.yml
@@ -4,106 +4,52 @@ name: Activity
fullName: azure.synapse.artifacts.models.Activity
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'A pipeline activity.
- You probably want to use the sub-classes and not this class directly. Known sub-classes
- are:
+ You probably want to use the sub-classes and not this class directly. Known
- ControlActivity, ExecutionActivity, SqlPoolStoredProcedureActivity
+ 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, MutableMapping[str,
- Any]] | None = None, description: str | None = None, state: str | _models.ActivityState
- | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None
- = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityDependency.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityDependency.yml
index feab375f5d0e..35094900c4c6 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityDependency.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityDependency.yml
@@ -4,44 +4,31 @@ name: ActivityDependency
fullName: azure.synapse.artifacts.models.ActivityDependency
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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 |
- _models.DependencyCondition], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: activity
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- name: dependency_conditions
- description: Match-Condition for the dependency. Required.
+ description: Required. Match-Condition for the dependency.
+ isRequired: true
types:
- <xref:list>[<xref:str>
- <xref:azure.synapse.artifacts.models.DependencyCondition>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: activity
- types:
- - <xref:str>
-- description: Match-Condition for the dependency. Required.
- name: dependency_conditions
- types:
- - <xref:list>[<xref:str>
- - <xref:azure.synapse.artifacts.models.DependencyCondition>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityOnInactiveMarkAs.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityOnInactiveMarkAs.yml
deleted file mode 100644
index f633f6b187a3..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityOnInactiveMarkAs.yml
+++ /dev/null
@@ -1,23 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.ActivityOnInactiveMarkAs
-name: ActivityOnInactiveMarkAs
-fullName: azure.synapse.artifacts.models.ActivityOnInactiveMarkAs
-summary: 'Status result of the activity when the state is set to Inactive. This is
- an optional property
-
- and if not provided when the activity is inactive, the status will be Succeeded
- by default.'
-module: azure.synapse.artifacts.models
-constructor:
- syntax: ActivityOnInactiveMarkAs(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: FAILED
- uid: azure.synapse.artifacts.models.ActivityOnInactiveMarkAs.FAILED
-- name: SKIPPED
- uid: azure.synapse.artifacts.models.ActivityOnInactiveMarkAs.SKIPPED
-- name: SUCCEEDED
- uid: azure.synapse.artifacts.models.ActivityOnInactiveMarkAs.SUCCEEDED
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityPolicy.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityPolicy.yml
index 5cc443175170..8aac89161f3a 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityPolicy.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityPolicy.yml
@@ -4,20 +4,21 @@ name: ActivityPolicy
fullName: azure.synapse.artifacts.models.ActivityPolicy
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: Execution policy for an activity.
constructor:
- syntax: 'ActivityPolicy(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, timeout: MutableMapping[str, Any] | None = None, retry: MutableMapping[str,
- Any] | None = None, retry_interval_in_seconds: int | None = None, secure_input:
- bool | None = None, secure_output: bool | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: timeout
description: 'Specifies the timeout for the activity to run. The default timeout
is 7 days.
@@ -25,26 +26,30 @@ constructor:
Type: string (or Expression with resultType string), pattern:
((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: retry
description: 'Maximum ordinary retry attempts. Default is 0. Type: integer (or
- Expression
+ Expression with
- with resultType integer), minimum: 0.'
+ resultType integer), minimum: 0.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: retry_interval_in_seconds
- description: 'Interval between each retry attempt (in seconds). The
+ description: 'Interval between each retry attempt (in seconds). The default
- default is 30 sec.'
+ is 30 sec.'
+ isRequired: true
types:
- <xref:int>
- name: secure_input
description: 'When set to true, Input from activity is considered as secure and
- will
+ will not
- not be logged to monitoring.'
+ be logged to monitoring.'
+ isRequired: true
types:
- <xref:bool>
- name: secure_output
@@ -52,48 +57,6 @@ constructor:
will
not be logged to monitoring.'
+ isRequired: true
types:
- <xref:bool>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- 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])).'
- name: timeout
- types:
- - <xref:JSON>
-- description: 'Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression
- with
-
- resultType integer), minimum: 0.'
- name: retry
- types:
- - <xref:JSON>
-- description: 'Interval between each retry attempt (in seconds). The default
-
- is 30 sec.'
- name: retry_interval_in_seconds
- types:
- - <xref:int>
-- description: 'When set to true, Input from activity is considered as secure and
- will not
-
- be logged to monitoring.'
- name: secure_input
- types:
- - <xref:bool>
-- description: 'When set to true, Output from activity is considered as secure and
- will
-
- not be logged to monitoring.'
- name: secure_output
- types:
- - <xref:bool>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRun.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRun.yml
index 3c695e1e378b..b9fc9291fc2a 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRun.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRun.yml
@@ -4,28 +4,23 @@ name: ActivityRun
fullName: azure.synapse.artifacts.models.ActivityRun
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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, MutableMapping[str, Any]]
- | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- description: The name of the pipeline.
name: pipeline_name
types:
@@ -69,12 +64,12 @@ variables:
- description: The input for the activity.
name: input
types:
- - <xref:JSON>
+ - <xref:object>
- description: The output for the activity.
name: output
types:
- - <xref:JSON>
+ - <xref:object>
- description: The error if any from the activity run.
name: error
types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRunsQueryResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRunsQueryResponse.yml
index c907c267e5e7..a162a101ab2f 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRunsQueryResponse.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRunsQueryResponse.yml
@@ -4,33 +4,25 @@ name: ActivityRunsQueryResponse
fullName: azure.synapse.artifacts.models.ActivityRunsQueryResponse
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'A list activity runs.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'ActivityRunsQueryResponse(*, value: List[_models.ActivityRun], continuation_token:
- str | None = None, **kwargs: Any)'
+ syntax: 'ActivityRunsQueryResponse(*, value: List[ActivityRun], continuation_token:
+ str | None = None, **kwargs)'
parameters:
- name: value
- description: List of activity runs. Required.
+ description: Required. List of activity runs.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityRun>]
- name: continuation_token
description: 'The continuation token for getting the next page of results, if
+ any
- any remaining results exist, null otherwise.'
+ remaining results exist, null otherwise.'
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: List of activity runs. Required.
- name: value
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityRun>]
-- description: 'The continuation token for getting the next page of results, if any
-
- remaining results exist, null otherwise.'
- name: continuation_token
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityState.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityState.yml
deleted file mode 100644
index e1a5ec10ada0..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityState.yml
+++ /dev/null
@@ -1,20 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.ActivityState
-name: ActivityState
-fullName: azure.synapse.artifacts.models.ActivityState
-summary: 'Activity state. This is an optional property and if not provided, the state
- will be Active by
-
- default.'
-module: azure.synapse.artifacts.models
-constructor:
- syntax: ActivityState(value, names=None, *, module=None, qualname=None, type=None,
- start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: ACTIVE
- uid: azure.synapse.artifacts.models.ActivityState.ACTIVE
-- name: INACTIVE
- uid: azure.synapse.artifacts.models.ActivityState.INACTIVE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse.yml
index 1d2aeffbb4ed..a69c9725ffee 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse.yml
@@ -4,18 +4,13 @@ name: AddDataFlowToDebugSessionResponse
fullName: azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: Response body structure for starting data flow debug session.
constructor:
- syntax: 'AddDataFlowToDebugSessionResponse(*, job_version: str | None = None, **kwargs:
- Any)'
+ syntax: 'AddDataFlowToDebugSessionResponse(*, job_version: str | None = None, **kwargs)'
parameters:
- name: job_version
description: The ID of data flow debug job version.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: The ID of data flow debug job version.
- name: job_version
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AdditionalColumns.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AdditionalColumns.yml
deleted file mode 100644
index 2b6b14fdb45d..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AdditionalColumns.yml
+++ /dev/null
@@ -1,33 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AdditionalColumns
-name: AdditionalColumns
-fullName: azure.synapse.artifacts.models.AdditionalColumns
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Specify the column name and value of additional columns.
-constructor:
- syntax: 'AdditionalColumns(*, name: MutableMapping[str, Any] | None = None, value:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: name
- description: 'Additional column name. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
- - name: value
- description: 'Additional column value. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Additional column name. Type: string (or Expression with resultType
- string).'
- name: name
- types:
- - <xref:JSON>
-- description: 'Additional column value. Type: string (or Expression with resultType
- string).'
- name: value
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSLinkedService.yml
index 1a9a42b5b8bd..6326251fb67a 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSLinkedService.yml
@@ -10,76 +10,92 @@ summary: 'Amazon Marketplace Web Service linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AmazonMWSLinkedService(*, endpoint: MutableMapping[str, Any], marketplace_id:
- MutableMapping[str, Any], seller_id: MutableMapping[str, Any], access_key_id:
- MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, mws_auth_token:
- _models.SecretBase | None = None, secret_key: _models.SecretBase | None = None,
- use_encrypted_endpoints: MutableMapping[str, Any] | None = None, use_host_verification:
- MutableMapping[str, Any] | None = None, use_peer_verification: MutableMapping[str,
- Any] | None = None, encrypted_credential: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: endpoint
- description: 'The endpoint of the Amazon MWS server, (i.e. mws.amazonservices.com).
+ description: 'Required. The endpoint of the Amazon MWS server, (i.e.
- Required.'
+ mws.amazonservices.com).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: marketplace_id
- description: 'The Amazon Marketplace ID you want to retrieve data from. To retrieve
+ description: 'Required. The Amazon Marketplace ID you want to retrieve data from.
+ To
- data from multiple Marketplace IDs, separate them with a comma (,). (i.e. A2EUQ1WTGCTBG2).
+ retrieve data from multiple Marketplace IDs, separate them with a comma (,).
+ (i.e.
- Required.'
+ A2EUQ1WTGCTBG2).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: seller_id
- description: The Amazon seller ID. Required.
+ description: Required. The Amazon seller ID.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: mws_auth_token
description: The Amazon MWS authentication token.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: access_key_id
- description: The access key id used to access data. Required.
+ description: Required. The access key id used to access data.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: secret_key
description: The secret key used to access data.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: use_encrypted_endpoints
- description: 'Specifies whether the data source endpoints are encrypted
+ description: 'Specifies whether the data source endpoints are encrypted using
- using HTTPS. The default value is true.'
+ HTTPS. The default value is true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_host_verification
description: 'Specifies whether to require the host name in the server''s
@@ -87,106 +103,23 @@ constructor:
default value is
true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The endpoint of the Amazon MWS server, (i.e. mws.amazonservices.com).
- Required.
- name: endpoint
- types:
- - <xref:JSON>
-- description: '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).
-
- Required.'
- name: marketplace_id
- types:
- - <xref:JSON>
-- description: The Amazon seller ID. Required.
- name: seller_id
- types:
- - <xref:JSON>
-- description: The Amazon MWS authentication token.
- name: mws_auth_token
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: The access key id used to access data. Required.
- name: access_key_id
- types:
- - <xref:JSON>
-- description: The secret key used to access data.
- name: secret_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Specifies whether the data source endpoints are encrypted using
-
- HTTPS. The default value is true.'
- name: use_encrypted_endpoints
- types:
- - <xref:JSON>
-- 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.'
- name: use_host_verification
- types:
- - <xref:JSON>
-- description: 'Specifies whether to verify the identity of the server when
-
- connecting over SSL. The default value is true.'
- name: use_peer_verification
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSObjectDataset.yml
index 025dbf483bc0..5081faf510ae 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSObjectDataset.yml
@@ -10,109 +10,71 @@ summary: 'Amazon Marketplace Web Service dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AmazonMWSObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The table name. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSSource.yml
deleted file mode 100644
index eeb7ef305861..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AmazonMWSSource
-name: AmazonMWSSource
-fullName: azure.synapse.artifacts.models.AmazonMWSSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Amazon Marketplace Web Service source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AmazonMWSSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, query:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForOracleLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForOracleLinkedService.yml
deleted file mode 100644
index 058b3da6f187..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForOracleLinkedService.yml
+++ /dev/null
@@ -1,107 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AmazonRdsForOracleLinkedService
-name: AmazonRdsForOracleLinkedService
-fullName: azure.synapse.artifacts.models.AmazonRdsForOracleLinkedService
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.LinkedService
-summary: 'AmazonRdsForOracle database.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AmazonRdsForOracleLinkedService(*, connection_string: MutableMapping[str,
- Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- connect_via: _models.IntegrationRuntimeReference | None = None, description: str
- | None = None, parameters: Dict[str, _models.ParameterSpecification] | None =
- None, annotations: List[MutableMapping[str, Any]] | None = None, password: _models.SecretBase
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: connect_via
- description: The integration runtime reference.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- - name: description
- description: Linked service description.
- types:
- - <xref:str>
- - name: parameters
- description: Parameters for linked service.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the linked service.
- types:
- - <xref:list>[<xref:JSON>]
- - name: connection_string
- description: 'The connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference. Required.'
- types:
- - <xref:JSON>
- - name: password
- description: The Azure key vault secret reference of password in connection string.
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
- - 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).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference. Required.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of password in connection string.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForOraclePartitionOption.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForOraclePartitionOption.yml
deleted file mode 100644
index 7d91fe21ff58..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForOraclePartitionOption.yml
+++ /dev/null
@@ -1,19 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.AmazonRdsForOraclePartitionOption
-name: AmazonRdsForOraclePartitionOption
-fullName: azure.synapse.artifacts.models.AmazonRdsForOraclePartitionOption
-summary: AmazonRdsForOraclePartitionOption.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: AmazonRdsForOraclePartitionOption(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: DYNAMIC_RANGE
- uid: azure.synapse.artifacts.models.AmazonRdsForOraclePartitionOption.DYNAMIC_RANGE
-- name: NONE
- uid: azure.synapse.artifacts.models.AmazonRdsForOraclePartitionOption.NONE
-- name: PHYSICAL_PARTITIONS_OF_TABLE
- uid: azure.synapse.artifacts.models.AmazonRdsForOraclePartitionOption.PHYSICAL_PARTITIONS_OF_TABLE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForOraclePartitionSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForOraclePartitionSettings.yml
deleted file mode 100644
index 8a29eb701cf7..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForOraclePartitionSettings.yml
+++ /dev/null
@@ -1,71 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AmazonRdsForOraclePartitionSettings
-name: AmazonRdsForOraclePartitionSettings
-fullName: azure.synapse.artifacts.models.AmazonRdsForOraclePartitionSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: The settings that will be leveraged for AmazonRdsForOracle source partitioning.
-constructor:
- syntax: 'AmazonRdsForOraclePartitionSettings(*, partition_names: MutableMapping[str,
- Any] | None = None, partition_column_name: MutableMapping[str, Any] | None = None,
- partition_upper_bound: MutableMapping[str, Any] | None = None, partition_lower_bound:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: partition_names
- description: Names of the physical partitions of AmazonRdsForOracle table.
- types:
- - <xref:JSON>
- - name: partition_column_name
- description: 'The name of the column in integer type that will be used for
-
- proceeding range partitioning. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: partition_upper_bound
- description: 'The maximum value of column specified in partitionColumnName
-
- that will be used for proceeding range partitioning. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: partition_lower_bound
- description: 'The minimum value of column specified in partitionColumnName
-
- that will be used for proceeding range partitioning. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: Names of the physical partitions of AmazonRdsForOracle table.
- name: partition_names
- types:
- - <xref:JSON>
-- description: 'The name of the column in integer type that will be used for
-
- proceeding range partitioning. Type: string (or Expression with resultType string).'
- name: partition_column_name
- types:
- - <xref:JSON>
-- description: 'The maximum value of column specified in partitionColumnName that
-
- will be used for proceeding range partitioning. Type: string (or Expression with
- resultType
-
- string).'
- name: partition_upper_bound
- types:
- - <xref:JSON>
-- description: 'The minimum value of column specified in partitionColumnName that
-
- will be used for proceeding range partitioning. Type: string (or Expression with
- resultType
-
- string).'
- name: partition_lower_bound
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForOracleSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForOracleSource.yml
deleted file mode 100644
index e7288d4c27c0..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForOracleSource.yml
+++ /dev/null
@@ -1,135 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AmazonRdsForOracleSource
-name: AmazonRdsForOracleSource
-fullName: azure.synapse.artifacts.models.AmazonRdsForOracleSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity AmazonRdsForOracle source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AmazonRdsForOracleSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, oracle_reader_query: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, partition_option:
- MutableMapping[str, Any] | None = None, partition_settings: _models.AmazonRdsForOraclePartitionSettings
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: oracle_reader_query
- description: 'AmazonRdsForOracle reader query. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: partition_option
- description: 'The partition mechanism that will be used for AmazonRdsForOracle
-
- read in parallel. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: partition_settings
- description: 'The settings that will be leveraged for AmazonRdsForOracle source
-
- partitioning.'
- types:
- - <xref:azure.synapse.artifacts.models.AmazonRdsForOraclePartitionSettings>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'AmazonRdsForOracle reader query. Type: string (or Expression with
-
- resultType string).'
- name: oracle_reader_query
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'The partition mechanism that will be used for AmazonRdsForOracle read
-
- in parallel. Type: string (or Expression with resultType string).'
- name: partition_option
- types:
- - <xref:JSON>
-- description: 'The settings that will be leveraged for AmazonRdsForOracle source
-
- partitioning.'
- name: partition_settings
- types:
- - <xref:azure.synapse.artifacts.models.AmazonRdsForOraclePartitionSettings>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForOracleTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForOracleTableDataset.yml
deleted file mode 100644
index ac0e34979424..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForOracleTableDataset.yml
+++ /dev/null
@@ -1,136 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AmazonRdsForOracleTableDataset
-name: AmazonRdsForOracleTableDataset
-fullName: azure.synapse.artifacts.models.AmazonRdsForOracleTableDataset
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.Dataset
-summary: 'The AmazonRdsForOracle database dataset.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AmazonRdsForOracleTableDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, schema_type_properties_schema: MutableMapping[str,
- Any] | None = None, table: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Dataset description.
- types:
- - <xref:str>
- - name: structure
- description: 'Columns that define the structure of the dataset. Type: array (or
-
- Expression with resultType array), itemType: DatasetDataElement.'
- types:
- - <xref:JSON>
- - name: schema
- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- types:
- - <xref:JSON>
- - name: linked_service_name
- description: Linked service reference. Required.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: parameters
- description: Parameters for dataset.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the Dataset.
- types:
- - <xref:list>[<xref:JSON>]
- - name: folder
- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
-
- the root level.'
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
- - name: schema_type_properties_schema
- description: 'The schema name of the AmazonRdsForOracle database.
-
- Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: table
- description: 'The table name of the AmazonRdsForOracle database. Type: string
- (or Expression
-
- with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The schema name of the AmazonRdsForOracle database. Type:
-
- string (or Expression with resultType string).'
- name: schema_type_properties_schema
- types:
- - <xref:JSON>
-- description: 'The table name of the AmazonRdsForOracle database. Type: string (or
- Expression
-
- with resultType string).'
- name: table
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForSqlServerLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForSqlServerLinkedService.yml
deleted file mode 100644
index 96db33601d7b..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForSqlServerLinkedService.yml
+++ /dev/null
@@ -1,129 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AmazonRdsForSqlServerLinkedService
-name: AmazonRdsForSqlServerLinkedService
-fullName: azure.synapse.artifacts.models.AmazonRdsForSqlServerLinkedService
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.LinkedService
-summary: 'Amazon RDS for SQL Server linked service.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AmazonRdsForSqlServerLinkedService(*, connection_string: MutableMapping[str,
- Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- connect_via: _models.IntegrationRuntimeReference | None = None, description: str
- | None = None, parameters: Dict[str, _models.ParameterSpecification] | None =
- None, annotations: List[MutableMapping[str, Any]] | None = None, user_name: MutableMapping[str,
- Any] | None = None, password: _models.SecretBase | None = None, encrypted_credential:
- MutableMapping[str, Any] | None = None, always_encrypted_settings: _models.SqlAlwaysEncryptedProperties
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: connect_via
- description: The integration runtime reference.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- - name: description
- description: Linked service description.
- types:
- - <xref:str>
- - name: parameters
- description: Parameters for linked service.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the linked service.
- types:
- - <xref:list>[<xref:JSON>]
- - name: connection_string
- description: 'The connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference. Required.'
- types:
- - <xref:JSON>
- - name: user_name
- description: 'The on-premises Windows authentication user name. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: password
- description: The on-premises Windows authentication password.
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
- - 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).'
- types:
- - <xref:JSON>
- - name: always_encrypted_settings
- description: Sql always encrypted properties.
- types:
- - <xref:azure.synapse.artifacts.models.SqlAlwaysEncryptedProperties>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference. Required.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: 'The on-premises Windows authentication user name. Type: string (or
- Expression
-
- with resultType string).'
- name: user_name
- types:
- - <xref:JSON>
-- description: The on-premises Windows authentication password.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
-- description: Sql always encrypted properties.
- name: always_encrypted_settings
- types:
- - <xref:azure.synapse.artifacts.models.SqlAlwaysEncryptedProperties>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForSqlServerSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForSqlServerSource.yml
deleted file mode 100644
index 47bde059901a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForSqlServerSource.yml
+++ /dev/null
@@ -1,188 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AmazonRdsForSqlServerSource
-name: AmazonRdsForSqlServerSource
-fullName: azure.synapse.artifacts.models.AmazonRdsForSqlServerSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Amazon RDS for SQL Server source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AmazonRdsForSqlServerSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, sql_reader_query:
- MutableMapping[str, Any] | None = None, sql_reader_stored_procedure_name: MutableMapping[str,
- Any] | None = None, stored_procedure_parameters: Dict[str, _models.StoredProcedureParameter]
- | None = None, isolation_level: MutableMapping[str, Any] | None = None, produce_additional_types:
- MutableMapping[str, Any] | None = None, partition_option: MutableMapping[str,
- Any] | None = None, partition_settings: _models.SqlPartitionSettings | None =
- None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: sql_reader_query
- description: 'SQL reader query. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: sql_reader_stored_procedure_name
- description: 'Name of the stored procedure for a SQL Database
-
- source. This cannot be used at the same time as SqlReaderQuery. Type: string
- (or Expression
-
- with resultType string).'
- types:
- - <xref:JSON>
- - name: stored_procedure_parameters
- description: 'Value and type setting for stored procedure parameters.
-
- Example: "{Parameter1: {value: "1", type: "int"}}".'
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.StoredProcedureParameter>]
- - name: isolation_level
- description: 'Specifies the transaction locking behavior for the SQL source.
-
- Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot.
- The default
-
- value is ReadCommitted. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: produce_additional_types
- description: Which additional types to produce.
- types:
- - <xref:JSON>
- - name: partition_option
- description: 'The partition mechanism that will be used for Sql read in parallel.
-
- Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".'
- types:
- - <xref:JSON>
- - name: partition_settings
- description: The settings that will be leveraged for Sql source partitioning.
- types:
- - <xref:azure.synapse.artifacts.models.SqlPartitionSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'SQL reader query. Type: string (or Expression with resultType string).'
- name: sql_reader_query
- types:
- - <xref:JSON>
-- description: 'Name of the stored procedure for a SQL Database source.
-
- This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression
- with
-
- resultType string).'
- name: sql_reader_stored_procedure_name
- types:
- - <xref:JSON>
-- description: 'Value and type setting for stored procedure parameters.
-
- Example: "{Parameter1: {value: "1", type: "int"}}".'
- name: stored_procedure_parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.StoredProcedureParameter>]
-- description: 'Specifies the transaction locking behavior for the SQL source. Allowed
-
- values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The
- default value
-
- is ReadCommitted. Type: string (or Expression with resultType string).'
- name: isolation_level
- types:
- - <xref:JSON>
-- description: Which additional types to produce.
- name: produce_additional_types
- types:
- - <xref:JSON>
-- description: 'The partition mechanism that will be used for Sql read in parallel.
-
- Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".'
- name: partition_option
- types:
- - <xref:JSON>
-- description: The settings that will be leveraged for Sql source partitioning.
- name: partition_settings
- types:
- - <xref:azure.synapse.artifacts.models.SqlPartitionSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForSqlServerTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForSqlServerTableDataset.yml
deleted file mode 100644
index b589acde4a2d..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRdsForSqlServerTableDataset.yml
+++ /dev/null
@@ -1,136 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AmazonRdsForSqlServerTableDataset
-name: AmazonRdsForSqlServerTableDataset
-fullName: azure.synapse.artifacts.models.AmazonRdsForSqlServerTableDataset
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.Dataset
-summary: 'The Amazon RDS for SQL Server dataset.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AmazonRdsForSqlServerTableDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, schema_type_properties_schema: MutableMapping[str,
- Any] | None = None, table: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Dataset description.
- types:
- - <xref:str>
- - name: structure
- description: 'Columns that define the structure of the dataset. Type: array (or
-
- Expression with resultType array), itemType: DatasetDataElement.'
- types:
- - <xref:JSON>
- - name: schema
- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- types:
- - <xref:JSON>
- - name: linked_service_name
- description: Linked service reference. Required.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: parameters
- description: Parameters for dataset.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the Dataset.
- types:
- - <xref:list>[<xref:JSON>]
- - name: folder
- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
-
- the root level.'
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
- - name: schema_type_properties_schema
- description: 'The schema name of the SQL Server dataset. Type: string
-
- (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: table
- description: 'The table name of the SQL Server dataset. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The schema name of the SQL Server dataset. Type: string
-
- (or Expression with resultType string).'
- name: schema_type_properties_schema
- types:
- - <xref:JSON>
-- description: 'The table name of the SQL Server dataset. Type: string (or Expression
- with
-
- resultType string).'
- name: table
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftLinkedService.yml
index ba165251487b..078efee55791 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftLinkedService.yml
@@ -10,145 +10,90 @@ summary: 'Linked service for Amazon Redshift.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AmazonRedshiftLinkedService(*, server: MutableMapping[str, Any], database:
- MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, username:
- MutableMapping[str, Any] | None = None, password: _models.SecretBase | None =
- None, port: MutableMapping[str, Any] | None = None, encrypted_credential: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: server
- description: 'The name of the Amazon Redshift server. Type: string (or Expression
- with
+ description: 'Required. The name of the Amazon Redshift server. Type: string (or
+ Expression
- resultType string). Required.'
+ with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: username
description: 'The username of the Amazon Redshift source. Type: string (or Expression
with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: The password of the Amazon Redshift source.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: database
- description: 'The database name of the Amazon Redshift source. Type: string (or
- Expression
+ description: 'Required. The database name of the Amazon Redshift source. Type:
+ string (or
- with resultType string). Required.'
+ Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The name of the Amazon Redshift server. Type: string (or Expression
- with
-
- resultType string). Required.'
- name: server
- types:
- - <xref:JSON>
-- description: 'The username of the Amazon Redshift source. Type: string (or Expression
- with
-
- resultType string).'
- name: username
- types:
- - <xref:JSON>
-- description: The password of the Amazon Redshift source.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The database name of the Amazon Redshift source. Type: string (or
- Expression
-
- with resultType string). Required.'
- name: database
- types:
- - <xref:JSON>
-- 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).'
- name: port
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftSource.yml
deleted file mode 100644
index 59df387a07d7..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftSource.yml
+++ /dev/null
@@ -1,126 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AmazonRedshiftSource
-name: AmazonRedshiftSource
-fullName: azure.synapse.artifacts.models.AmazonRedshiftSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity source for Amazon Redshift Source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AmazonRedshiftSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, query:
- MutableMapping[str, Any] | None = None, redshift_unload_settings: _models.RedshiftUnloadSettings
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'Database query. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: redshift_unload_settings
- description: 'The Amazon S3 settings needed for the interim Amazon S3 when
-
- copying from Amazon Redshift with unload. With this, data from Amazon Redshift
- source will be
-
- unloaded into S3 first and then copied into the targeted sink from the interim
- S3.'
- types:
- - <xref:azure.synapse.artifacts.models.RedshiftUnloadSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'Database query. Type: string (or Expression with resultType string).'
- name: query
- types:
- - <xref:JSON>
-- description: 'The Amazon S3 settings needed for the interim Amazon S3 when
-
- copying from Amazon Redshift with unload. With this, data from Amazon Redshift
- source will be
-
- unloaded into S3 first and then copied into the targeted sink from the interim
- S3.'
- name: redshift_unload_settings
- types:
- - <xref:azure.synapse.artifacts.models.RedshiftUnloadSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftTableDataset.yml
index 245f5a77046f..4a18ac65b9b8 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftTableDataset.yml
@@ -10,139 +10,89 @@ summary: 'The Amazon Redshift table dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AmazonRedshiftTableDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, table: MutableMapping[str, Any] | None = None, schema_type_properties_schema:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'This property will be retired. Please consider using schema + table
properties instead.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: table
description: 'The Amazon Redshift table name. Type: string (or Expression with
resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: schema_type_properties_schema
description: 'The Amazon Redshift schema name. Type: string (or
Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'This property will be retired. Please consider using schema + table
-
- properties instead.'
- name: table_name
- types:
- - <xref:JSON>
-- description: 'The Amazon Redshift table name. Type: string (or Expression with resultType
-
- string).'
- name: table
- types:
- - <xref:JSON>
-- description: 'The Amazon Redshift schema name. Type: string (or
-
- Expression with resultType string).'
- name: schema_type_properties_schema
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonS3Dataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonS3Dataset.yml
deleted file mode 100644
index a7d863f4f040..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonS3Dataset.yml
+++ /dev/null
@@ -1,207 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AmazonS3Dataset
-name: AmazonS3Dataset
-fullName: azure.synapse.artifacts.models.AmazonS3Dataset
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.Dataset
-summary: 'A single Amazon Simple Storage Service (S3) object or a set of S3 objects.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AmazonS3Dataset(*, linked_service_name: _models.LinkedServiceReference,
- bucket_name: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, structure: MutableMapping[str,
- Any] | None = None, schema: MutableMapping[str, Any] | None = None, parameters:
- Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str,
- Any]] | None = None, folder: _models.DatasetFolder | None = None, key: MutableMapping[str,
- Any] | None = None, prefix: MutableMapping[str, Any] | None = None, version: MutableMapping[str,
- Any] | None = None, modified_datetime_start: MutableMapping[str, Any] | None =
- None, modified_datetime_end: MutableMapping[str, Any] | None = None, format: _models.DatasetStorageFormat
- | None = None, compression: _models.DatasetCompression | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Dataset description.
- types:
- - <xref:str>
- - name: structure
- description: 'Columns that define the structure of the dataset. Type: array (or
-
- Expression with resultType array), itemType: DatasetDataElement.'
- types:
- - <xref:JSON>
- - name: schema
- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- types:
- - <xref:JSON>
- - name: linked_service_name
- description: Linked service reference. Required.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: parameters
- description: Parameters for dataset.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the Dataset.
- types:
- - <xref:list>[<xref:JSON>]
- - name: folder
- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
-
- the root level.'
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
- - name: bucket_name
- description: 'The name of the Amazon S3 bucket. Type: string (or Expression with
-
- resultType string). Required.'
- types:
- - <xref:JSON>
- - name: key
- description: 'The key of the Amazon S3 object. Type: string (or Expression with
- resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: prefix
- description: 'The prefix filter for the S3 object name. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: version
- description: 'The version for the S3 object. Type: string (or Expression with
- resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: modified_datetime_start
- description: 'The start of S3 object''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: modified_datetime_end
- description: 'The end of S3 object''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: format
- description: The format of files.
- types:
- - <xref:azure.synapse.artifacts.models.DatasetStorageFormat>
- - name: compression
- description: The data compression method used for the Amazon S3 object.
- types:
- - <xref:azure.synapse.artifacts.models.DatasetCompression>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The name of the Amazon S3 bucket. Type: string (or Expression with
-
- resultType string). Required.'
- name: bucket_name
- types:
- - <xref:JSON>
-- description: 'The key of the Amazon S3 object. Type: string (or Expression with
- resultType
-
- string).'
- name: key
- types:
- - <xref:JSON>
-- description: 'The prefix filter for the S3 object name. Type: string (or Expression
- with
-
- resultType string).'
- name: prefix
- types:
- - <xref:JSON>
-- description: 'The version for the S3 object. Type: string (or Expression with resultType
-
- string).'
- name: version
- types:
- - <xref:JSON>
-- description: 'The start of S3 object''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- name: modified_datetime_start
- types:
- - <xref:JSON>
-- description: 'The end of S3 object''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- name: modified_datetime_end
- types:
- - <xref:JSON>
-- description: The format of files.
- name: format
- types:
- - <xref:azure.synapse.artifacts.models.DatasetStorageFormat>
-- description: The data compression method used for the Amazon S3 object.
- name: compression
- types:
- - <xref:azure.synapse.artifacts.models.DatasetCompression>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonS3LinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonS3LinkedService.yml
index 8b13df240b99..07bc1fe36124 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonS3LinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonS3LinkedService.yml
@@ -10,147 +10,77 @@ 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, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, authentication_type:
- MutableMapping[str, Any] | None = None, access_key_id: MutableMapping[str, Any]
- | None = None, secret_access_key: _models.SecretBase | None = None, service_url:
- MutableMapping[str, Any] | None = None, session_token: _models.SecretBase | None
- = None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
- - name: authentication_type
- description: 'The authentication type of S3. Allowed value: AccessKey (default)
-
- or TemporarySecurityCredentials. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
+ - <xref:list>[<xref:object>]
- name: access_key_id
- description: 'The access key identifier of the Amazon S3 Identity and Access
+ description: 'The access key identifier of the Amazon S3 Identity and Access Management
- Management (IAM) user. Type: string (or Expression with resultType string).'
+ (IAM) user. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: secret_access_key
- description: 'The secret access key of the Amazon S3 Identity and Access
+ description: 'The secret access key of the Amazon S3 Identity and Access Management
- Management (IAM) user.'
+ (IAM) user.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: service_url
description: 'This value specifies the endpoint to access with the S3 Connector.
- This
+ This is
- is an optional property; change it only if you want to try a different service
- endpoint or want
+ an optional property; change it only if you want to try a different service
+ endpoint or want to
- to switch between https and http. Type: string (or Expression with resultType
- string).'
+ switch between https and http. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
- - name: session_token
- description: The session token for the S3 temporary security credential.
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The authentication type of S3. Allowed value: AccessKey (default)
- or
-
- TemporarySecurityCredentials. Type: string (or Expression with resultType string).'
- name: authentication_type
- types:
- - <xref:JSON>
-- description: 'The access key identifier of the Amazon S3 Identity and Access Management
-
- (IAM) user. Type: string (or Expression with resultType string).'
- name: access_key_id
- types:
- - <xref:JSON>
-- description: 'The secret access key of the Amazon S3 Identity and Access Management
-
- (IAM) user.'
- name: secret_access_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- 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).'
- name: service_url
- types:
- - <xref:JSON>
-- description: The session token for the S3 temporary security credential.
- name: session_token
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonS3Location.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonS3Location.yml
deleted file mode 100644
index f03db7351013..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonS3Location.yml
+++ /dev/null
@@ -1,87 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AmazonS3Location
-name: AmazonS3Location
-fullName: azure.synapse.artifacts.models.AmazonS3Location
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.DatasetLocation
-summary: 'The location of amazon S3 dataset.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AmazonS3Location(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, folder_path: MutableMapping[str, Any] | None = None, file_name:
- MutableMapping[str, Any] | None = None, bucket_name: MutableMapping[str, Any]
- | None = None, version: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: folder_path
- description: 'Specify the folder path of dataset. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: file_name
- description: 'Specify the file name of dataset. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: bucket_name
- description: 'Specify the bucketName of amazon S3. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: version
- description: 'Specify the version of amazon S3. Type: string (or Expression with
- resultType
-
- string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset storage location. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Specify the folder path of dataset. Type: string (or Expression with
-
- resultType string).'
- name: folder_path
- types:
- - <xref:JSON>
-- description: 'Specify the file name of dataset. Type: string (or Expression with
- resultType
-
- string).'
- name: file_name
- types:
- - <xref:JSON>
-- description: 'Specify the bucketName of amazon S3. Type: string (or Expression with
-
- resultType string).'
- name: bucket_name
- types:
- - <xref:JSON>
-- description: 'Specify the version of amazon S3. Type: string (or Expression with
- resultType
-
- string).'
- name: version
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonS3ReadSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonS3ReadSettings.yml
deleted file mode 100644
index 5cb8478f7eeb..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonS3ReadSettings.yml
+++ /dev/null
@@ -1,181 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AmazonS3ReadSettings
-name: AmazonS3ReadSettings
-fullName: azure.synapse.artifacts.models.AmazonS3ReadSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.StoreReadSettings
-summary: 'Azure data lake store read settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AmazonS3ReadSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None
- = None, recursive: MutableMapping[str, Any] | None = None, wildcard_folder_path:
- MutableMapping[str, Any] | None = None, wildcard_file_name: MutableMapping[str,
- Any] | None = None, prefix: MutableMapping[str, Any] | None = None, file_list_path:
- MutableMapping[str, Any] | None = None, enable_partition_discovery: bool | None
- = None, partition_root_path: MutableMapping[str, Any] | None = None, delete_files_after_completion:
- MutableMapping[str, Any] | None = None, modified_datetime_start: MutableMapping[str,
- Any] | None = None, modified_datetime_end: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: recursive
- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: wildcard_folder_path
- description: 'AmazonS3 wildcardFolderPath. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: wildcard_file_name
- description: 'AmazonS3 wildcardFileName. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: prefix
- description: 'The prefix filter for the S3 object name. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: file_list_path
- description: 'Point to a text file that lists each file (relative path to the
- path
-
- configured in the dataset) that you want to copy. Type: string (or Expression
- with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: enable_partition_discovery
- description: Indicates whether to enable partition discovery.
- types:
- - <xref:bool>
- - name: partition_root_path
- description: 'Specify the root path where partition discovery starts from.
-
- Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: delete_files_after_completion
- description: 'Indicates whether the source files need to be deleted
-
- after copy completion. Default is false. Type: boolean (or Expression with resultType
- boolean).'
- types:
- - <xref:JSON>
- - name: modified_datetime_start
- description: 'The start of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: modified_datetime_end
- description: 'The end of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The read setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- name: recursive
- types:
- - <xref:JSON>
-- description: 'AmazonS3 wildcardFolderPath. Type: string (or Expression with
-
- resultType string).'
- name: wildcard_folder_path
- types:
- - <xref:JSON>
-- description: 'AmazonS3 wildcardFileName. Type: string (or Expression with
-
- resultType string).'
- name: wildcard_file_name
- types:
- - <xref:JSON>
-- description: 'The prefix filter for the S3 object name. Type: string (or Expression
- with
-
- resultType string).'
- name: prefix
- types:
- - <xref:JSON>
-- description: 'Point to a text file that lists each file (relative path to the path
-
- configured in the dataset) that you want to copy. Type: string (or Expression
- with resultType
-
- string).'
- name: file_list_path
- types:
- - <xref:JSON>
-- description: Indicates whether to enable partition discovery.
- name: enable_partition_discovery
- types:
- - <xref:bool>
-- description: 'Specify the root path where partition discovery starts from. Type:
-
- string (or Expression with resultType string).'
- name: partition_root_path
- types:
- - <xref:JSON>
-- description: 'Indicates whether the source files need to be deleted
-
- after copy completion. Default is false. Type: boolean (or Expression with resultType
- boolean).'
- name: delete_files_after_completion
- types:
- - <xref:JSON>
-- description: 'The start of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- name: modified_datetime_start
- types:
- - <xref:JSON>
-- description: 'The end of file''s modified datetime. Type: string (or Expression
-
- with resultType string).'
- name: modified_datetime_end
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AppFiguresLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AppFiguresLinkedService.yml
deleted file mode 100644
index 0aed3437b06d..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AppFiguresLinkedService.yml
+++ /dev/null
@@ -1,92 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AppFiguresLinkedService
-name: AppFiguresLinkedService
-fullName: azure.synapse.artifacts.models.AppFiguresLinkedService
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.LinkedService
-summary: 'Linked service for AppFigures.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AppFiguresLinkedService(*, user_name: MutableMapping[str, Any], password:
- _models.SecretBase, client_key: _models.SecretBase, additional_properties: Dict[str,
- MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: connect_via
- description: The integration runtime reference.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- - name: description
- description: Linked service description.
- types:
- - <xref:str>
- - name: parameters
- description: Parameters for linked service.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the linked service.
- types:
- - <xref:list>[<xref:JSON>]
- - name: user_name
- description: The username of the Appfigures source. Required.
- types:
- - <xref:JSON>
- - name: password
- description: The password of the AppFigures source. Required.
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
- - name: client_key
- description: The client key for the AppFigures source. Required.
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The username of the Appfigures source. Required.
- name: user_name
- types:
- - <xref:JSON>
-- description: The password of the AppFigures source. Required.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: The client key for the AppFigures source. Required.
- name: client_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AppendVariableActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AppendVariableActivity.yml
index e3cfaf258804..b03f286be543 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AppendVariableActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AppendVariableActivity.yml
@@ -4,117 +4,56 @@ name: AppendVariableActivity
fullName: azure.synapse.artifacts.models.AppendVariableActivity
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts.models._models_py3.ControlActivity
+- azure.synapse.artifacts.models._models_py3.Activity
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, MutableMapping[str,
- Any]] | None = None, description: str | None = None, state: str | _models.ActivityState
- | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None
- = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, variable_name: str | None = None, value:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: variable_name
description: Name of the variable whose value needs to be appended to.
+ isRequired: true
types:
- <xref:str>
- name: value
description: Value to be appended. Could be a static value or Expression.
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Name of the variable whose value needs to be appended to.
- name: variable_name
- types:
- - <xref:str>
-- description: Value to be appended. Could be a static value or Expression.
- name: value
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ArtifactRenameRequest.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ArtifactRenameRequest.yml
deleted file mode 100644
index 0b70172c9d5d..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ArtifactRenameRequest.yml
+++ /dev/null
@@ -1,20 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ArtifactRenameRequest
-name: ArtifactRenameRequest
-fullName: azure.synapse.artifacts.models.ArtifactRenameRequest
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Request body structure for rename artifact.
-constructor:
- syntax: 'ArtifactRenameRequest(*, new_name: str | None = None, **kwargs: Any)'
- parameters:
- - name: new_name
- description: New name of the artifact.
- types:
- - <xref:str>
-variables:
-- description: New name of the artifact.
- name: new_name
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AsanaLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AsanaLinkedService.yml
deleted file mode 100644
index a9148a35a71b..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AsanaLinkedService.yml
+++ /dev/null
@@ -1,93 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AsanaLinkedService
-name: AsanaLinkedService
-fullName: azure.synapse.artifacts.models.AsanaLinkedService
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.LinkedService
-summary: 'Linked service for Asana.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AsanaLinkedService(*, api_token: _models.SecretBase, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, encrypted_credential:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: connect_via
- description: The integration runtime reference.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- - name: description
- description: Linked service description.
- types:
- - <xref:str>
- - name: parameters
- description: Parameters for linked service.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the linked service.
- types:
- - <xref:list>[<xref:JSON>]
- - name: api_token
- description: The api token for the Asana source. Required.
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
- - 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).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The api token for the Asana source. Required.
- name: api_token
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AutoPauseProperties.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AutoPauseProperties.yml
deleted file mode 100644
index 549fc1b8f7d5..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AutoPauseProperties.yml
+++ /dev/null
@@ -1,33 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AutoPauseProperties
-name: AutoPauseProperties
-fullName: azure.synapse.artifacts.models.AutoPauseProperties
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Auto-pausing properties of a Big Data pool powered by Apache Spark.
-constructor:
- syntax: 'AutoPauseProperties(*, delay_in_minutes: int | None = None, enabled: bool
- | None = None, **kwargs: Any)'
- parameters:
- - name: delay_in_minutes
- description: 'Number of minutes of idle time before the Big Data pool is
-
- automatically paused.'
- types:
- - <xref:int>
- - name: enabled
- description: Whether auto-pausing is enabled for the Big Data pool.
- types:
- - <xref:bool>
-variables:
-- description: 'Number of minutes of idle time before the Big Data pool is
-
- automatically paused.'
- name: delay_in_minutes
- types:
- - <xref:int>
-- description: Whether auto-pausing is enabled for the Big Data pool.
- name: enabled
- types:
- - <xref:bool>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AutoScaleProperties.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AutoScaleProperties.yml
deleted file mode 100644
index 40c989f3cc70..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AutoScaleProperties.yml
+++ /dev/null
@@ -1,37 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AutoScaleProperties
-name: AutoScaleProperties
-fullName: azure.synapse.artifacts.models.AutoScaleProperties
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Auto-scaling properties of a Big Data pool powered by Apache Spark.
-constructor:
- syntax: 'AutoScaleProperties(*, min_node_count: int | None = None, enabled: bool
- | None = None, max_node_count: int | None = None, **kwargs: Any)'
- parameters:
- - name: min_node_count
- description: The minimum number of nodes the Big Data pool can support.
- types:
- - <xref:int>
- - name: enabled
- description: Whether automatic scaling is enabled for the Big Data pool.
- types:
- - <xref:bool>
- - name: max_node_count
- description: The maximum number of nodes the Big Data pool can support.
- types:
- - <xref:int>
-variables:
-- description: The minimum number of nodes the Big Data pool can support.
- name: min_node_count
- types:
- - <xref:int>
-- description: Whether automatic scaling is enabled for the Big Data pool.
- name: enabled
- types:
- - <xref:bool>
-- description: The maximum number of nodes the Big Data pool can support.
- name: max_node_count
- types:
- - <xref:int>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroCompressionCodec.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroCompressionCodec.yml
index 7f53289235d1..766c728540fe 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroCompressionCodec.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroCompressionCodec.yml
@@ -2,7 +2,6 @@
uid: azure.synapse.artifacts.models.AvroCompressionCodec
name: AvroCompressionCodec
fullName: azure.synapse.artifacts.models.AvroCompressionCodec
-summary: AvroCompressionCodec.
module: azure.synapse.artifacts.models
constructor:
syntax: AvroCompressionCodec(value, names=None, *, module=None, qualname=None, type=None,
@@ -11,13 +10,13 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroDataset.yml
index ff4c6fc57b58..83392fb5b05f 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroDataset.yml
@@ -10,124 +10,84 @@ summary: 'Avro dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AvroDataset(*, linked_service_name: _models.LinkedServiceReference, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None,
- structure: MutableMapping[str, Any] | None = None, schema: MutableMapping[str,
- Any] | None = None, parameters: Dict[str, _models.ParameterSpecification] | None
- = None, annotations: List[MutableMapping[str, Any]] | None = None, folder: _models.DatasetFolder
- | None = None, location: _models.DatasetLocation | None = None, avro_compression_codec:
- MutableMapping[str, Any] | None = None, avro_compression_level: int | None = None,
- **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: location
description: The location of the avro storage.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetLocation>
- name: avro_compression_codec
- description: A string from AvroCompressionCodecEnum or an expression.
+ description: 'Possible values include: "none", "deflate", "snappy", "xz",
+
+ "bzip2".'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:str>
+ - <xref:azure.synapse.artifacts.models.AvroCompressionCodec>
- name: avro_compression_level
+ isRequired: true
types:
- <xref:int>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: The location of the avro storage.
- name: location
- types:
- - <xref:azure.synapse.artifacts.models.DatasetLocation>
-- description: A string from AvroCompressionCodecEnum or an expression.
- name: avro_compression_codec
- types:
- - <xref:JSON>
-- name: avro_compression_level
- types:
- - <xref:int>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroFormat.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroFormat.yml
deleted file mode 100644
index 7ac98ee74c8c..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroFormat.yml
+++ /dev/null
@@ -1,49 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AvroFormat
-name: AvroFormat
-fullName: azure.synapse.artifacts.models.AvroFormat
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.DatasetStorageFormat
-summary: 'The data stored in Avro format.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AvroFormat(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, serializer: MutableMapping[str, Any] | None = None, deserializer:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: serializer
- description: 'Serializer. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: deserializer
- description: 'Deserializer. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset storage format. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Serializer. Type: string (or Expression with resultType string).'
- name: serializer
- types:
- - <xref:JSON>
-- description: 'Deserializer. Type: string (or Expression with resultType string).'
- name: deserializer
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroSink.yml
deleted file mode 100644
index d9efded16369..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroSink.yml
+++ /dev/null
@@ -1,113 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AvroSink
-name: AvroSink
-fullName: azure.synapse.artifacts.models.AvroSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Avro sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AvroSink(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, write_batch_size: MutableMapping[str, Any] | None = None, write_batch_timeout:
- MutableMapping[str, Any] | None = None, sink_retry_count: MutableMapping[str,
- Any] | None = None, sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, store_settings: _models.StoreWriteSettings
- | None = None, format_settings: _models.AvroWriteSettings | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: store_settings
- description: Avro store settings.
- types:
- - <xref:azure.synapse.artifacts.models.StoreWriteSettings>
- - name: format_settings
- description: Avro format settings.
- types:
- - <xref:azure.synapse.artifacts.models.AvroWriteSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: Avro store settings.
- name: store_settings
- types:
- - <xref:azure.synapse.artifacts.models.StoreWriteSettings>
-- description: Avro format settings.
- name: format_settings
- types:
- - <xref:azure.synapse.artifacts.models.AvroWriteSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroSource.yml
deleted file mode 100644
index c90123116409..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroSource.yml
+++ /dev/null
@@ -1,92 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AvroSource
-name: AvroSource
-fullName: azure.synapse.artifacts.models.AvroSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity Avro source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AvroSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, store_settings: _models.StoreReadSettings | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: store_settings
- description: Avro store settings.
- types:
- - <xref:azure.synapse.artifacts.models.StoreReadSettings>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: Avro store settings.
- name: store_settings
- types:
- - <xref:azure.synapse.artifacts.models.StoreReadSettings>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroWriteSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroWriteSettings.yml
deleted file mode 100644
index 97f4ab5910db..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroWriteSettings.yml
+++ /dev/null
@@ -1,85 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AvroWriteSettings
-name: AvroWriteSettings
-fullName: azure.synapse.artifacts.models.AvroWriteSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.FormatWriteSettings
-summary: 'Avro write settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AvroWriteSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, record_name: str | None = None, record_namespace: str | None
- = None, max_rows_per_file: MutableMapping[str, Any] | None = None, file_name_prefix:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: record_name
- description: Top level record name in write result, which is required in AVRO
- spec.
- types:
- - <xref:str>
- - name: record_namespace
- description: Record namespace in the write result.
- types:
- - <xref:str>
- - name: max_rows_per_file
- description: 'Limit the written file''s row count to be smaller than or equal
- to
-
- the specified count. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: file_name_prefix
- description: 'Specifies the file name pattern
-
- >>:code:`<fileNamePrefix>`_<<`<fileIndex>`.:code:*<fileExtension>* when copy
- from non-file
-
- based store without partitionOptions. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The write setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: Top level record name in write result, which is required in AVRO spec.
- name: record_name
- types:
- - <xref:str>
-- description: Record namespace in the write result.
- name: record_namespace
- types:
- - <xref:str>
-- description: 'Limit the written file''s row count to be smaller than or equal to
- the
-
- specified count. Type: integer (or Expression with resultType integer).'
- name: max_rows_per_file
- types:
- - <xref:JSON>
-- description: 'Specifies the file name pattern
-
- >>:code:`<fileNamePrefix>`_<<`<fileIndex>`.:code:*<fileExtension>* when copy from
- non-file
-
- based store without partitionOptions. Type: string (or Expression with resultType
- string).'
- name: file_name_prefix
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBatchLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBatchLinkedService.yml
index 9f26d2e44640..fb824b0edd5e 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBatchLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBatchLinkedService.yml
@@ -10,141 +10,86 @@ summary: 'Azure Batch linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzureBatchLinkedService(*, account_name: MutableMapping[str, Any], batch_uri:
- MutableMapping[str, Any], pool_name: MutableMapping[str, Any], linked_service_name:
- _models.LinkedServiceReference, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, access_key:
- _models.SecretBase | None = None, encrypted_credential: MutableMapping[str, Any]
- | None = None, credential: _models.CredentialReference | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: account_name
- description: 'The Azure Batch account name. Type: string (or Expression with
+ description: 'Required. The Azure Batch account name. Type: string (or Expression
+ with
- resultType string). Required.'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: access_key
description: The Azure Batch account access key.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: batch_uri
- description: 'The Azure Batch URI. Type: string (or Expression with resultType
- string).
+ description: 'Required. The Azure Batch URI. Type: string (or Expression with
+ resultType
- Required.'
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: pool_name
- description: 'The Azure Batch pool name. Type: string (or Expression with resultType
+ description: 'Required. The Azure Batch pool name. Type: string (or Expression
+ with
- string). Required.'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: The Azure Storage linked service reference. Required.
+ description: Required. The Azure Storage linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
- types:
- - <xref:JSON>
- - name: credential
- description: The credential reference containing authentication information.
+ resultType string).'
+ isRequired: true
types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The Azure Batch account name. Type: string (or Expression with resultType
-
- string). Required.'
- name: account_name
- types:
- - <xref:JSON>
-- description: The Azure Batch account access key.
- name: access_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The Azure Batch URI. Type: string (or Expression with resultType string).
-
- Required.'
- name: batch_uri
- types:
- - <xref:JSON>
-- description: 'The Azure Batch pool name. Type: string (or Expression with resultType
-
- string). Required.'
- name: pool_name
- types:
- - <xref:JSON>
-- description: The Azure Storage linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
-- description: The credential reference containing authentication information.
- name: credential
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobDataset.yml
deleted file mode 100644
index ca7aae26e52a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobDataset.yml
+++ /dev/null
@@ -1,191 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureBlobDataset
-name: AzureBlobDataset
-fullName: azure.synapse.artifacts.models.AzureBlobDataset
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.Dataset
-summary: 'The Azure Blob storage.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureBlobDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, folder_path: MutableMapping[str, Any] | None
- = None, table_root_location: MutableMapping[str, Any] | None = None, file_name:
- MutableMapping[str, Any] | None = None, modified_datetime_start: MutableMapping[str,
- Any] | None = None, modified_datetime_end: MutableMapping[str, Any] | None = None,
- format: _models.DatasetStorageFormat | None = None, compression: _models.DatasetCompression
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Dataset description.
- types:
- - <xref:str>
- - name: structure
- description: 'Columns that define the structure of the dataset. Type: array (or
-
- Expression with resultType array), itemType: DatasetDataElement.'
- types:
- - <xref:JSON>
- - name: schema
- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- types:
- - <xref:JSON>
- - name: linked_service_name
- description: Linked service reference. Required.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: parameters
- description: Parameters for dataset.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the Dataset.
- types:
- - <xref:list>[<xref:JSON>]
- - name: folder
- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
-
- the root level.'
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
- - name: folder_path
- description: 'The path of the Azure Blob storage. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: table_root_location
- description: 'The root of blob path. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: file_name
- description: 'The name of the Azure Blob. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: modified_datetime_start
- description: 'The start of Azure Blob''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: modified_datetime_end
- description: 'The end of Azure Blob''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: format
- description: The format of the Azure Blob storage.
- types:
- - <xref:azure.synapse.artifacts.models.DatasetStorageFormat>
- - name: compression
- description: The data compression method used for the blob storage.
- types:
- - <xref:azure.synapse.artifacts.models.DatasetCompression>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The path of the Azure Blob storage. Type: string (or Expression with
-
- resultType string).'
- name: folder_path
- types:
- - <xref:JSON>
-- description: 'The root of blob path. Type: string (or Expression with resultType
-
- string).'
- name: table_root_location
- types:
- - <xref:JSON>
-- description: 'The name of the Azure Blob. Type: string (or Expression with resultType
-
- string).'
- name: file_name
- types:
- - <xref:JSON>
-- description: 'The start of Azure Blob''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- name: modified_datetime_start
- types:
- - <xref:JSON>
-- description: 'The end of Azure Blob''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- name: modified_datetime_end
- types:
- - <xref:JSON>
-- description: The format of the Azure Blob storage.
- name: format
- types:
- - <xref:azure.synapse.artifacts.models.DatasetStorageFormat>
-- description: The data compression method used for the blob storage.
- name: compression
- types:
- - <xref:azure.synapse.artifacts.models.DatasetCompression>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSDataset.yml
deleted file mode 100644
index 79b9cc68f54f..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSDataset.yml
+++ /dev/null
@@ -1,155 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureBlobFSDataset
-name: AzureBlobFSDataset
-fullName: azure.synapse.artifacts.models.AzureBlobFSDataset
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.Dataset
-summary: 'The Azure Data Lake Storage Gen2 storage.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureBlobFSDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, folder_path: MutableMapping[str, Any] | None
- = None, file_name: MutableMapping[str, Any] | None = None, format: _models.DatasetStorageFormat
- | None = None, compression: _models.DatasetCompression | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Dataset description.
- types:
- - <xref:str>
- - name: structure
- description: 'Columns that define the structure of the dataset. Type: array (or
-
- Expression with resultType array), itemType: DatasetDataElement.'
- types:
- - <xref:JSON>
- - name: schema
- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- types:
- - <xref:JSON>
- - name: linked_service_name
- description: Linked service reference. Required.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: parameters
- description: Parameters for dataset.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the Dataset.
- types:
- - <xref:list>[<xref:JSON>]
- - name: folder
- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
-
- the root level.'
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
- - name: folder_path
- description: 'The path of the Azure Data Lake Storage Gen2 storage. Type: string
- (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: file_name
- description: 'The name of the Azure Data Lake Storage Gen2. Type: string (or Expression
-
- with resultType string).'
- types:
- - <xref:JSON>
- - name: format
- description: The format of the Azure Data Lake Storage Gen2 storage.
- types:
- - <xref:azure.synapse.artifacts.models.DatasetStorageFormat>
- - name: compression
- description: The data compression method used for the blob storage.
- types:
- - <xref:azure.synapse.artifacts.models.DatasetCompression>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The path of the Azure Data Lake Storage Gen2 storage. Type: string
- (or
-
- Expression with resultType string).'
- name: folder_path
- types:
- - <xref:JSON>
-- description: 'The name of the Azure Data Lake Storage Gen2. Type: string (or Expression
- with
-
- resultType string).'
- name: file_name
- types:
- - <xref:JSON>
-- description: The format of the Azure Data Lake Storage Gen2 storage.
- name: format
- types:
- - <xref:azure.synapse.artifacts.models.DatasetStorageFormat>
-- description: The data compression method used for the blob storage.
- name: compression
- types:
- - <xref:azure.synapse.artifacts.models.DatasetCompression>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSLinkedService.yml
index d44b0ad368b1..14527b595163 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSLinkedService.yml
@@ -10,66 +10,75 @@ summary: 'Azure Data Lake Storage Gen2 linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzureBlobFSLinkedService(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, url:
- MutableMapping[str, Any] | None = None, account_key: MutableMapping[str, Any]
- | None = None, service_principal_id: MutableMapping[str, Any] | None = None, service_principal_key:
- _models.SecretBase | None = None, tenant: MutableMapping[str, Any] | None = None,
- azure_cloud_type: MutableMapping[str, Any] | None = None, service_principal_credential_type:
- MutableMapping[str, Any] | None = None, service_principal_credential: _models.SecretBase
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, sas_uri:
- MutableMapping[str, Any] | None = None, sas_token: _models.SecretBase | None =
- None, credential: _models.CredentialReference | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: url
- description: 'Endpoint for the Azure Data Lake Storage Gen2 service. Type: string
- (or
+ description: 'Required. Endpoint for the Azure Data Lake Storage Gen2 service.
+ Type: string (or
Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: account_key
description: 'Account key for the Azure Data Lake Storage Gen2 service. Type:
- string
+ string (or
- (or Expression with resultType string).'
+ Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_key
- description: 'The Key of the application used to authenticate against the
+ description: 'The Key of the application used to authenticate against the Azure
- Azure Data Lake Storage Gen2 account.'
+ Data Lake Storage Gen2 account.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: tenant
@@ -77,175 +86,16 @@ constructor:
Type:
string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
- - name: azure_cloud_type
- description: 'Indicates the azure cloud type of the service principle auth.
-
- Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany.
- Default value is
-
- the data factory regions'' cloud type. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
- - 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).'
- types:
- - <xref:JSON>
- - 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.'
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
-
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ description: 'The encrypted credential used for authentication. Credentials are
- with resultType string).'
- types:
- - <xref:JSON>
- - name: sas_uri
- description: 'SAS URI of the Azure Data Lake Storage Gen2 service. Type: string,
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- SecureString or AzureKeyVaultSecretReference.'
- types:
- - <xref:JSON>
- - name: sas_token
- description: The Azure key vault secret reference of sasToken in sas uri.
+ resultType string).'
+ isRequired: true
types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
- - name: credential
- description: The credential reference containing authentication information.
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Endpoint for the Azure Data Lake Storage Gen2 service. Type: string
- (or Expression
-
- with resultType string).'
- name: url
- types:
- - <xref:JSON>
-- description: 'Account key for the Azure Data Lake Storage Gen2 service. Type: string
- (or
-
- Expression with resultType string).'
- name: account_key
- types:
- - <xref:JSON>
-- description: 'The ID of the application used to authenticate against the Azure
-
- Data Lake Storage Gen2 account. Type: string (or Expression with resultType string).'
- name: service_principal_id
- types:
- - <xref:JSON>
-- description: 'The Key of the application used to authenticate against the Azure
-
- Data Lake Storage Gen2 account.'
- name: service_principal_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The name or ID of the tenant to which the service principal belongs.
- Type: string
-
- (or Expression with resultType string).'
- name: tenant
- types:
- - <xref:JSON>
-- description: 'Indicates the azure cloud type of the service principle auth. Allowed
-
- values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value
- is the data
-
- factory regions'' cloud type. Type: string (or Expression with resultType string).'
- name: azure_cloud_type
- types:
- - <xref:JSON>
-- 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).'
- name: service_principal_credential_type
- types:
- - <xref:JSON>
-- 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.'
- name: service_principal_credential
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
-- description: 'SAS URI of the Azure Data Lake Storage Gen2 service. Type: string,
- SecureString
-
- or AzureKeyVaultSecretReference.'
- name: sas_uri
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of sasToken in sas uri.
- name: sas_token
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: The credential reference containing authentication information.
- name: credential
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSLocation.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSLocation.yml
deleted file mode 100644
index f068155a6c4f..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSLocation.yml
+++ /dev/null
@@ -1,74 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureBlobFSLocation
-name: AzureBlobFSLocation
-fullName: azure.synapse.artifacts.models.AzureBlobFSLocation
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.DatasetLocation
-summary: 'The location of azure blobFS dataset.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureBlobFSLocation(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, folder_path: MutableMapping[str, Any] | None = None, file_name:
- MutableMapping[str, Any] | None = None, file_system: MutableMapping[str, Any]
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: folder_path
- description: 'Specify the folder path of dataset. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: file_name
- description: 'Specify the file name of dataset. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: file_system
- description: 'Specify the fileSystem of azure blobFS. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset storage location. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Specify the folder path of dataset. Type: string (or Expression with
-
- resultType string).'
- name: folder_path
- types:
- - <xref:JSON>
-- description: 'Specify the file name of dataset. Type: string (or Expression with
- resultType
-
- string).'
- name: file_name
- types:
- - <xref:JSON>
-- description: 'Specify the fileSystem of azure blobFS. Type: string (or Expression
- with
-
- resultType string).'
- name: file_system
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSReadSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSReadSettings.yml
deleted file mode 100644
index d17f231a9bf5..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSReadSettings.yml
+++ /dev/null
@@ -1,170 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureBlobFSReadSettings
-name: AzureBlobFSReadSettings
-fullName: azure.synapse.artifacts.models.AzureBlobFSReadSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.StoreReadSettings
-summary: 'Azure blobFS read settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureBlobFSReadSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None
- = None, recursive: MutableMapping[str, Any] | None = None, wildcard_folder_path:
- MutableMapping[str, Any] | None = None, wildcard_file_name: MutableMapping[str,
- Any] | None = None, file_list_path: MutableMapping[str, Any] | None = None, enable_partition_discovery:
- MutableMapping[str, Any] | None = None, partition_root_path: MutableMapping[str,
- Any] | None = None, delete_files_after_completion: MutableMapping[str, Any] |
- None = None, modified_datetime_start: MutableMapping[str, Any] | None = None,
- modified_datetime_end: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: recursive
- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: wildcard_folder_path
- description: 'Azure blobFS wildcardFolderPath. Type: string (or Expression
-
- with resultType string).'
- types:
- - <xref:JSON>
- - name: wildcard_file_name
- description: 'Azure blobFS wildcardFileName. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: file_list_path
- description: 'Point to a text file that lists each file (relative path to the
- path
-
- configured in the dataset) that you want to copy. Type: string (or Expression
- with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: enable_partition_discovery
- description: 'Indicates whether to enable partition discovery. Type:
-
- boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: partition_root_path
- description: 'Specify the root path where partition discovery starts from.
-
- Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: delete_files_after_completion
- description: 'Indicates whether the source files need to be deleted
-
- after copy completion. Default is false. Type: boolean (or Expression with resultType
- boolean).'
- types:
- - <xref:JSON>
- - name: modified_datetime_start
- description: 'The start of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: modified_datetime_end
- description: 'The end of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The read setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- name: recursive
- types:
- - <xref:JSON>
-- description: 'Azure blobFS wildcardFolderPath. Type: string (or Expression with
-
- resultType string).'
- name: wildcard_folder_path
- types:
- - <xref:JSON>
-- description: 'Azure blobFS wildcardFileName. Type: string (or Expression with
-
- resultType string).'
- name: wildcard_file_name
- types:
- - <xref:JSON>
-- description: 'Point to a text file that lists each file (relative path to the path
-
- configured in the dataset) that you want to copy. Type: string (or Expression
- with resultType
-
- string).'
- name: file_list_path
- types:
- - <xref:JSON>
-- description: 'Indicates whether to enable partition discovery. Type:
-
- boolean (or Expression with resultType boolean).'
- name: enable_partition_discovery
- types:
- - <xref:JSON>
-- description: 'Specify the root path where partition discovery starts from. Type:
-
- string (or Expression with resultType string).'
- name: partition_root_path
- types:
- - <xref:JSON>
-- description: 'Indicates whether the source files need to be deleted
-
- after copy completion. Default is false. Type: boolean (or Expression with resultType
- boolean).'
- name: delete_files_after_completion
- types:
- - <xref:JSON>
-- description: 'The start of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- name: modified_datetime_start
- types:
- - <xref:JSON>
-- description: 'The end of file''s modified datetime. Type: string (or Expression
-
- with resultType string).'
- name: modified_datetime_end
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSSink.yml
deleted file mode 100644
index 7a7798dddf78..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSSink.yml
+++ /dev/null
@@ -1,109 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureBlobFSSink
-name: AzureBlobFSSink
-fullName: azure.synapse.artifacts.models.AzureBlobFSSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Azure Data Lake Storage Gen2 sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureBlobFSSink(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, write_batch_size: MutableMapping[str, Any] | None = None,
- write_batch_timeout: MutableMapping[str, Any] | None = None, sink_retry_count:
- MutableMapping[str, Any] | None = None, sink_retry_wait: MutableMapping[str, Any]
- | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None,
- copy_behavior: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: copy_behavior
- description: 'The type of copy behavior for copy sink. Type: string (or Expression
-
- with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'The type of copy behavior for copy sink. Type: string (or Expression
- with
-
- resultType string).'
- name: copy_behavior
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSSource.yml
deleted file mode 100644
index 3e9784b51cb7..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSSource.yml
+++ /dev/null
@@ -1,110 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureBlobFSSource
-name: AzureBlobFSSource
-fullName: azure.synapse.artifacts.models.AzureBlobFSSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity Azure BlobFS source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureBlobFSSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, treat_empty_as_null: MutableMapping[str,
- Any] | None = None, skip_header_line_count: MutableMapping[str, Any] | None =
- None, recursive: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: treat_empty_as_null
- description: 'Treat empty as null. Type: boolean (or Expression with resultType
-
- boolean).'
- types:
- - <xref:JSON>
- - name: skip_header_line_count
- description: 'Number of header lines to skip from each blob. Type: integer
-
- (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: recursive
- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Treat empty as null. Type: boolean (or Expression with resultType
-
- boolean).'
- name: treat_empty_as_null
- types:
- - <xref:JSON>
-- description: 'Number of header lines to skip from each blob. Type: integer (or
-
- Expression with resultType integer).'
- name: skip_header_line_count
- types:
- - <xref:JSON>
-- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- name: recursive
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSWriteSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSWriteSettings.yml
deleted file mode 100644
index 9cc8cf3f5d02..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSWriteSettings.yml
+++ /dev/null
@@ -1,66 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureBlobFSWriteSettings
-name: AzureBlobFSWriteSettings
-fullName: azure.synapse.artifacts.models.AzureBlobFSWriteSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.StoreWriteSettings
-summary: 'Azure blobFS write settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureBlobFSWriteSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None
- = None, copy_behavior: MutableMapping[str, Any] | None = None, block_size_in_mb:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: copy_behavior
- description: The type of copy behavior for copy sink.
- types:
- - <xref:JSON>
- - name: block_size_in_mb
- description: 'Indicates the block size(MB) when writing data to blob. Type:
-
- integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The write setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: The type of copy behavior for copy sink.
- name: copy_behavior
- types:
- - <xref:JSON>
-- description: 'Indicates the block size(MB) when writing data to blob. Type: integer
-
- (or Expression with resultType integer).'
- name: block_size_in_mb
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobStorageLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobStorageLinkedService.yml
index d2baa19bacd5..9709ecb516c4 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobStorageLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobStorageLinkedService.yml
@@ -10,51 +10,59 @@ 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, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, connection_string:
- MutableMapping[str, Any] | None = None, account_key: _models.AzureKeyVaultSecretReference
- | None = None, sas_uri: MutableMapping[str, Any] | None = None, sas_token: _models.AzureKeyVaultSecretReference
- | None = None, service_endpoint: str | None = None, service_principal_id: MutableMapping[str,
- Any] | None = None, service_principal_key: _models.SecretBase | None = None, tenant:
- MutableMapping[str, Any] | None = None, azure_cloud_type: MutableMapping[str,
- Any] | None = None, account_kind: str | None = None, encrypted_credential: str
- | None = None, credential: _models.CredentialReference | None = None, authentication_type:
- str | _models.AzureStorageAuthenticationType | None = None, container_uri: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
description: 'The connection string. It is mutually exclusive with sasUri,
serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: account_key
description: The Azure key vault secret reference of accountKey in connection
string.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- name: sas_uri
@@ -64,28 +72,33 @@ constructor:
connectionString, serviceEndpoint property. Type: string, SecureString or
AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: sas_token
description: The Azure key vault secret reference of sasToken in sas uri.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- name: service_endpoint
description: 'Blob service endpoint of the Azure Blob Storage resource. It is
mutually exclusive with connectionString, sasUri property.'
+ isRequired: true
types:
- <xref:str>
- name: service_principal_id
- description: 'The ID of the service principal used to authenticate against
+ description: 'The ID of the service principal used to authenticate against Azure
- Azure SQL Data Warehouse. Type: string (or Expression with resultType string).'
+ SQL Data Warehouse. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_key
description: 'The key of the service principal used to authenticate against
Azure SQL Data Warehouse.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: tenant
@@ -93,169 +106,16 @@ constructor:
Type:
string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
- - name: azure_cloud_type
- description: 'Indicates the azure cloud type of the service principle auth.
-
- Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany.
- Default value is
-
- the data factory regions'' cloud type. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
- - name: account_kind
- description: 'Specify the kind of your storage account. Allowed values are: Storage
-
- (general purpose v1), StorageV2 (general purpose v2), BlobStorage, or BlockBlobStorage.
- Type:
-
- string (or Expression with resultType string).'
- types:
- - <xref:str>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
-
- with resultType string).'
- types:
- - <xref:str>
- - name: credential
- description: The credential reference containing authentication information.
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
- - name: authentication_type
- description: 'The type used for authentication. Type: string. Known values are:
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- "Anonymous", "AccountKey", "SasUri", "ServicePrincipal", and "Msi".'
+ resultType string).'
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.AzureStorageAuthenticationType>
- - name: container_uri
- description: 'Container uri of the Azure Blob Storage resource only support for
-
- anonymous access. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The connection string. It is mutually exclusive with sasUri,
-
- serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of accountKey in connection string.
- name: account_key
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'SAS URI of the Azure Blob Storage resource. It is mutually exclusive
- with
-
- connectionString, serviceEndpoint property. Type: string, SecureString or
-
- AzureKeyVaultSecretReference.'
- name: sas_uri
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of sasToken in sas uri.
- name: sas_token
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'Blob service endpoint of the Azure Blob Storage resource. It is
-
- mutually exclusive with connectionString, sasUri property.'
- name: service_endpoint
- types:
- - <xref:str>
-- description: 'The ID of the service principal used to authenticate against Azure
-
- SQL Data Warehouse. Type: string (or Expression with resultType string).'
- name: service_principal_id
- types:
- - <xref:JSON>
-- description: 'The key of the service principal used to authenticate against
-
- Azure SQL Data Warehouse.'
- name: service_principal_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The name or ID of the tenant to which the service principal belongs.
- Type: string
-
- (or Expression with resultType string).'
- name: tenant
- types:
- - <xref:JSON>
-- description: 'Indicates the azure cloud type of the service principle auth. Allowed
-
- values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value
- is the data
-
- factory regions'' cloud type. Type: string (or Expression with resultType string).'
- name: azure_cloud_type
- types:
- - <xref:JSON>
-- description: 'Specify the kind of your storage account. Allowed values are: Storage
-
- (general purpose v1), StorageV2 (general purpose v2), BlobStorage, or BlockBlobStorage.
- Type:
-
- string (or Expression with resultType string).'
- name: account_kind
- types:
- - <xref:str>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:str>
-- description: The credential reference containing authentication information.
- name: credential
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
-- description: 'The type used for authentication. Type: string. Known values are:
-
- "Anonymous", "AccountKey", "SasUri", "ServicePrincipal", and "Msi".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.AzureStorageAuthenticationType>
-- description: 'Container uri of the Azure Blob Storage resource only support for
-
- anonymous access. Type: string (or Expression with resultType string).'
- name: container_uri
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobStorageLocation.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobStorageLocation.yml
deleted file mode 100644
index 91780377d6aa..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobStorageLocation.yml
+++ /dev/null
@@ -1,73 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureBlobStorageLocation
-name: AzureBlobStorageLocation
-fullName: azure.synapse.artifacts.models.AzureBlobStorageLocation
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.DatasetLocation
-summary: 'The location of azure blob dataset.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureBlobStorageLocation(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, folder_path: MutableMapping[str, Any] | None = None, file_name:
- MutableMapping[str, Any] | None = None, container: MutableMapping[str, Any] |
- None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: folder_path
- description: 'Specify the folder path of dataset. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: file_name
- description: 'Specify the file name of dataset. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: container
- description: 'Specify the container of azure blob. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset storage location. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Specify the folder path of dataset. Type: string (or Expression with
-
- resultType string).'
- name: folder_path
- types:
- - <xref:JSON>
-- description: 'Specify the file name of dataset. Type: string (or Expression with
- resultType
-
- string).'
- name: file_name
- types:
- - <xref:JSON>
-- description: 'Specify the container of azure blob. Type: string (or Expression with
-
- resultType string).'
- name: container
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobStorageReadSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobStorageReadSettings.yml
deleted file mode 100644
index fc80ab1fe49a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobStorageReadSettings.yml
+++ /dev/null
@@ -1,181 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureBlobStorageReadSettings
-name: AzureBlobStorageReadSettings
-fullName: azure.synapse.artifacts.models.AzureBlobStorageReadSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.StoreReadSettings
-summary: 'Azure blob read settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureBlobStorageReadSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None
- = None, recursive: MutableMapping[str, Any] | None = None, wildcard_folder_path:
- MutableMapping[str, Any] | None = None, wildcard_file_name: MutableMapping[str,
- Any] | None = None, prefix: MutableMapping[str, Any] | None = None, file_list_path:
- MutableMapping[str, Any] | None = None, enable_partition_discovery: bool | None
- = None, partition_root_path: MutableMapping[str, Any] | None = None, delete_files_after_completion:
- MutableMapping[str, Any] | None = None, modified_datetime_start: MutableMapping[str,
- Any] | None = None, modified_datetime_end: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: recursive
- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: wildcard_folder_path
- description: 'Azure blob wildcardFolderPath. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: wildcard_file_name
- description: 'Azure blob wildcardFileName. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: prefix
- description: 'The prefix filter for the Azure Blob name. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: file_list_path
- description: 'Point to a text file that lists each file (relative path to the
- path
-
- configured in the dataset) that you want to copy. Type: string (or Expression
- with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: enable_partition_discovery
- description: Indicates whether to enable partition discovery.
- types:
- - <xref:bool>
- - name: partition_root_path
- description: 'Specify the root path where partition discovery starts from.
-
- Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: delete_files_after_completion
- description: 'Indicates whether the source files need to be deleted
-
- after copy completion. Default is false. Type: boolean (or Expression with resultType
- boolean).'
- types:
- - <xref:JSON>
- - name: modified_datetime_start
- description: 'The start of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: modified_datetime_end
- description: 'The end of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The read setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- name: recursive
- types:
- - <xref:JSON>
-- description: 'Azure blob wildcardFolderPath. Type: string (or Expression with
-
- resultType string).'
- name: wildcard_folder_path
- types:
- - <xref:JSON>
-- description: 'Azure blob wildcardFileName. Type: string (or Expression with
-
- resultType string).'
- name: wildcard_file_name
- types:
- - <xref:JSON>
-- description: 'The prefix filter for the Azure Blob name. Type: string (or Expression
- with
-
- resultType string).'
- name: prefix
- types:
- - <xref:JSON>
-- description: 'Point to a text file that lists each file (relative path to the path
-
- configured in the dataset) that you want to copy. Type: string (or Expression
- with resultType
-
- string).'
- name: file_list_path
- types:
- - <xref:JSON>
-- description: Indicates whether to enable partition discovery.
- name: enable_partition_discovery
- types:
- - <xref:bool>
-- description: 'Specify the root path where partition discovery starts from. Type:
-
- string (or Expression with resultType string).'
- name: partition_root_path
- types:
- - <xref:JSON>
-- description: 'Indicates whether the source files need to be deleted
-
- after copy completion. Default is false. Type: boolean (or Expression with resultType
- boolean).'
- name: delete_files_after_completion
- types:
- - <xref:JSON>
-- description: 'The start of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- name: modified_datetime_start
- types:
- - <xref:JSON>
-- description: 'The end of file''s modified datetime. Type: string (or Expression
-
- with resultType string).'
- name: modified_datetime_end
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobStorageWriteSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobStorageWriteSettings.yml
deleted file mode 100644
index bd449c17ce77..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobStorageWriteSettings.yml
+++ /dev/null
@@ -1,66 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureBlobStorageWriteSettings
-name: AzureBlobStorageWriteSettings
-fullName: azure.synapse.artifacts.models.AzureBlobStorageWriteSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.StoreWriteSettings
-summary: 'Azure blob write settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureBlobStorageWriteSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None
- = None, copy_behavior: MutableMapping[str, Any] | None = None, block_size_in_mb:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: copy_behavior
- description: The type of copy behavior for copy sink.
- types:
- - <xref:JSON>
- - name: block_size_in_mb
- description: 'Indicates the block size(MB) when writing data to blob. Type:
-
- integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The write setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: The type of copy behavior for copy sink.
- name: copy_behavior
- types:
- - <xref:JSON>
-- description: 'Indicates the block size(MB) when writing data to blob. Type: integer
-
- (or Expression with resultType integer).'
- name: block_size_in_mb
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerCommandActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerCommandActivity.yml
index b7cd05687b02..73663128cb37 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerCommandActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerCommandActivity.yml
@@ -10,139 +10,66 @@ summary: 'Azure Data Explorer command activity.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzureDataExplorerCommandActivity(*, name: str, command: MutableMapping[str,
- Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- description: str | None = None, state: str | _models.ActivityState | None = None,
- on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None = None, depends_on:
- List[_models.ActivityDependency] | None = None, user_properties: List[_models.UserProperty]
- | None = None, linked_service_name: _models.LinkedServiceReference | None = None,
- policy: _models.ActivityPolicy | None = None, command_timeout: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
- name: command
- description: 'A control command, according to the Azure Data Explorer command
- syntax. Type:
+ description: 'Required. A control command, according to the Azure Data Explorer
+ command
- string (or Expression with resultType string). Required.'
+ syntax. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: 'A control command, according to the Azure Data Explorer command syntax.
- Type:
-
- string (or Expression with resultType string). Required.'
- name: command
- types:
- - <xref:JSON>
-- description: 'Control command timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9]))..).'
- name: command_timeout
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerLinkedService.yml
index 069920cd5be7..f10d719b9bb7 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerLinkedService.yml
@@ -10,139 +10,81 @@ summary: 'Azure Data Explorer (Kusto) linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzureDataExplorerLinkedService(*, endpoint: MutableMapping[str, Any], database:
- MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, service_principal_id:
- MutableMapping[str, Any] | None = None, service_principal_key: _models.SecretBase
- | None = None, tenant: MutableMapping[str, Any] | None = None, credential: _models.CredentialReference
- | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: endpoint
- description: 'The endpoint of Azure Data Explorer (the engine''s endpoint). URL
- will be in
+ description: 'Required. The endpoint of Azure Data Explorer (the engine''s endpoint).
+ URL
- the format [https://](https://)`<clusterName>`.:code:*<regionName>*.kusto.windows.net.
- Type: string
+ will be in the format [https://](https://)`<clusterName>`.:code:*<regionName>*.kusto.windows.net.
- (or Expression with resultType string). Required.'
+ Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_id
- description: 'The ID of the service principal used to authenticate against
+ description: 'Required. The ID of the service principal used to authenticate
- Azure Data Explorer. Type: string (or Expression with resultType string).'
+ against Azure Data Explorer. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_key
- description: 'The key of the service principal used to authenticate against
+ description: 'Required. The key of the service principal used to authenticate
- Kusto.'
+ against Kusto.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: database
- description: 'Database name for connection. Type: string (or Expression with resultType
+ description: 'Required. Database name for connection. Type: string (or Expression
+ with
- string). Required.'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: tenant
- description: 'The name or ID of the tenant to which the service principal belongs.
- Type:
+ description: 'Required. The name or ID of the tenant to which the service principal
+ belongs.
- string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: credential
- description: The credential reference containing authentication information.
+ Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The endpoint of Azure Data Explorer (the engine''s endpoint). URL
- will be in the
-
- format [https://](https://)`<clusterName>`.:code:*<regionName>*.kusto.windows.net.
- Type: string (or
-
- Expression with resultType string). Required.'
- name: endpoint
- types:
- - <xref:JSON>
-- description: 'The ID of the service principal used to authenticate against Azure
-
- Data Explorer. Type: string (or Expression with resultType string).'
- name: service_principal_id
- types:
- - <xref:JSON>
-- description: 'The key of the service principal used to authenticate against
-
- Kusto.'
- name: service_principal_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Database name for connection. Type: string (or Expression with resultType
-
- string). Required.'
- name: database
- types:
- - <xref:JSON>
-- description: 'The name or ID of the tenant to which the service principal belongs.
- Type: string
-
- (or Expression with resultType string).'
- name: tenant
- types:
- - <xref:JSON>
-- description: The credential reference containing authentication information.
- name: credential
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerSink.yml
deleted file mode 100644
index a2f0cad07ca4..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerSink.yml
+++ /dev/null
@@ -1,134 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureDataExplorerSink
-name: AzureDataExplorerSink
-fullName: azure.synapse.artifacts.models.AzureDataExplorerSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Azure Data Explorer sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureDataExplorerSink(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, write_batch_size: MutableMapping[str, Any] | None = None,
- write_batch_timeout: MutableMapping[str, Any] | None = None, sink_retry_count:
- MutableMapping[str, Any] | None = None, sink_retry_wait: MutableMapping[str, Any]
- | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None,
- ingestion_mapping_name: MutableMapping[str, Any] | None = None, ingestion_mapping_as_json:
- MutableMapping[str, Any] | None = None, flush_immediately: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: ingestion_mapping_name
- description: 'A name of a pre-created csv mapping that was defined on the
-
- target Kusto table. Type: string.'
- types:
- - <xref:JSON>
- - name: ingestion_mapping_as_json
- description: 'An explicit column mapping description provided in a json
-
- format. Type: string.'
- types:
- - <xref:JSON>
- - name: flush_immediately
- description: 'If set to true, any aggregation will be skipped. Default is false.
-
- Type: boolean.'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'A name of a pre-created csv mapping that was defined on the
-
- target Kusto table. Type: string.'
- name: ingestion_mapping_name
- types:
- - <xref:JSON>
-- description: 'An explicit column mapping description provided in a json
-
- format. Type: string.'
- name: ingestion_mapping_as_json
- types:
- - <xref:JSON>
-- description: 'If set to true, any aggregation will be skipped. Default is false.
-
- Type: boolean.'
- name: flush_immediately
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerSource.yml
deleted file mode 100644
index a5b10cfad466..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerSource.yml
+++ /dev/null
@@ -1,126 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureDataExplorerSource
-name: AzureDataExplorerSource
-fullName: azure.synapse.artifacts.models.AzureDataExplorerSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity Azure Data Explorer (Kusto) source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureDataExplorerSource(*, query: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, source_retry_count: MutableMapping[str,
- Any] | None = None, source_retry_wait: MutableMapping[str, Any] | None = None,
- max_concurrent_connections: MutableMapping[str, Any] | None = None, no_truncation:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query
- description: 'Database query. Should be a Kusto Query Language (KQL) query. Type:
- string (or
-
- Expression with resultType string). Required.'
- types:
- - <xref:JSON>
- - name: no_truncation
- description: 'The name of the Boolean option that controls whether truncation
- is
-
- applied to result-sets that go beyond a certain row-count limit.'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9]))..'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Database query. Should be a Kusto Query Language (KQL) query. Type:
- string (or
-
- Expression with resultType string). Required.'
- name: query
- types:
- - <xref:JSON>
-- description: 'The name of the Boolean option that controls whether truncation is
- applied
-
- to result-sets that go beyond a certain row-count limit.'
- name: no_truncation
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9]))..'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerTableDataset.yml
index e2a4e7515fb0..73a0dac818e6 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerTableDataset.yml
@@ -10,54 +10,66 @@ 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: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table: MutableMapping[str, Any] | None =
- None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table
@@ -65,60 +77,6 @@ constructor:
(or Expression
with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name of the Azure Data Explorer database. Type: string (or
- Expression
-
- with resultType string).'
- name: table
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService.yml
index d19ebed008b8..d5cae8059931 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService.yml
@@ -10,167 +10,104 @@ summary: 'Azure Data Lake Analytics linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzureDataLakeAnalyticsLinkedService(*, account_name: MutableMapping[str,
- Any], tenant: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, service_principal_id:
- MutableMapping[str, Any] | None = None, service_principal_key: _models.SecretBase
- | None = None, subscription_id: MutableMapping[str, Any] | None = None, resource_group_name:
- MutableMapping[str, Any] | None = None, data_lake_analytics_uri: MutableMapping[str,
- Any] | None = None, encrypted_credential: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: account_name
- description: 'The Azure Data Lake Analytics account name. Type: string (or Expression
+ description: 'Required. The Azure Data Lake Analytics account name. Type: string
+ (or
- with resultType string). Required.'
+ Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_key
- description: 'The Key of the application used to authenticate against the
+ description: 'The Key of the application used to authenticate against the Azure
- Azure Data Lake Analytics account.'
+ Data Lake Analytics account.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: tenant
- description: 'The name or ID of the tenant to which the service principal belongs.
- Type:
+ description: 'Required. The name or ID of the tenant to which the service principal
+ belongs.
- string (or Expression with resultType string). Required.'
+ Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: resource_group_name
- description: 'Data Lake Analytics account resource group name (if different
+ description: 'Data Lake Analytics account resource group name (if different from
- from Data Factory account). Type: string (or Expression with resultType string).'
+ Data Factory account). Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: data_lake_analytics_uri
- description: 'Azure Data Lake Analytics URI Type: string (or Expression
+ description: 'Azure Data Lake Analytics URI Type: string (or Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The Azure Data Lake Analytics account name. Type: string (or Expression
-
- with resultType string). Required.'
- name: account_name
- types:
- - <xref:JSON>
-- description: 'The ID of the application used to authenticate against the Azure
-
- Data Lake Analytics account. Type: string (or Expression with resultType string).'
- name: service_principal_id
- types:
- - <xref:JSON>
-- description: 'The Key of the application used to authenticate against the Azure
-
- Data Lake Analytics account.'
- name: service_principal_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The name or ID of the tenant to which the service principal belongs.
- Type: string
-
- (or Expression with resultType string). Required.'
- name: tenant
- types:
- - <xref:JSON>
-- description: 'Data Lake Analytics account subscription ID (if different from Data
-
- Factory account). Type: string (or Expression with resultType string).'
- name: subscription_id
- types:
- - <xref:JSON>
-- description: 'Data Lake Analytics account resource group name (if different from
-
- Data Factory account). Type: string (or Expression with resultType string).'
- name: resource_group_name
- types:
- - <xref:JSON>
-- description: 'Azure Data Lake Analytics URI Type: string (or Expression with
-
- resultType string).'
- name: data_lake_analytics_uri
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreDataset.yml
deleted file mode 100644
index 33b2727eefac..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreDataset.yml
+++ /dev/null
@@ -1,161 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureDataLakeStoreDataset
-name: AzureDataLakeStoreDataset
-fullName: azure.synapse.artifacts.models.AzureDataLakeStoreDataset
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.Dataset
-summary: 'Azure Data Lake Store dataset.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureDataLakeStoreDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, folder_path: MutableMapping[str, Any] | None
- = None, file_name: MutableMapping[str, Any] | None = None, format: _models.DatasetStorageFormat
- | None = None, compression: _models.DatasetCompression | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Dataset description.
- types:
- - <xref:str>
- - name: structure
- description: 'Columns that define the structure of the dataset. Type: array (or
-
- Expression with resultType array), itemType: DatasetDataElement.'
- types:
- - <xref:JSON>
- - name: schema
- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- types:
- - <xref:JSON>
- - name: linked_service_name
- description: Linked service reference. Required.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: parameters
- description: Parameters for dataset.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the Dataset.
- types:
- - <xref:list>[<xref:JSON>]
- - name: folder
- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
-
- the root level.'
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
- - name: folder_path
- description: 'Path to the folder in the Azure Data Lake Store. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: file_name
- description: 'The name of the file in the Azure Data Lake Store. Type: string
- (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: format
- description: The format of the Data Lake Store.
- types:
- - <xref:azure.synapse.artifacts.models.DatasetStorageFormat>
- - name: compression
- description: 'The data compression method used for the item(s) in the Azure Data
- Lake
-
- Store.'
- types:
- - <xref:azure.synapse.artifacts.models.DatasetCompression>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'Path to the folder in the Azure Data Lake Store. Type: string (or
- Expression
-
- with resultType string).'
- name: folder_path
- types:
- - <xref:JSON>
-- description: 'The name of the file in the Azure Data Lake Store. Type: string (or
- Expression
-
- with resultType string).'
- name: file_name
- types:
- - <xref:JSON>
-- description: The format of the Data Lake Store.
- name: format
- types:
- - <xref:azure.synapse.artifacts.models.DatasetStorageFormat>
-- description: 'The data compression method used for the item(s) in the Azure Data
- Lake
-
- Store.'
- name: compression
- types:
- - <xref:azure.synapse.artifacts.models.DatasetCompression>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService.yml
index 71766f795cb8..b6d1d4341db3 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService.yml
@@ -10,57 +10,66 @@ 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: MutableMapping[str,
- Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- connect_via: _models.IntegrationRuntimeReference | None = None, description: str
- | None = None, parameters: Dict[str, _models.ParameterSpecification] | None =
- None, annotations: List[MutableMapping[str, Any]] | None = None, service_principal_id:
- MutableMapping[str, Any] | None = None, service_principal_key: _models.SecretBase
- | None = None, tenant: MutableMapping[str, Any] | None = None, azure_cloud_type:
- MutableMapping[str, Any] | None = None, account_name: MutableMapping[str, Any]
- | None = None, subscription_id: MutableMapping[str, Any] | None = None, resource_group_name:
- MutableMapping[str, Any] | None = None, encrypted_credential: MutableMapping[str,
- Any] | None = None, credential: _models.CredentialReference | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: data_lake_store_uri
- description: 'Data Lake Store service URI. Type: string (or Expression with
+ description: 'Required. Data Lake Store service URI. Type: string (or Expression
- resultType string). Required.'
+ with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_key
- description: 'The Key of the application used to authenticate against the
+ description: 'The Key of the application used to authenticate against the Azure
- Azure Data Lake Store account.'
+ Data Lake Store account.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: tenant
@@ -68,138 +77,38 @@ constructor:
Type:
string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
- - name: azure_cloud_type
- description: 'Indicates the azure cloud type of the service principle auth.
-
- Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany.
- Default value is
-
- the data factory regions'' cloud type. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
+ - <xref:object>
- name: account_name
- description: 'Data Lake Store account name. Type: string (or Expression with
+ description: 'Data Lake Store account name. Type: string (or Expression with resultType
- resultType string).'
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: subscription_id
description: 'Data Lake Store account subscription ID (if different from Data
+ Factory
- Factory account). Type: string (or Expression with resultType string).'
+ account). Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: resource_group_name
- description: 'Data Lake Store account resource group name (if different from
+ description: 'Data Lake Store account resource group name (if different from Data
- Data Factory account). Type: string (or Expression with resultType string).'
+ Factory account). Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
- types:
- - <xref:JSON>
- - name: credential
- description: The credential reference containing authentication information.
+ resultType string).'
+ isRequired: true
types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Data Lake Store service URI. Type: string (or Expression with
-
- resultType string). Required.'
- name: data_lake_store_uri
- types:
- - <xref:JSON>
-- description: 'The ID of the application used to authenticate against the Azure
-
- Data Lake Store account. Type: string (or Expression with resultType string).'
- name: service_principal_id
- types:
- - <xref:JSON>
-- description: 'The Key of the application used to authenticate against the Azure
-
- Data Lake Store account.'
- name: service_principal_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The name or ID of the tenant to which the service principal belongs.
- Type: string
-
- (or Expression with resultType string).'
- name: tenant
- types:
- - <xref:JSON>
-- description: 'Indicates the azure cloud type of the service principle auth. Allowed
-
- values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value
- is the data
-
- factory regions'' cloud type. Type: string (or Expression with resultType string).'
- name: azure_cloud_type
- types:
- - <xref:JSON>
-- description: 'Data Lake Store account name. Type: string (or Expression with resultType
-
- string).'
- name: account_name
- types:
- - <xref:JSON>
-- description: 'Data Lake Store account subscription ID (if different from Data Factory
-
- account). Type: string (or Expression with resultType string).'
- name: subscription_id
- types:
- - <xref:JSON>
-- description: 'Data Lake Store account resource group name (if different from Data
-
- Factory account). Type: string (or Expression with resultType string).'
- name: resource_group_name
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
-- description: The credential reference containing authentication information.
- name: credential
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreLocation.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreLocation.yml
deleted file mode 100644
index 330b375e8d62..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreLocation.yml
+++ /dev/null
@@ -1,59 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureDataLakeStoreLocation
-name: AzureDataLakeStoreLocation
-fullName: azure.synapse.artifacts.models.AzureDataLakeStoreLocation
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.DatasetLocation
-summary: 'The location of azure data lake store dataset.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureDataLakeStoreLocation(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, folder_path: MutableMapping[str, Any] | None = None, file_name:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: folder_path
- description: 'Specify the folder path of dataset. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: file_name
- description: 'Specify the file name of dataset. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset storage location. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Specify the folder path of dataset. Type: string (or Expression with
-
- resultType string).'
- name: folder_path
- types:
- - <xref:JSON>
-- description: 'Specify the file name of dataset. Type: string (or Expression with
- resultType
-
- string).'
- name: file_name
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreReadSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreReadSettings.yml
deleted file mode 100644
index 2cd630a6659b..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreReadSettings.yml
+++ /dev/null
@@ -1,206 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureDataLakeStoreReadSettings
-name: AzureDataLakeStoreReadSettings
-fullName: azure.synapse.artifacts.models.AzureDataLakeStoreReadSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.StoreReadSettings
-summary: 'Azure data lake store read settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureDataLakeStoreReadSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None
- = None, recursive: MutableMapping[str, Any] | None = None, wildcard_folder_path:
- MutableMapping[str, Any] | None = None, wildcard_file_name: MutableMapping[str,
- Any] | None = None, file_list_path: MutableMapping[str, Any] | None = None, list_after:
- MutableMapping[str, Any] | None = None, list_before: MutableMapping[str, Any]
- | None = None, enable_partition_discovery: MutableMapping[str, Any] | None = None,
- partition_root_path: MutableMapping[str, Any] | None = None, delete_files_after_completion:
- MutableMapping[str, Any] | None = None, modified_datetime_start: MutableMapping[str,
- Any] | None = None, modified_datetime_end: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: recursive
- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: wildcard_folder_path
- description: 'ADLS wildcardFolderPath. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: wildcard_file_name
- description: 'ADLS wildcardFileName. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: file_list_path
- description: 'Point to a text file that lists each file (relative path to the
- path
-
- configured in the dataset) that you want to copy. Type: string (or Expression
- with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: list_after
- description: 'Lists files after the value (exclusive) based on file/folder names''
-
- lexicographical order. Applies under the folderPath in data set, and filter
- files/sub-folders
-
- under the folderPath. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: list_before
- description: 'Lists files before the value (inclusive) based on file/folder names''
-
- lexicographical order. Applies under the folderPath in data set, and filter
- files/sub-folders
-
- under the folderPath. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: enable_partition_discovery
- description: 'Indicates whether to enable partition discovery. Type:
-
- boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: partition_root_path
- description: 'Specify the root path where partition discovery starts from.
-
- Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: delete_files_after_completion
- description: 'Indicates whether the source files need to be deleted
-
- after copy completion. Default is false. Type: boolean (or Expression with resultType
- boolean).'
- types:
- - <xref:JSON>
- - name: modified_datetime_start
- description: 'The start of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: modified_datetime_end
- description: 'The end of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The read setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- name: recursive
- types:
- - <xref:JSON>
-- description: 'ADLS wildcardFolderPath. Type: string (or Expression with
-
- resultType string).'
- name: wildcard_folder_path
- types:
- - <xref:JSON>
-- description: 'ADLS wildcardFileName. Type: string (or Expression with resultType
-
- string).'
- name: wildcard_file_name
- types:
- - <xref:JSON>
-- description: 'Point to a text file that lists each file (relative path to the path
-
- configured in the dataset) that you want to copy. Type: string (or Expression
- with resultType
-
- string).'
- name: file_list_path
- types:
- - <xref:JSON>
-- description: 'Lists files after the value (exclusive) based on file/folder names''
-
- lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders
-
- under the folderPath. Type: string (or Expression with resultType string).'
- name: list_after
- types:
- - <xref:JSON>
-- description: 'Lists files before the value (inclusive) based on file/folder names''
-
- lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders
-
- under the folderPath. Type: string (or Expression with resultType string).'
- name: list_before
- types:
- - <xref:JSON>
-- description: 'Indicates whether to enable partition discovery. Type:
-
- boolean (or Expression with resultType boolean).'
- name: enable_partition_discovery
- types:
- - <xref:JSON>
-- description: 'Specify the root path where partition discovery starts from. Type:
-
- string (or Expression with resultType string).'
- name: partition_root_path
- types:
- - <xref:JSON>
-- description: 'Indicates whether the source files need to be deleted
-
- after copy completion. Default is false. Type: boolean (or Expression with resultType
- boolean).'
- name: delete_files_after_completion
- types:
- - <xref:JSON>
-- description: 'The start of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- name: modified_datetime_start
- types:
- - <xref:JSON>
-- description: 'The end of file''s modified datetime. Type: string (or Expression
-
- with resultType string).'
- name: modified_datetime_end
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreSink.yml
deleted file mode 100644
index b46d86c5d573..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreSink.yml
+++ /dev/null
@@ -1,118 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureDataLakeStoreSink
-name: AzureDataLakeStoreSink
-fullName: azure.synapse.artifacts.models.AzureDataLakeStoreSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Azure Data Lake Store sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureDataLakeStoreSink(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, write_batch_size: MutableMapping[str, Any] | None = None,
- write_batch_timeout: MutableMapping[str, Any] | None = None, sink_retry_count:
- MutableMapping[str, Any] | None = None, sink_retry_wait: MutableMapping[str, Any]
- | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None,
- copy_behavior: MutableMapping[str, Any] | None = None, enable_adls_single_file_parallel:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: copy_behavior
- description: 'The type of copy behavior for copy sink. Type: string (or Expression
-
- with resultType string).'
- types:
- - <xref:JSON>
- - name: enable_adls_single_file_parallel
- description: Single File Parallel.
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'The type of copy behavior for copy sink. Type: string (or Expression
- with
-
- resultType string).'
- name: copy_behavior
- types:
- - <xref:JSON>
-- description: Single File Parallel.
- name: enable_adls_single_file_parallel
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreSource.yml
deleted file mode 100644
index 40a3c288890d..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreSource.yml
+++ /dev/null
@@ -1,85 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureDataLakeStoreSource
-name: AzureDataLakeStoreSource
-fullName: azure.synapse.artifacts.models.AzureDataLakeStoreSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity Azure Data Lake source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureDataLakeStoreSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, recursive: MutableMapping[str, Any] |
- None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: recursive
- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- name: recursive
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreWriteSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreWriteSettings.yml
deleted file mode 100644
index 2967228fc78a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreWriteSettings.yml
+++ /dev/null
@@ -1,73 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureDataLakeStoreWriteSettings
-name: AzureDataLakeStoreWriteSettings
-fullName: azure.synapse.artifacts.models.AzureDataLakeStoreWriteSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.StoreWriteSettings
-summary: 'Azure data lake store write settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureDataLakeStoreWriteSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None
- = None, copy_behavior: MutableMapping[str, Any] | None = None, expiry_date_time:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: copy_behavior
- description: The type of copy behavior for copy sink.
- types:
- - <xref:JSON>
- - name: expiry_date_time
- description: 'Specifies the expiry time of the written files. The time is applied
-
- to the UTC time zone in the format of "2018-12-01T05:00:00Z". Default value
- is NULL. Type:
-
- string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The write setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: The type of copy behavior for copy sink.
- name: copy_behavior
- types:
- - <xref:JSON>
-- description: 'Specifies the expiry time of the written files. The time is applied
- to
-
- the UTC time zone in the format of "2018-12-01T05:00:00Z". Default value is NULL.
- Type: string
-
- (or Expression with resultType string).'
- name: expiry_date_time
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksDeltaLakeDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksDeltaLakeDataset.yml
deleted file mode 100644
index c7aed47cc1e2..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksDeltaLakeDataset.yml
+++ /dev/null
@@ -1,133 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeDataset
-name: AzureDatabricksDeltaLakeDataset
-fullName: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeDataset
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.Dataset
-summary: 'Azure Databricks Delta Lake dataset.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureDatabricksDeltaLakeDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table: MutableMapping[str, Any] | None =
- None, database: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Dataset description.
- types:
- - <xref:str>
- - name: structure
- description: 'Columns that define the structure of the dataset. Type: array (or
-
- Expression with resultType array), itemType: DatasetDataElement.'
- types:
- - <xref:JSON>
- - name: schema
- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- types:
- - <xref:JSON>
- - name: linked_service_name
- description: Linked service reference. Required.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: parameters
- description: Parameters for dataset.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the Dataset.
- types:
- - <xref:list>[<xref:JSON>]
- - name: folder
- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
-
- the root level.'
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
- - name: table
- description: 'The name of delta table. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
- - name: database
- description: 'The database name of delta table. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The name of delta table. Type: string (or Expression with resultType
- string).'
- name: table
- types:
- - <xref:JSON>
-- description: 'The database name of delta table. Type: string (or Expression with
- resultType
-
- string).'
- name: database
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksDeltaLakeExportCommand.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksDeltaLakeExportCommand.yml
deleted file mode 100644
index 6c9365cf87c3..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksDeltaLakeExportCommand.yml
+++ /dev/null
@@ -1,61 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeExportCommand
-name: AzureDatabricksDeltaLakeExportCommand
-fullName: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeExportCommand
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.ExportSettings
-summary: 'Azure Databricks Delta Lake export command settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureDatabricksDeltaLakeExportCommand(*, additional_properties: Dict[str,
- MutableMapping[str, Any]] | None = None, date_format: MutableMapping[str, Any]
- | None = None, timestamp_format: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: date_format
- description: 'Specify the date format for the csv in Azure Databricks Delta Lake
- Copy.
-
- Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: timestamp_format
- description: 'Specify the timestamp format for the csv in Azure Databricks Delta
-
- Lake Copy. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The export setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Specify the date format for the csv in Azure Databricks Delta Lake
- Copy.
-
- Type: string (or Expression with resultType string).'
- name: date_format
- types:
- - <xref:JSON>
-- description: 'Specify the timestamp format for the csv in Azure Databricks Delta
- Lake
-
- Copy. Type: string (or Expression with resultType string).'
- name: timestamp_format
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksDeltaLakeImportCommand.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksDeltaLakeImportCommand.yml
deleted file mode 100644
index 0d7797cc31a1..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksDeltaLakeImportCommand.yml
+++ /dev/null
@@ -1,59 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeImportCommand
-name: AzureDatabricksDeltaLakeImportCommand
-fullName: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeImportCommand
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.ImportSettings
-summary: 'Azure Databricks Delta Lake import command settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureDatabricksDeltaLakeImportCommand(*, additional_properties: Dict[str,
- MutableMapping[str, Any]] | None = None, date_format: MutableMapping[str, Any]
- | None = None, timestamp_format: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: date_format
- description: 'Specify the date format for csv in Azure Databricks Delta Lake Copy.
-
- Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: timestamp_format
- description: 'Specify the timestamp format for csv in Azure Databricks Delta Lake
-
- Copy. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The import setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Specify the date format for csv in Azure Databricks Delta Lake Copy.
- Type:
-
- string (or Expression with resultType string).'
- name: date_format
- types:
- - <xref:JSON>
-- description: 'Specify the timestamp format for csv in Azure Databricks Delta Lake
-
- Copy. Type: string (or Expression with resultType string).'
- name: timestamp_format
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksDeltaLakeLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksDeltaLakeLinkedService.yml
deleted file mode 100644
index 2fc6885cc419..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksDeltaLakeLinkedService.yml
+++ /dev/null
@@ -1,140 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeLinkedService
-name: AzureDatabricksDeltaLakeLinkedService
-fullName: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeLinkedService
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.LinkedService
-summary: 'Azure Databricks Delta Lake linked service.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureDatabricksDeltaLakeLinkedService(*, domain: MutableMapping[str, Any],
- access_token: _models.SecretBase, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, cluster_id:
- MutableMapping[str, Any] | None = None, encrypted_credential: MutableMapping[str,
- Any] | None = None, credential: _models.CredentialReference | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: connect_via
- description: The integration runtime reference.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- - name: description
- description: Linked service description.
- types:
- - <xref:str>
- - name: parameters
- description: Parameters for linked service.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the linked service.
- types:
- - <xref:list>[<xref:JSON>]
- - name: domain
- description: '`<REGION>`.azuredatabricks.net, domain name of your Databricks
-
- deployment. Type: string (or Expression with resultType string). Required.'
- types:
- - <xref:JSON>
- - name: access_token
- description: '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, SecureString or
-
- AzureKeyVaultSecretReference. Required.'
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
- - name: cluster_id
- description: 'The id of an existing interactive cluster that will be used for
- all runs
-
- of this job. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - 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).'
- types:
- - <xref:JSON>
- - name: credential
- description: The credential reference containing authentication information.
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: '`<REGION>`.azuredatabricks.net, domain name of your Databricks deployment.
-
- Type: string (or Expression with resultType string). Required.'
- name: domain
- types:
- - <xref:JSON>
-- description: '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, SecureString or
-
- AzureKeyVaultSecretReference. Required.'
- name: access_token
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The id of an existing interactive cluster that will be used for all
- runs of
-
- this job. Type: string (or Expression with resultType string).'
- name: cluster_id
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
-- description: The credential reference containing authentication information.
- name: credential
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksDeltaLakeSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksDeltaLakeSink.yml
deleted file mode 100644
index 31cafd7b3e12..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksDeltaLakeSink.yml
+++ /dev/null
@@ -1,117 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeSink
-name: AzureDatabricksDeltaLakeSink
-fullName: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Azure Databricks Delta Lake sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureDatabricksDeltaLakeSink(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, write_batch_size: MutableMapping[str, Any] | None = None,
- write_batch_timeout: MutableMapping[str, Any] | None = None, sink_retry_count:
- MutableMapping[str, Any] | None = None, sink_retry_wait: MutableMapping[str, Any]
- | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None,
- pre_copy_script: MutableMapping[str, Any] | None = None, import_settings: _models.AzureDatabricksDeltaLakeImportCommand
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: pre_copy_script
- description: 'SQL pre-copy script. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: import_settings
- description: Azure Databricks Delta Lake import settings.
- types:
- - <xref:azure.synapse.artifacts.models.AzureDatabricksDeltaLakeImportCommand>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'SQL pre-copy script. Type: string (or Expression with resultType
-
- string).'
- name: pre_copy_script
- types:
- - <xref:JSON>
-- description: Azure Databricks Delta Lake import settings.
- name: import_settings
- types:
- - <xref:azure.synapse.artifacts.models.AzureDatabricksDeltaLakeImportCommand>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksDeltaLakeSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksDeltaLakeSource.yml
deleted file mode 100644
index 9d9a482eb487..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksDeltaLakeSource.yml
+++ /dev/null
@@ -1,94 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeSource
-name: AzureDatabricksDeltaLakeSource
-fullName: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity Azure Databricks Delta Lake source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureDatabricksDeltaLakeSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, export_settings: _models.AzureDatabricksDeltaLakeExportCommand | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query
- description: 'Azure Databricks Delta Lake Sql query. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: export_settings
- description: Azure Databricks Delta Lake export settings.
- types:
- - <xref:azure.synapse.artifacts.models.AzureDatabricksDeltaLakeExportCommand>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Azure Databricks Delta Lake Sql query. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
-- description: Azure Databricks Delta Lake export settings.
- name: export_settings
- types:
- - <xref:azure.synapse.artifacts.models.AzureDatabricksDeltaLakeExportCommand>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksLinkedService.yml
index 83e6b80013d1..b45d11e5e721 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksLinkedService.yml
@@ -10,86 +10,83 @@ summary: 'Azure Databricks linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzureDatabricksLinkedService(*, domain: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, access_token:
- _models.SecretBase | None = None, authentication: MutableMapping[str, Any] | None
- = None, workspace_resource_id: MutableMapping[str, Any] | None = None, existing_cluster_id:
- MutableMapping[str, Any] | None = None, instance_pool_id: MutableMapping[str,
- Any] | None = None, new_cluster_version: MutableMapping[str, Any] | None = None,
- new_cluster_num_of_worker: MutableMapping[str, Any] | None = None, new_cluster_node_type:
- MutableMapping[str, Any] | None = None, new_cluster_spark_conf: Dict[str, MutableMapping[str,
- Any]] | None = None, new_cluster_spark_env_vars: Dict[str, MutableMapping[str,
- Any]] | None = None, new_cluster_custom_tags: Dict[str, MutableMapping[str, Any]]
- | None = None, new_cluster_log_destination: MutableMapping[str, Any] | None =
- None, new_cluster_driver_node_type: MutableMapping[str, Any] | None = None, new_cluster_init_scripts:
- MutableMapping[str, Any] | None = None, new_cluster_enable_elastic_disk: MutableMapping[str,
- Any] | None = None, encrypted_credential: MutableMapping[str, Any] | None = None,
- policy_id: MutableMapping[str, Any] | None = None, credential: _models.CredentialReference
- | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: domain
- description: '`<REGION>`.azuredatabricks.net, domain name of your Databricks
+ description: 'Required. `<REGION>`.azuredatabricks.net, domain name of your Databricks
- deployment. Type: string (or Expression with resultType string). Required.'
+ deployment. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: access_token
- description: 'Access token for databricks REST API. Refer to
+ 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:
- <xref:azure.synapse.artifacts.models.SecretBase>
- - name: authentication
- description: 'Required to specify MSI, if using Workspace resource id for databricks
-
- REST API. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: workspace_resource_id
- description: 'Workspace resource id for databricks REST API. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- name: existing_cluster_id
description: 'The id of an existing interactive cluster that will be used for
+ all
- all runs of this activity. Type: string (or Expression with resultType string).'
+ runs of this activity. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: instance_pool_id
description: 'The id of an existing instance pool that will be used for all runs
+ of
- of this activity. Type: string (or Expression with resultType string).'
+ this activity. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: new_cluster_version
description: 'If not using an existing interactive cluster, this specifies the
@@ -100,26 +97,28 @@ constructor:
with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: new_cluster_num_of_worker
- description: 'If not using an existing interactive cluster, this
+ description: 'If not using an existing interactive cluster, this specifies
- specifies the number of worker nodes to use for the new job cluster or instance
- pool. For new
+ the number of worker nodes to use for the new job cluster or instance pool.
+ For new job
- job clusters, this a string-formatted Int32, like ''1'' means numOfWorker is
- 1 or ''1:10'' means
+ clusters, this a string-formatted Int32, like ''1'' means numOfWorker is 1 or
+ ''1:10'' means auto-
- auto-scale from 1 (min) to 10 (max). For instance pools, this is a string-formatted
- Int32, and
+ scale from 1 (min) to 10 (max). For instance pools, this is a string-formatted
+ Int32, and can
- can only specify a fixed number of worker nodes, such as ''2''. Required if
- newClusterVersion is
+ 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:
- - <xref:JSON>
+ - <xref:object>
- name: new_cluster_node_type
description: 'The node type of the new job cluster. This property is required
@@ -128,32 +127,30 @@ constructor:
specified, this property is ignored. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: new_cluster_spark_conf
- description: 'A set of optional, user-specified Spark configuration
+ description: 'A set of optional, user-specified Spark configuration key-value
- key-value pairs.'
+ pairs.'
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: new_cluster_spark_env_vars
description: 'A set of optional, user-specified Spark environment
variables key-value pairs.'
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: new_cluster_custom_tags
- description: 'Additional tags for cluster resources. This property is
-
- ignored in instance pool configurations.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: new_cluster_log_destination
- description: 'Specify a location to deliver Spark driver, worker, and
+ description: 'Additional tags for cluster resources. This property is ignored
- event logs. Type: string (or Expression with resultType string).'
+ in instance pool configurations.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: new_cluster_driver_node_type
description: 'The driver node type for the new job cluster. This
@@ -161,14 +158,16 @@ constructor:
with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: new_cluster_init_scripts
- description: 'User-defined initialization scripts for the new cluster.
+ description: 'User-defined initialization scripts for the new cluster. Type:
- Type: array of strings (or Expression with resultType array of strings).'
+ array of strings (or Expression with resultType array of strings).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: new_cluster_enable_elastic_disk
description: 'Enable the elastic disk on the new cluster. This
@@ -176,199 +175,16 @@ constructor:
(elastic
disks are always enabled). Type: boolean (or Expression with resultType boolean).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
-
- with resultType string).'
- types:
- - <xref:JSON>
- - name: policy_id
- description: 'The policy id for limiting the ability to configure clusters based
- on a
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- user defined set of rules. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: credential
- description: The credential reference containing authentication information.
+ resultType string).'
+ isRequired: true
types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: '`<REGION>`.azuredatabricks.net, domain name of your Databricks deployment.
-
- Type: string (or Expression with resultType string). Required.'
- name: domain
- types:
- - <xref:JSON>
-- description: '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).'
- name: access_token
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Required to specify MSI, if using Workspace resource id for databricks
-
- REST API. Type: string (or Expression with resultType string).'
- name: authentication
- types:
- - <xref:JSON>
-- description: 'Workspace resource id for databricks REST API. Type: string (or
-
- Expression with resultType string).'
- name: workspace_resource_id
- types:
- - <xref:JSON>
-- 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).'
- name: existing_cluster_id
- types:
- - <xref:JSON>
-- 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).'
- name: instance_pool_id
- types:
- - <xref:JSON>
-- 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).'
- name: new_cluster_version
- types:
- - <xref:JSON>
-- 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).'
- name: new_cluster_num_of_worker
- types:
- - <xref:JSON>
-- 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).'
- name: new_cluster_node_type
- types:
- - <xref:JSON>
-- description: 'A set of optional, user-specified Spark configuration key-value
-
- pairs.'
- name: new_cluster_spark_conf
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: 'A set of optional, user-specified Spark environment variables
-
- key-value pairs.'
- name: new_cluster_spark_env_vars
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: 'Additional tags for cluster resources. This property is ignored
-
- in instance pool configurations.'
- name: new_cluster_custom_tags
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: 'Specify a location to deliver Spark driver, worker, and
-
- event logs. Type: string (or Expression with resultType string).'
- name: new_cluster_log_destination
- types:
- - <xref:JSON>
-- 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).'
- name: new_cluster_driver_node_type
- types:
- - <xref:JSON>
-- description: 'User-defined initialization scripts for the new cluster. Type:
-
- array of strings (or Expression with resultType array of strings).'
- name: new_cluster_init_scripts
- types:
- - <xref:JSON>
-- 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).'
- name: new_cluster_enable_elastic_disk
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
-- description: 'The policy id for limiting the ability to configure clusters based
- on a user
-
- defined set of rules. Type: string (or Expression with resultType string).'
- name: policy_id
- types:
- - <xref:JSON>
-- description: The credential reference containing authentication information.
- name: credential
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureEntityResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureEntityResource.yml
deleted file mode 100644
index 6558f21bc678..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureEntityResource.yml
+++ /dev/null
@@ -1,36 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureEntityResource
-name: AzureEntityResource
-fullName: azure.synapse.artifacts.models.AzureEntityResource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.Resource
-summary: 'The resource model definition for an Azure Resource Manager resource with
- an etag.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.'
-constructor:
- syntax: 'AzureEntityResource(**kwargs: Any)'
-variables:
-- description: 'Fully qualified resource ID for the resource. Ex -
-
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.'
- name: id
- types:
- - <xref:str>
-- description: The name of the resource.
- name: name
- types:
- - <xref:str>
-- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines"
- or
-
- "Microsoft.Storage/storageAccounts".'
- name: type
- types:
- - <xref:str>
-- description: Resource Etag.
- name: etag
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFileStorageLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFileStorageLinkedService.yml
index 8c3ba026b646..d7e5d1345b6d 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFileStorageLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFileStorageLinkedService.yml
@@ -10,183 +10,72 @@ summary: 'Azure File Storage linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzureFileStorageLinkedService(*, host: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, user_id:
- MutableMapping[str, Any] | None = None, password: _models.SecretBase | None =
- None, connection_string: MutableMapping[str, Any] | None = None, account_key:
- _models.AzureKeyVaultSecretReference | None = None, sas_uri: MutableMapping[str,
- Any] | None = None, sas_token: _models.AzureKeyVaultSecretReference | None = None,
- file_share: MutableMapping[str, Any] | None = None, snapshot: MutableMapping[str,
- Any] | None = None, encrypted_credential: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: host
- description: 'Host name of the server. Type: string (or Expression with resultType
- string).
+ description: 'Required. Host name of the server. Type: string (or Expression with
+ resultType
- Required.'
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: user_id
description: 'User ID to logon the server. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: Password to logon the server.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- - name: connection_string
- description: 'The connection string. It is mutually exclusive with sasUri
-
- property. Type: string, SecureString or AzureKeyVaultSecretReference.'
- types:
- - <xref:JSON>
- - name: account_key
- description: The Azure key vault secret reference of accountKey in connection
- string.
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- - name: sas_uri
- description: 'SAS URI of the Azure File resource. It is mutually exclusive with
-
- connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.'
- types:
- - <xref:JSON>
- - name: sas_token
- description: The Azure key vault secret reference of sasToken in sas uri.
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- - name: file_share
- description: 'The azure file share name. It is required when auth with
-
- accountKey/sasToken. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: snapshot
- description: 'The azure file share snapshot version. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Host name of the server. Type: string (or Expression with resultType
- string).
-
- Required.'
- name: host
- types:
- - <xref:JSON>
-- description: 'User ID to logon the server. Type: string (or Expression with resultType
-
- string).'
- name: user_id
- types:
- - <xref:JSON>
-- description: Password to logon the server.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The connection string. It is mutually exclusive with sasUri property.
-
- Type: string, SecureString or AzureKeyVaultSecretReference.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of accountKey in connection string.
- name: account_key
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'SAS URI of the Azure File resource. It is mutually exclusive with
-
- connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.'
- name: sas_uri
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of sasToken in sas uri.
- name: sas_token
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'The azure file share name. It is required when auth with accountKey/sasToken.
-
- Type: string (or Expression with resultType string).'
- name: file_share
- types:
- - <xref:JSON>
-- description: 'The azure file share snapshot version. Type: string (or Expression
- with
-
- resultType string).'
- name: snapshot
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFileStorageLocation.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFileStorageLocation.yml
deleted file mode 100644
index 89c1b011cf63..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFileStorageLocation.yml
+++ /dev/null
@@ -1,59 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureFileStorageLocation
-name: AzureFileStorageLocation
-fullName: azure.synapse.artifacts.models.AzureFileStorageLocation
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.DatasetLocation
-summary: 'The location of file server dataset.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureFileStorageLocation(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, folder_path: MutableMapping[str, Any] | None = None, file_name:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: folder_path
- description: 'Specify the folder path of dataset. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: file_name
- description: 'Specify the file name of dataset. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset storage location. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Specify the folder path of dataset. Type: string (or Expression with
-
- resultType string).'
- name: folder_path
- types:
- - <xref:JSON>
-- description: 'Specify the file name of dataset. Type: string (or Expression with
- resultType
-
- string).'
- name: file_name
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFileStorageReadSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFileStorageReadSettings.yml
deleted file mode 100644
index d7e6132f6dab..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFileStorageReadSettings.yml
+++ /dev/null
@@ -1,181 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureFileStorageReadSettings
-name: AzureFileStorageReadSettings
-fullName: azure.synapse.artifacts.models.AzureFileStorageReadSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.StoreReadSettings
-summary: 'Azure File Storage read settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureFileStorageReadSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None
- = None, recursive: MutableMapping[str, Any] | None = None, wildcard_folder_path:
- MutableMapping[str, Any] | None = None, wildcard_file_name: MutableMapping[str,
- Any] | None = None, prefix: MutableMapping[str, Any] | None = None, file_list_path:
- MutableMapping[str, Any] | None = None, enable_partition_discovery: bool | None
- = None, partition_root_path: MutableMapping[str, Any] | None = None, delete_files_after_completion:
- MutableMapping[str, Any] | None = None, modified_datetime_start: MutableMapping[str,
- Any] | None = None, modified_datetime_end: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: recursive
- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: wildcard_folder_path
- description: 'Azure File Storage wildcardFolderPath. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: wildcard_file_name
- description: 'Azure File Storage wildcardFileName. Type: string (or Expression
-
- with resultType string).'
- types:
- - <xref:JSON>
- - name: prefix
- description: 'The prefix filter for the Azure File name starting from root path.
- Type:
-
- string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: file_list_path
- description: 'Point to a text file that lists each file (relative path to the
- path
-
- configured in the dataset) that you want to copy. Type: string (or Expression
- with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: enable_partition_discovery
- description: Indicates whether to enable partition discovery.
- types:
- - <xref:bool>
- - name: partition_root_path
- description: 'Specify the root path where partition discovery starts from.
-
- Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: delete_files_after_completion
- description: 'Indicates whether the source files need to be deleted
-
- after copy completion. Default is false. Type: boolean (or Expression with resultType
- boolean).'
- types:
- - <xref:JSON>
- - name: modified_datetime_start
- description: 'The start of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: modified_datetime_end
- description: 'The end of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The read setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- name: recursive
- types:
- - <xref:JSON>
-- description: 'Azure File Storage wildcardFolderPath. Type: string (or Expression
-
- with resultType string).'
- name: wildcard_folder_path
- types:
- - <xref:JSON>
-- description: 'Azure File Storage wildcardFileName. Type: string (or Expression with
-
- resultType string).'
- name: wildcard_file_name
- types:
- - <xref:JSON>
-- description: 'The prefix filter for the Azure File name starting from root path.
- Type: string
-
- (or Expression with resultType string).'
- name: prefix
- types:
- - <xref:JSON>
-- description: 'Point to a text file that lists each file (relative path to the path
-
- configured in the dataset) that you want to copy. Type: string (or Expression
- with resultType
-
- string).'
- name: file_list_path
- types:
- - <xref:JSON>
-- description: Indicates whether to enable partition discovery.
- name: enable_partition_discovery
- types:
- - <xref:bool>
-- description: 'Specify the root path where partition discovery starts from. Type:
-
- string (or Expression with resultType string).'
- name: partition_root_path
- types:
- - <xref:JSON>
-- description: 'Indicates whether the source files need to be deleted
-
- after copy completion. Default is false. Type: boolean (or Expression with resultType
- boolean).'
- name: delete_files_after_completion
- types:
- - <xref:JSON>
-- description: 'The start of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- name: modified_datetime_start
- types:
- - <xref:JSON>
-- description: 'The end of file''s modified datetime. Type: string (or Expression
-
- with resultType string).'
- name: modified_datetime_end
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFileStorageWriteSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFileStorageWriteSettings.yml
deleted file mode 100644
index 353e7b1c3a09..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFileStorageWriteSettings.yml
+++ /dev/null
@@ -1,53 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureFileStorageWriteSettings
-name: AzureFileStorageWriteSettings
-fullName: azure.synapse.artifacts.models.AzureFileStorageWriteSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.StoreWriteSettings
-summary: 'Azure File Storage write settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureFileStorageWriteSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None
- = None, copy_behavior: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: copy_behavior
- description: The type of copy behavior for copy sink.
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The write setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: The type of copy behavior for copy sink.
- name: copy_behavior
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionActivity.yml
index 3cd982c2b943..1c22f59b304b 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionActivity.yml
@@ -10,78 +10,72 @@ summary: 'Azure Function activity.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzureFunctionActivity(*, name: str, method: str | _models.AzureFunctionActivityMethod,
- function_name: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, state: str | _models.ActivityState
- | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None
- = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, linked_service_name: _models.LinkedServiceReference
- | None = None, policy: _models.ActivityPolicy | None = None, headers: MutableMapping[str,
- Any] | None = None, body: MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
- name: method
- description: 'Rest API method for target endpoint. Required. Known values are:
+ description: 'Required. Rest API method for target endpoint. Possible values include:
"GET",
- "POST", "PUT", "DELETE", "OPTIONS", "HEAD", and "TRACE".'
+ "POST", "PUT", "DELETE", "OPTIONS", "HEAD", "TRACE".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.AzureFunctionActivityMethod>
- name: function_name
- description: 'Name of the Function that the Azure Function Activity will call.
- Type:
+ description: 'Required. Name of the Function that the Azure Function Activity
+ will
- string (or Expression with resultType string). Required.'
+ call. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: headers
description: 'Represents the headers that will be sent to the request. For example,
to set
@@ -90,97 +84,15 @@ constructor:
"Content-Type":
"application/json" }. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: 'Rest API method for target endpoint. Required. Known values are: "GET",
- "POST",
-
- "PUT", "DELETE", "OPTIONS", "HEAD", and "TRACE".'
- name: method
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.AzureFunctionActivityMethod>
-- description: 'Name of the Function that the Azure Function Activity will call. Type:
-
- string (or Expression with resultType string). Required.'
- name: function_name
- types:
- - <xref:JSON>
-- 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).'
- name: headers
- types:
- - <xref:JSON>
-- 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).'
- name: body
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionActivityMethod.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionActivityMethod.yml
index bd84c903a380..a7af1502677e 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionActivityMethod.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionActivityMethod.yml
@@ -11,17 +11,17 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionLinkedService.yml
index 7e1aaa022404..72ba4dd02237 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionLinkedService.yml
@@ -10,129 +10,64 @@ summary: 'Azure Function linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzureFunctionLinkedService(*, function_app_url: MutableMapping[str, Any],
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, connect_via:
- _models.IntegrationRuntimeReference | None = None, description: str | None = None,
- parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations:
- List[MutableMapping[str, Any]] | None = None, function_key: _models.SecretBase
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, credential:
- _models.CredentialReference | None = None, resource_id: MutableMapping[str, Any]
- | None = None, authentication: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: function_app_url
- description: 'The endpoint of the Azure Function App. URL will be in the format
+ description: 'Required. The endpoint of the Azure Function App. URL will be in
+ the
- [https://](https://)`<accountName>`.azurewebsites.net. Required.'
+ format [https://](https://)`<accountName>`.azurewebsites.net.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: function_key
description: Function or Host key for Azure Function App.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
-
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ description: 'The encrypted credential used for authentication. Credentials are
- with resultType string).'
- types:
- - <xref:JSON>
- - name: credential
- description: The credential reference containing authentication information.
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
- - name: resource_id
- description: Allowed token audiences for azure function.
- types:
- - <xref:JSON>
- - name: authentication
- description: 'Type of authentication (Required to specify MSI) used to connect
- to
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- AzureFunction. Type: string (or Expression with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The endpoint of the Azure Function App. URL will be in the format
-
- [https://](https://)`<accountName>`.azurewebsites.net. Required.'
- name: function_app_url
- types:
- - <xref:JSON>
-- description: Function or Host key for Azure Function App.
- name: function_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
-- description: The credential reference containing authentication information.
- name: credential
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
-- description: Allowed token audiences for azure function.
- name: resource_id
- types:
- - <xref:JSON>
-- description: 'Type of authentication (Required to specify MSI) used to connect to
-
- AzureFunction. Type: string (or Expression with resultType string).'
- name: authentication
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultLinkedService.yml
index 3ec0a866e894..1f33deac55e0 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultLinkedService.yml
@@ -10,79 +10,48 @@ summary: 'Azure Key Vault linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzureKeyVaultLinkedService(*, base_url: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, credential:
- _models.CredentialReference | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: base_url
- description: 'The base URL of the Azure Key Vault. e.g. [https://myakv.vault.azure.net](https://myakv.vault.azure.net)
+ description: 'Required. The base URL of the Azure Key Vault. e.g.
- Type: string (or Expression with resultType string). Required.'
- types:
- - <xref:JSON>
- - name: credential
- description: The credential reference containing authentication information.
+ [https://myakv.vault.azure.net](https://myakv.vault.azure.net) Type: string
+ (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: '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). Required.'
- name: base_url
- types:
- - <xref:JSON>
-- description: The credential reference containing authentication information.
- name: credential
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultSecretReference.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultSecretReference.yml
index fac5b2530cd3..daccd2b32efc 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultSecretReference.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultSecretReference.yml
@@ -10,47 +10,32 @@ summary: 'Azure Key Vault secret reference.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzureKeyVaultSecretReference(*, store: _models.LinkedServiceReference,
- secret_name: MutableMapping[str, Any], secret_version: MutableMapping[str, Any]
- | None = None, **kwargs: Any)'
+ 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:
+ - <xref:str>
- name: store
- description: The Azure Key Vault linked service reference. Required.
+ description: Required. The Azure Key Vault linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: secret_name
- description: 'The name of the secret in Azure Key Vault. Type: string (or Expression
+ description: 'Required. The name of the secret in Azure Key Vault. Type: string
+ (or
- with resultType string). Required.'
+ Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
-variables:
-- description: Type of the secret. Required.
- name: type
- types:
- - <xref:str>
-- description: The Azure Key Vault linked service reference. Required.
- name: store
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: 'The name of the secret in Azure Key Vault. Type: string (or Expression
- with
-
- resultType string). Required.'
- name: secret_name
- types:
- - <xref:JSON>
-- 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).'
- name: secret_version
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLBatchExecutionActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLBatchExecutionActivity.yml
index 1c2348b3db55..35d2c15b2556 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLBatchExecutionActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLBatchExecutionActivity.yml
@@ -11,75 +11,68 @@ 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,
- MutableMapping[str, Any]] | None = None, description: str | None = None, state:
- str | _models.ActivityState | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs
- | None = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, linked_service_name: _models.LinkedServiceReference
- | None = None, policy: _models.ActivityPolicy | None = None, global_parameters:
- Dict[str, MutableMapping[str, Any]] | None = None, web_service_outputs: Dict[str,
- _models.AzureMLWebServiceFile] | None = None, web_service_inputs: Dict[str, _models.AzureMLWebServiceFile]
- | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
- name: global_parameters
- description: 'Key,Value pairs to be passed to the Azure ML Batch Execution
+ description: 'Key,Value pairs to be passed to the Azure ML Batch Execution Service
- Service endpoint. Keys must match the names of web service parameters defined
- in the published
+ endpoint. Keys must match the names of web service parameters defined in the
+ published Azure ML
- Azure ML web service. Values will be passed in the GlobalParameters property
- of the Azure ML
+ web service. Values will be passed in the GlobalParameters property of the Azure
+ ML batch
- batch execution request.'
+ execution request.'
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: web_service_outputs
description: 'Key,Value pairs, mapping the names of Azure ML endpoint''s Web
@@ -90,6 +83,7 @@ constructor:
batch execution
request.'
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.AzureMLWebServiceFile>]
- name: web_service_inputs
@@ -102,92 +96,6 @@ constructor:
batch execution
request.'
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.AzureMLWebServiceFile>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- 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.'
- name: global_parameters
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- 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.'
- name: web_service_outputs
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.AzureMLWebServiceFile>]
-- 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.'
- name: web_service_inputs
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.AzureMLWebServiceFile>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLExecutePipelineActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLExecutePipelineActivity.yml
index 677bd21bd3e1..36fa2486e6f0 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLExecutePipelineActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLExecutePipelineActivity.yml
@@ -10,102 +10,97 @@ 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: MutableMapping[str,
- Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- description: str | None = None, state: str | _models.ActivityState | None = None,
- on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None = None, depends_on:
- List[_models.ActivityDependency] | None = None, user_properties: List[_models.UserProperty]
- | None = None, linked_service_name: _models.LinkedServiceReference | None = None,
- policy: _models.ActivityPolicy | None = None, experiment_name: MutableMapping[str,
- Any] | None = None, ml_pipeline_parameters: MutableMapping[str, Any] | None =
- None, ml_parent_run_id: MutableMapping[str, Any] | None = None, continue_on_step_failure:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
- name: ml_pipeline_id
- description: 'ID of the published Azure ML pipeline. Type: string (or Expression
+ description: 'Required. ID of the published Azure ML pipeline. Type: string (or
- with resultType string). Required.'
+ Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: experiment_name
description: 'Run history experiment name of the pipeline run. This information
+ will
- will be passed in the ExperimentName property of the published pipeline execution
- request.
+ be passed in the ExperimentName property of the published pipeline execution
+ request. Type:
- Type: string (or Expression with resultType string).'
+ string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: ml_pipeline_parameters
- description: 'Key,Value pairs to be passed to the published Azure ML
+ description: 'Key,Value pairs to be passed to the published Azure ML pipeline
- pipeline endpoint. Keys must match the names of pipeline parameters defined
- in the published
+ endpoint. Keys must match the names of pipeline parameters defined in the published
+ pipeline.
- pipeline. Values will be passed in the ParameterAssignments property of the
- published pipeline
+ Values will be passed in the ParameterAssignments property of the published
+ pipeline execution
- execution request. Type: object with key value pairs (or Expression with resultType
- object).'
+ request. Type: object with key value pairs (or Expression with resultType object).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: ml_parent_run_id
description: 'The parent Azure ML Service pipeline run id. This information will
+ be
- be passed in the ParentRunId property of the published pipeline execution request.
+ passed in the ParentRunId property of the published pipeline execution request.
Type: string
(or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: continue_on_step_failure
description: 'Whether to continue execution of other steps in the
@@ -115,107 +110,6 @@ constructor:
with
resultType boolean).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: 'ID of the published Azure ML pipeline. Type: string (or Expression
- with
-
- resultType string). Required.'
- name: ml_pipeline_id
- types:
- - <xref:JSON>
-- 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).'
- name: experiment_name
- types:
- - <xref:JSON>
-- 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).'
- name: ml_pipeline_parameters
- types:
- - <xref:JSON>
-- 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).'
- name: ml_parent_run_id
- types:
- - <xref:JSON>
-- 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).'
- name: continue_on_step_failure
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLLinkedService.yml
index f9f2d9c8c27d..5805947fa8f9 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLLinkedService.yml
@@ -10,56 +10,66 @@ 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: MutableMapping[str, Any], api_key:
- _models.SecretBase, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, connect_via: _models.IntegrationRuntimeReference | None = None,
- description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, update_resource_endpoint:
- MutableMapping[str, Any] | None = None, service_principal_id: MutableMapping[str,
- Any] | None = None, service_principal_key: _models.SecretBase | None = None, tenant:
- MutableMapping[str, Any] | None = None, encrypted_credential: MutableMapping[str,
- Any] | None = None, authentication: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: ml_endpoint
- description: 'The Batch Execution REST URL for an Azure ML Studio Web Service
- endpoint.
+ description: 'Required. The Batch Execution REST URL for an Azure ML Studio Web
+ Service
- Type: string (or Expression with resultType string). Required.'
+ endpoint. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: api_key
- description: The API key for accessing the Azure ML model endpoint. Required.
+ description: Required. The API key for accessing the Azure ML model endpoint.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_id
description: 'The ID of the service principal used to authenticate against the
@@ -67,12 +77,14 @@ constructor:
(or Expression
with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_key
- description: 'The key of the service principal used to authenticate against
+ description: 'The key of the service principal used to authenticate against the
- the ARM-based updateResourceEndpoint of an Azure ML Studio web service.'
+ ARM-based updateResourceEndpoint of an Azure ML Studio web service.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: tenant
@@ -80,101 +92,16 @@ constructor:
Type:
string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
-
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ description: 'The encrypted credential used for authentication. Credentials are
- with resultType string).'
- types:
- - <xref:JSON>
- - name: authentication
- description: 'Type of authentication (Required to specify MSI) used to connect
- to
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- AzureML. Type: string (or Expression with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The Batch Execution REST URL for an Azure ML Studio Web Service endpoint.
-
- Type: string (or Expression with resultType string). Required.'
- name: ml_endpoint
- types:
- - <xref:JSON>
-- description: The API key for accessing the Azure ML model endpoint. Required.
- name: api_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The Update Resource REST URL for an Azure ML Studio Web Service
-
- endpoint. Type: string (or Expression with resultType string).'
- name: update_resource_endpoint
- types:
- - <xref:JSON>
-- 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).'
- name: service_principal_id
- types:
- - <xref:JSON>
-- description: 'The key of the service principal used to authenticate against the
-
- ARM-based updateResourceEndpoint of an Azure ML Studio web service.'
- name: service_principal_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The name or ID of the tenant to which the service principal belongs.
- Type: string
-
- (or Expression with resultType string).'
- name: tenant
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
-- description: 'Type of authentication (Required to specify MSI) used to connect to
-
- AzureML. Type: string (or Expression with resultType string).'
- name: authentication
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLServiceLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLServiceLinkedService.yml
index 0fd1482ab316..f27bb252737c 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLServiceLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLServiceLinkedService.yml
@@ -10,64 +10,68 @@ summary: 'Azure ML Service linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzureMLServiceLinkedService(*, subscription_id: MutableMapping[str, Any],
- resource_group_name: MutableMapping[str, Any], ml_workspace_name: MutableMapping[str,
- Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- connect_via: _models.IntegrationRuntimeReference | None = None, description: str
- | None = None, parameters: Dict[str, _models.ParameterSpecification] | None =
- None, annotations: List[MutableMapping[str, Any]] | None = None, authentication:
- MutableMapping[str, Any] | None = None, service_principal_id: MutableMapping[str,
- Any] | None = None, service_principal_key: _models.SecretBase | None = None, tenant:
- MutableMapping[str, Any] | None = None, encrypted_credential: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: subscription_id
- description: 'Azure ML Service workspace subscription ID. Type: string (or
+ description: 'Required. Azure ML Service workspace subscription ID. Type: string
+ (or
- Expression with resultType string). Required.'
+ Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: resource_group_name
- description: 'Azure ML Service workspace resource group name. Type: string (or
+ description: 'Required. Azure ML Service workspace resource group name. Type:
- Expression with resultType string). Required.'
+ string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: ml_workspace_name
- description: 'Azure ML Service workspace name. Type: string (or Expression with
-
- resultType string). Required.'
- types:
- - <xref:JSON>
- - name: authentication
- description: 'Type of authentication (Required to specify MSI) used to connect
- to
+ description: 'Required. Azure ML Service workspace name. Type: string (or
- AzureML. Type: string (or Expression with resultType string).'
+ Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_id
description: 'The ID of the service principal used to authenticate against the
@@ -75,12 +79,14 @@ constructor:
with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_key
- description: 'The key of the service principal used to authenticate against
+ description: 'The key of the service principal used to authenticate against the
- the endpoint of a published Azure ML Service pipeline.'
+ endpoint of a published Azure ML Service pipeline.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: tenant
@@ -88,96 +94,16 @@ constructor:
Type:
string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Azure ML Service workspace subscription ID. Type: string (or Expression
-
- with resultType string). Required.'
- name: subscription_id
- types:
- - <xref:JSON>
-- description: 'Azure ML Service workspace resource group name. Type: string (or
-
- Expression with resultType string). Required.'
- name: resource_group_name
- types:
- - <xref:JSON>
-- description: 'Azure ML Service workspace name. Type: string (or Expression with
-
- resultType string). Required.'
- name: ml_workspace_name
- types:
- - <xref:JSON>
-- description: 'Type of authentication (Required to specify MSI) used to connect to
-
- AzureML. Type: string (or Expression with resultType string).'
- name: authentication
- types:
- - <xref:JSON>
-- 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).'
- name: service_principal_id
- types:
- - <xref:JSON>
-- description: 'The key of the service principal used to authenticate against the
-
- endpoint of a published Azure ML Service pipeline.'
- name: service_principal_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The name or ID of the tenant to which the service principal belongs.
- Type: string
-
- (or Expression with resultType string).'
- name: tenant
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLUpdateResourceActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLUpdateResourceActivity.yml
index e279fe465ef0..e1e5076f2a97 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLUpdateResourceActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLUpdateResourceActivity.yml
@@ -10,156 +10,76 @@ 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: MutableMapping[str,
- Any], trained_model_linked_service_name: _models.LinkedServiceReference, trained_model_file_path:
- MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, state: str | _models.ActivityState
- | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None
- = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, linked_service_name: _models.LinkedServiceReference
- | None = None, policy: _models.ActivityPolicy | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
- name: trained_model_name
- description: 'Name of the Trained Model module in the Web Service experiment to
+ description: 'Required. Name of the Trained Model module in the Web Service
- be updated. Type: string (or Expression with resultType string). Required.'
+ experiment to be updated. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: trained_model_linked_service_name
- description: 'Name of Azure Storage linked service holding the
+ description: 'Required. Name of Azure Storage linked service
- .ilearner file that will be uploaded by the update operation. Required.'
+ holding the .ilearner file that will be uploaded by the update operation.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: trained_model_file_path
- description: 'The relative file path in trainedModelLinkedService to
+ description: 'Required. The relative file path in trainedModelLinkedService
- represent the .ilearner file that will be uploaded by the update operation. Type:
- string (or
+ to represent the .ilearner file that will be uploaded by the update operation. Type:
+ string
- Expression with resultType string). Required.'
+ (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: 'Name of the Trained Model module in the Web Service experiment to
- be
-
- updated. Type: string (or Expression with resultType string). Required.'
- name: trained_model_name
- types:
- - <xref:JSON>
-- description: 'Name of Azure Storage linked service holding the
-
- .ilearner file that will be uploaded by the update operation. Required.'
- name: trained_model_linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: '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). Required.'
- name: trained_model_file_path
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLWebServiceFile.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLWebServiceFile.yml
index ac745cab7f93..6e0203547479 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLWebServiceFile.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLWebServiceFile.yml
@@ -4,41 +4,28 @@ name: AzureMLWebServiceFile
fullName: azure.synapse.artifacts.models.AzureMLWebServiceFile
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'Azure ML WebService Input/Output file.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzureMLWebServiceFile(*, file_path: MutableMapping[str, Any], linked_service_name:
- _models.LinkedServiceReference, **kwargs: Any)'
+ syntax: 'AzureMLWebServiceFile(*, file_path: object, linked_service_name: LinkedServiceReference,
+ **kwargs)'
parameters:
- name: file_path
- description: 'The relative file path, including container name, in the Azure Blob
- Storage
+ description: 'Required. The relative file path, including container name, in the
+ Azure Blob
- specified by the LinkedService. Type: string (or Expression with resultType
- string). Required.'
+ Storage specified by the LinkedService. Type: string (or Expression with resultType
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: 'Reference to an Azure Storage LinkedService, where Azure ML
+ description: 'Required. Reference to an Azure Storage LinkedService, where Azure
- WebService Input/Output file located. Required.'
+ ML WebService Input/Output file located.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-variables:
-- description: 'The relative file path, including container name, in the Azure Blob
- Storage
-
- specified by the LinkedService. Type: string (or Expression with resultType string).
- Required.'
- name: file_path
- types:
- - <xref:JSON>
-- description: 'Reference to an Azure Storage LinkedService, where Azure ML
-
- WebService Input/Output file located. Required.'
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBLinkedService.yml
index 0112cc3bf2e3..6034e0a39b37 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBLinkedService.yml
@@ -10,98 +10,64 @@ 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, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, connection_string:
- MutableMapping[str, Any] | None = None, pwd: _models.AzureKeyVaultSecretReference
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
description: 'An ODBC connection string. Type: string, SecureString or
AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: pwd
description: The Azure key vault secret reference of password in connection string.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'An ODBC connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of password in connection string.
- name: pwd
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBSource.yml
deleted file mode 100644
index d4bbb545cd9e..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureMariaDBSource
-name: AzureMariaDBSource
-fullName: azure.synapse.artifacts.models.AzureMariaDBSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Azure MariaDB source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureMariaDBSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, query:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBTableDataset.yml
index 3897230d7447..851a48a13b27 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBTableDataset.yml
@@ -10,109 +10,71 @@ summary: 'Azure Database for MariaDB dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzureMariaDBTableDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The table name. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlLinkedService.yml
index 666ce86074e7..455ba33ae6e1 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlLinkedService.yml
@@ -10,98 +10,63 @@ summary: 'Azure MySQL database linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzureMySqlLinkedService(*, connection_string: MutableMapping[str, Any],
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, connect_via:
- _models.IntegrationRuntimeReference | None = None, description: str | None = None,
- parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations:
- List[MutableMapping[str, Any]] | None = None, password: _models.AzureKeyVaultSecretReference
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
- description: 'The connection string. Type: string, SecureString or
+ description: 'Required. The connection string. Type: string, SecureString or
- AzureKeyVaultSecretReference. Required.'
+ AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: The Azure key vault secret reference of password in connection string.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference. Required.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of password in connection string.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlSink.yml
deleted file mode 100644
index aedc5d3a1095..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlSink.yml
+++ /dev/null
@@ -1,108 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureMySqlSink
-name: AzureMySqlSink
-fullName: azure.synapse.artifacts.models.AzureMySqlSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Azure MySql sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureMySqlSink(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, write_batch_size: MutableMapping[str, Any] | None = None,
- write_batch_timeout: MutableMapping[str, Any] | None = None, sink_retry_count:
- MutableMapping[str, Any] | None = None, sink_retry_wait: MutableMapping[str, Any]
- | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None,
- pre_copy_script: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: pre_copy_script
- description: 'A query to execute before starting the copy. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'A query to execute before starting the copy. Type: string (or Expression
-
- with resultType string).'
- name: pre_copy_script
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlSource.yml
deleted file mode 100644
index f458a07db34f..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlSource.yml
+++ /dev/null
@@ -1,105 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureMySqlSource
-name: AzureMySqlSource
-fullName: azure.synapse.artifacts.models.AzureMySqlSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Azure MySQL source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureMySqlSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, query:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'Database query. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'Database query. Type: string (or Expression with resultType string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlTableDataset.yml
index c1949eb8f33f..cd4015cdd1c1 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlTableDataset.yml
@@ -10,54 +10,67 @@ summary: 'The Azure MySQL database dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzureMySqlTableDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, table: MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
@@ -65,73 +78,14 @@ constructor:
with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: table
description: 'The name of Azure MySQL database table. Type: string (or Expression
with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The Azure MySQL database table name. Type: string (or Expression with
-
- resultType string).'
- name: table_name
- types:
- - <xref:JSON>
-- description: 'The name of Azure MySQL database table. Type: string (or Expression
- with
-
- resultType string).'
- name: table
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlLinkedService.yml
index 9de5963907ad..e9a5fd8b79a3 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlLinkedService.yml
@@ -10,98 +10,64 @@ summary: 'Azure PostgreSQL linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzurePostgreSqlLinkedService(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, connection_string:
- MutableMapping[str, Any] | None = None, password: _models.AzureKeyVaultSecretReference
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
description: 'An ODBC connection string. Type: string, SecureString or
AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: The Azure key vault secret reference of password in connection string.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'An ODBC connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of password in connection string.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlSink.yml
deleted file mode 100644
index bbb24ab5e999..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlSink.yml
+++ /dev/null
@@ -1,108 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzurePostgreSqlSink
-name: AzurePostgreSqlSink
-fullName: azure.synapse.artifacts.models.AzurePostgreSqlSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Azure PostgreSQL sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzurePostgreSqlSink(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, write_batch_size: MutableMapping[str, Any] | None = None,
- write_batch_timeout: MutableMapping[str, Any] | None = None, sink_retry_count:
- MutableMapping[str, Any] | None = None, sink_retry_wait: MutableMapping[str, Any]
- | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None,
- pre_copy_script: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: pre_copy_script
- description: 'A query to execute before starting the copy. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'A query to execute before starting the copy. Type: string (or Expression
-
- with resultType string).'
- name: pre_copy_script
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlSource.yml
deleted file mode 100644
index fa71ecdadf9a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzurePostgreSqlSource
-name: AzurePostgreSqlSource
-fullName: azure.synapse.artifacts.models.AzurePostgreSqlSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Azure PostgreSQL source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzurePostgreSqlSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, query:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlTableDataset.yml
index 5fe02bad9c23..32800127c8ec 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlTableDataset.yml
@@ -10,55 +10,68 @@ summary: 'Azure PostgreSQL dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzurePostgreSqlTableDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, table: MutableMapping[str, Any] | None = None, schema_type_properties_schema:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
@@ -66,86 +79,21 @@ constructor:
schema
and table. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: table
description: 'The table name of the Azure PostgreSQL database. Type: string (or
- Expression
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: schema_type_properties_schema
description: 'The schema name of the Azure PostgreSQL database. Type:
string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name of the Azure PostgreSQL database which includes both
- schema
-
- and table. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
-- description: 'The table name of the Azure PostgreSQL database. Type: string (or
- Expression with
-
- resultType string).'
- name: table
- types:
- - <xref:JSON>
-- description: 'The schema name of the Azure PostgreSQL database. Type:
-
- string (or Expression with resultType string).'
- name: schema_type_properties_schema
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureQueueSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureQueueSink.yml
deleted file mode 100644
index 18fd7d6dae02..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureQueueSink.yml
+++ /dev/null
@@ -1,96 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureQueueSink
-name: AzureQueueSink
-fullName: azure.synapse.artifacts.models.AzureQueueSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Azure Queue sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureQueueSink(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, write_batch_size: MutableMapping[str, Any] | None = None,
- write_batch_timeout: MutableMapping[str, Any] | None = None, sink_retry_count:
- MutableMapping[str, Any] | None = None, sink_retry_wait: MutableMapping[str, Any]
- | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchIndexDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchIndexDataset.yml
index 1fa8d6978ec5..aaa3f4cfd667 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchIndexDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchIndexDataset.yml
@@ -10,113 +10,72 @@ summary: 'The Azure Search Index.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzureSearchIndexDataset(*, linked_service_name: _models.LinkedServiceReference,
- index_name: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, structure: MutableMapping[str,
- Any] | None = None, schema: MutableMapping[str, Any] | None = None, parameters:
- Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str,
- Any]] | None = None, folder: _models.DatasetFolder | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: index_name
- description: 'The name of the Azure Search Index. Type: string (or Expression
- with
+ description: 'Required. The name of the Azure Search Index. Type: string (or Expression
- resultType string). Required.'
+ with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The name of the Azure Search Index. Type: string (or Expression with
-
- resultType string). Required.'
- name: index_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchIndexSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchIndexSink.yml
deleted file mode 100644
index 28268ad70969..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchIndexSink.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureSearchIndexSink
-name: AzureSearchIndexSink
-fullName: azure.synapse.artifacts.models.AzureSearchIndexSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Azure Search Index sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureSearchIndexSink(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, write_batch_size: MutableMapping[str, Any] | None = None,
- write_batch_timeout: MutableMapping[str, Any] | None = None, sink_retry_count:
- MutableMapping[str, Any] | None = None, sink_retry_wait: MutableMapping[str, Any]
- | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None,
- write_behavior: str | _models.AzureSearchIndexWriteBehaviorType | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: write_behavior
- description: 'Specify the write behavior when upserting documents into Azure Search
-
- Index. Known values are: "Merge" and "Upload".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.AzureSearchIndexWriteBehaviorType>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Specify the write behavior when upserting documents into Azure Search
-
- Index. Known values are: "Merge" and "Upload".'
- name: write_behavior
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.AzureSearchIndexWriteBehaviorType>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchIndexWriteBehaviorType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchIndexWriteBehaviorType.yml
deleted file mode 100644
index 482d422f7ce4..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchIndexWriteBehaviorType.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.AzureSearchIndexWriteBehaviorType
-name: AzureSearchIndexWriteBehaviorType
-fullName: azure.synapse.artifacts.models.AzureSearchIndexWriteBehaviorType
-summary: Specify the write behavior when upserting documents into Azure Search Index.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: AzureSearchIndexWriteBehaviorType(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: MERGE
- uid: azure.synapse.artifacts.models.AzureSearchIndexWriteBehaviorType.MERGE
-- name: UPLOAD
- uid: azure.synapse.artifacts.models.AzureSearchIndexWriteBehaviorType.UPLOAD
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchLinkedService.yml
index b736f0bddbbe..3bca5eb10459 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchLinkedService.yml
@@ -10,98 +10,64 @@ summary: 'Linked service for Windows Azure Search Service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzureSearchLinkedService(*, url: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, key:
- _models.SecretBase | None = None, encrypted_credential: MutableMapping[str, Any]
- | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: url
- description: 'URL for Azure Search service. Type: string (or Expression with resultType
+ description: 'Required. URL for Azure Search service. Type: string (or Expression
+ with resultType
- string). Required.'
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: key
description: Admin Key for Azure Search service.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'URL for Azure Search service. Type: string (or Expression with resultType
- string).
-
- Required.'
- name: url
- types:
- - <xref:JSON>
-- description: Admin Key for Azure Search service.
- name: key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWLinkedService.yml
index 09f8a1417b2c..12533509b8c9 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWLinkedService.yml
@@ -10,61 +10,70 @@ summary: 'Azure SQL Data Warehouse linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzureSqlDWLinkedService(*, connection_string: MutableMapping[str, Any],
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, connect_via:
- _models.IntegrationRuntimeReference | None = None, description: str | None = None,
- parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations:
- List[MutableMapping[str, Any]] | None = None, password: _models.AzureKeyVaultSecretReference
- | None = None, service_principal_id: MutableMapping[str, Any] | None = None, service_principal_key:
- _models.SecretBase | None = None, tenant: MutableMapping[str, Any] | None = None,
- azure_cloud_type: MutableMapping[str, Any] | None = None, encrypted_credential:
- MutableMapping[str, Any] | None = None, credential: _models.CredentialReference
- | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
- description: 'The connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.
+ description: 'Required. The connection string. Type: string, SecureString or
- Required.'
+ AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: The Azure key vault secret reference of password in connection string.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- name: service_principal_id
- description: 'The ID of the service principal used to authenticate against
+ description: 'The ID of the service principal used to authenticate against Azure
- Azure SQL Data Warehouse. Type: string (or Expression with resultType string).'
+ SQL Data Warehouse. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_key
description: 'The key of the service principal used to authenticate against
Azure SQL Data Warehouse.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: tenant
@@ -72,108 +81,16 @@ constructor:
Type:
string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
- - name: azure_cloud_type
- description: 'Indicates the azure cloud type of the service principle auth.
-
- Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany.
- Default value is
-
- the data factory regions'' cloud type. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
- types:
- - <xref:JSON>
- - name: credential
- description: The credential reference containing authentication information.
+ resultType string).'
+ isRequired: true
types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.
-
- Required.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of password in connection string.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'The ID of the service principal used to authenticate against Azure
-
- SQL Data Warehouse. Type: string (or Expression with resultType string).'
- name: service_principal_id
- types:
- - <xref:JSON>
-- description: 'The key of the service principal used to authenticate against
-
- Azure SQL Data Warehouse.'
- name: service_principal_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The name or ID of the tenant to which the service principal belongs.
- Type: string
-
- (or Expression with resultType string).'
- name: tenant
- types:
- - <xref:JSON>
-- description: 'Indicates the azure cloud type of the service principle auth. Allowed
-
- values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value
- is the data
-
- factory regions'' cloud type. Type: string (or Expression with resultType string).'
- name: azure_cloud_type
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
-- description: The credential reference containing authentication information.
- name: credential
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWTableDataset.yml
index bea2b6cb9fa8..dc0ab06cd64b 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWTableDataset.yml
@@ -10,140 +10,89 @@ 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: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, schema_type_properties_schema: MutableMapping[str, Any] | None = None,
- table: MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'This property will be retired. Please consider using schema + table
properties instead.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: table
description: 'The table name of the Azure SQL Data Warehouse. Type: string (or
- Expression
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'This property will be retired. Please consider using schema + table
-
- properties instead.'
- name: table_name
- types:
- - <xref:JSON>
-- description: 'The schema name of the Azure SQL Data Warehouse. Type:
-
- string (or Expression with resultType string).'
- name: schema_type_properties_schema
- types:
- - <xref:JSON>
-- description: 'The table name of the Azure SQL Data Warehouse. Type: string (or Expression
- with
-
- resultType string).'
- name: table
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService.yml
index d9ed09ce31f5..c704154a4d4d 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService.yml
@@ -10,60 +10,70 @@ summary: 'Microsoft Azure SQL Database linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzureSqlDatabaseLinkedService(*, connection_string: MutableMapping[str,
- Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- connect_via: _models.IntegrationRuntimeReference | None = None, description: str
- | None = None, parameters: Dict[str, _models.ParameterSpecification] | None =
- None, annotations: List[MutableMapping[str, Any]] | None = None, password: _models.AzureKeyVaultSecretReference
- | None = None, service_principal_id: MutableMapping[str, Any] | None = None, service_principal_key:
- _models.SecretBase | None = None, tenant: MutableMapping[str, Any] | None = None,
- azure_cloud_type: MutableMapping[str, Any] | None = None, always_encrypted_settings:
- _models.SqlAlwaysEncryptedProperties | None = None, encrypted_credential: MutableMapping[str,
- Any] | None = None, credential: _models.CredentialReference | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
- description: 'The connection string. Type: string, SecureString or
+ description: 'Required. The connection string. Type: string, SecureString or
- AzureKeyVaultSecretReference. Required.'
+ AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: The Azure key vault secret reference of password in connection string.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- name: service_principal_id
- description: 'The ID of the service principal used to authenticate against
+ description: 'The ID of the service principal used to authenticate against Azure
- Azure SQL Database. Type: string (or Expression with resultType string).'
+ SQL Database. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_key
description: 'The key of the service principal used to authenticate against
Azure SQL Database.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: tenant
@@ -71,114 +81,16 @@ constructor:
Type:
string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
- - name: azure_cloud_type
- description: 'Indicates the azure cloud type of the service principle auth.
-
- Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany.
- Default value is
-
- the data factory regions'' cloud type. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
- - name: always_encrypted_settings
- description: Sql always encrypted properties.
- types:
- - <xref:azure.synapse.artifacts.models.SqlAlwaysEncryptedProperties>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
- - name: credential
- description: The credential reference containing authentication information.
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference. Required.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of password in connection string.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'The ID of the service principal used to authenticate against Azure
-
- SQL Database. Type: string (or Expression with resultType string).'
- name: service_principal_id
- types:
- - <xref:JSON>
-- description: 'The key of the service principal used to authenticate against
-
- Azure SQL Database.'
- name: service_principal_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The name or ID of the tenant to which the service principal belongs.
- Type: string
-
- (or Expression with resultType string).'
- name: tenant
- types:
- - <xref:JSON>
-- description: 'Indicates the azure cloud type of the service principle auth. Allowed
-
- values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value
- is the data
-
- factory regions'' cloud type. Type: string (or Expression with resultType string).'
- name: azure_cloud_type
- types:
- - <xref:JSON>
-- description: Sql always encrypted properties.
- name: always_encrypted_settings
- types:
- - <xref:azure.synapse.artifacts.models.SqlAlwaysEncryptedProperties>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
-- description: The credential reference containing authentication information.
- name: credential
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMILinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMILinkedService.yml
index 0debdbf98ccb..eb3a5adf7ea4 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMILinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMILinkedService.yml
@@ -10,60 +10,70 @@ summary: 'Azure SQL Managed Instance linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzureSqlMILinkedService(*, connection_string: MutableMapping[str, Any],
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, connect_via:
- _models.IntegrationRuntimeReference | None = None, description: str | None = None,
- parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations:
- List[MutableMapping[str, Any]] | None = None, password: _models.AzureKeyVaultSecretReference
- | None = None, service_principal_id: MutableMapping[str, Any] | None = None, service_principal_key:
- _models.SecretBase | None = None, tenant: MutableMapping[str, Any] | None = None,
- azure_cloud_type: MutableMapping[str, Any] | None = None, always_encrypted_settings:
- _models.SqlAlwaysEncryptedProperties | None = None, encrypted_credential: MutableMapping[str,
- Any] | None = None, credential: _models.CredentialReference | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
- description: 'The connection string. Type: string, SecureString or
+ description: 'Required. The connection string. Type: string, SecureString or
- AzureKeyVaultSecretReference. Required.'
+ AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: The Azure key vault secret reference of password in connection string.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- name: service_principal_id
- description: 'The ID of the service principal used to authenticate against
+ description: 'The ID of the service principal used to authenticate against Azure
- Azure SQL Managed Instance. Type: string (or Expression with resultType string).'
+ SQL Managed Instance. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_key
description: 'The key of the service principal used to authenticate against
Azure SQL Managed Instance.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: tenant
@@ -71,114 +81,16 @@ constructor:
Type:
string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
- - name: azure_cloud_type
- description: 'Indicates the azure cloud type of the service principle auth.
-
- Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany.
- Default value is
-
- the data factory regions'' cloud type. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
- - name: always_encrypted_settings
- description: Sql always encrypted properties.
- types:
- - <xref:azure.synapse.artifacts.models.SqlAlwaysEncryptedProperties>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
- - name: credential
- description: The credential reference containing authentication information.
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference. Required.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of password in connection string.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'The ID of the service principal used to authenticate against Azure
-
- SQL Managed Instance. Type: string (or Expression with resultType string).'
- name: service_principal_id
- types:
- - <xref:JSON>
-- description: 'The key of the service principal used to authenticate against
-
- Azure SQL Managed Instance.'
- name: service_principal_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The name or ID of the tenant to which the service principal belongs.
- Type: string
-
- (or Expression with resultType string).'
- name: tenant
- types:
- - <xref:JSON>
-- description: 'Indicates the azure cloud type of the service principle auth. Allowed
-
- values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value
- is the data
-
- factory regions'' cloud type. Type: string (or Expression with resultType string).'
- name: azure_cloud_type
- types:
- - <xref:JSON>
-- description: Sql always encrypted properties.
- name: always_encrypted_settings
- types:
- - <xref:azure.synapse.artifacts.models.SqlAlwaysEncryptedProperties>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
-- description: The credential reference containing authentication information.
- name: credential
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMITableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMITableDataset.yml
index 6455f03148d4..67acd8f8c183 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMITableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMITableDataset.yml
@@ -10,140 +10,89 @@ 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: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, schema_type_properties_schema: MutableMapping[str, Any] | None = None,
- table: MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'This property will be retired. Please consider using schema + table
properties instead.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: schema_type_properties_schema
- description: 'The schema name of the Azure SQL Managed Instance.
+ description: 'The schema name of the Azure SQL Managed Instance. Type:
- Type: string (or Expression with resultType string).'
+ string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: table
description: 'The table name of the Azure SQL Managed Instance dataset. Type:
string (or
Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'This property will be retired. Please consider using schema + table
-
- properties instead.'
- name: table_name
- types:
- - <xref:JSON>
-- description: 'The schema name of the Azure SQL Managed Instance. Type:
-
- string (or Expression with resultType string).'
- name: schema_type_properties_schema
- types:
- - <xref:JSON>
-- description: 'The table name of the Azure SQL Managed Instance dataset. Type: string
- (or
-
- Expression with resultType string).'
- name: table
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlSink.yml
deleted file mode 100644
index 776a7ba56dec..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlSink.yml
+++ /dev/null
@@ -1,170 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureSqlSink
-name: AzureSqlSink
-fullName: azure.synapse.artifacts.models.AzureSqlSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Azure SQL sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureSqlSink(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, write_batch_size: MutableMapping[str, Any] | None = None, write_batch_timeout:
- MutableMapping[str, Any] | None = None, sink_retry_count: MutableMapping[str,
- Any] | None = None, sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, sql_writer_stored_procedure_name: MutableMapping[str,
- Any] | None = None, sql_writer_table_type: MutableMapping[str, Any] | None = None,
- pre_copy_script: MutableMapping[str, Any] | None = None, stored_procedure_parameters:
- Dict[str, _models.StoredProcedureParameter] | None = None, stored_procedure_table_type_parameter_name:
- MutableMapping[str, Any] | None = None, table_option: MutableMapping[str, Any]
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: sql_writer_stored_procedure_name
- description: 'SQL writer stored procedure name. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: sql_writer_table_type
- description: 'SQL writer table type. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: pre_copy_script
- description: 'SQL pre-copy script. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: stored_procedure_parameters
- description: SQL stored procedure parameters.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.StoredProcedureParameter>]
- - name: stored_procedure_table_type_parameter_name
- description: 'The stored procedure parameter name of the
-
- table type. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: table_option
- description: 'The option to handle sink table, such as autoCreate. For now only
-
- ''autoCreate'' value is supported. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'SQL writer stored procedure name. Type: string (or
-
- Expression with resultType string).'
- name: sql_writer_stored_procedure_name
- types:
- - <xref:JSON>
-- description: 'SQL writer table type. Type: string (or Expression with resultType
-
- string).'
- name: sql_writer_table_type
- types:
- - <xref:JSON>
-- description: 'SQL pre-copy script. Type: string (or Expression with resultType
-
- string).'
- name: pre_copy_script
- types:
- - <xref:JSON>
-- description: SQL stored procedure parameters.
- name: stored_procedure_parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.StoredProcedureParameter>]
-- description: 'The stored procedure parameter name of the
-
- table type. Type: string (or Expression with resultType string).'
- name: stored_procedure_table_type_parameter_name
- types:
- - <xref:JSON>
-- description: 'The option to handle sink table, such as autoCreate. For now only
-
- ''autoCreate'' value is supported. Type: string (or Expression with resultType
- string).'
- name: table_option
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlSource.yml
deleted file mode 100644
index d06ac86d61f4..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlSource.yml
+++ /dev/null
@@ -1,188 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureSqlSource
-name: AzureSqlSource
-fullName: azure.synapse.artifacts.models.AzureSqlSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Azure SQL source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureSqlSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, sql_reader_query:
- MutableMapping[str, Any] | None = None, sql_reader_stored_procedure_name: MutableMapping[str,
- Any] | None = None, stored_procedure_parameters: Dict[str, _models.StoredProcedureParameter]
- | None = None, isolation_level: MutableMapping[str, Any] | None = None, produce_additional_types:
- MutableMapping[str, Any] | None = None, partition_option: MutableMapping[str,
- Any] | None = None, partition_settings: _models.SqlPartitionSettings | None =
- None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: sql_reader_query
- description: 'SQL reader query. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: sql_reader_stored_procedure_name
- description: 'Name of the stored procedure for a SQL Database
-
- source. This cannot be used at the same time as SqlReaderQuery. Type: string
- (or Expression
-
- with resultType string).'
- types:
- - <xref:JSON>
- - name: stored_procedure_parameters
- description: 'Value and type setting for stored procedure parameters.
-
- Example: "{Parameter1: {value: "1", type: "int"}}".'
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.StoredProcedureParameter>]
- - name: isolation_level
- description: 'Specifies the transaction locking behavior for the SQL source.
-
- Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot.
- The default
-
- value is ReadCommitted. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: produce_additional_types
- description: Which additional types to produce.
- types:
- - <xref:JSON>
- - name: partition_option
- description: 'The partition mechanism that will be used for Sql read in parallel.
-
- Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".'
- types:
- - <xref:JSON>
- - name: partition_settings
- description: The settings that will be leveraged for Sql source partitioning.
- types:
- - <xref:azure.synapse.artifacts.models.SqlPartitionSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'SQL reader query. Type: string (or Expression with resultType string).'
- name: sql_reader_query
- types:
- - <xref:JSON>
-- description: 'Name of the stored procedure for a SQL Database source.
-
- This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression
- with
-
- resultType string).'
- name: sql_reader_stored_procedure_name
- types:
- - <xref:JSON>
-- description: 'Value and type setting for stored procedure parameters.
-
- Example: "{Parameter1: {value: "1", type: "int"}}".'
- name: stored_procedure_parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.StoredProcedureParameter>]
-- description: 'Specifies the transaction locking behavior for the SQL source. Allowed
-
- values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The
- default value
-
- is ReadCommitted. Type: string (or Expression with resultType string).'
- name: isolation_level
- types:
- - <xref:JSON>
-- description: Which additional types to produce.
- name: produce_additional_types
- types:
- - <xref:JSON>
-- description: 'The partition mechanism that will be used for Sql read in parallel.
-
- Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".'
- name: partition_option
- types:
- - <xref:JSON>
-- description: The settings that will be leveraged for Sql source partitioning.
- name: partition_settings
- types:
- - <xref:azure.synapse.artifacts.models.SqlPartitionSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlTableDataset.yml
index 03b7fbeb7c96..82557b4a8c7b 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlTableDataset.yml
@@ -10,140 +10,88 @@ 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: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, schema_type_properties_schema: MutableMapping[str, Any] | None = None,
- table: MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'This property will be retired. Please consider using schema + table
properties instead.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: schema_type_properties_schema
description: 'The schema name of the Azure SQL database. Type: string
(or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: table
description: 'The table name of the Azure SQL database. Type: string (or Expression
with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'This property will be retired. Please consider using schema + table
-
- properties instead.'
- name: table_name
- types:
- - <xref:JSON>
-- description: 'The schema name of the Azure SQL database. Type: string
-
- (or Expression with resultType string).'
- name: schema_type_properties_schema
- types:
- - <xref:JSON>
-- description: 'The table name of the Azure SQL database. Type: string (or Expression
- with
-
- resultType string).'
- name: table
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureStorageAuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureStorageAuthenticationType.yml
deleted file mode 100644
index fb5173353dea..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureStorageAuthenticationType.yml
+++ /dev/null
@@ -1,23 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.AzureStorageAuthenticationType
-name: AzureStorageAuthenticationType
-fullName: azure.synapse.artifacts.models.AzureStorageAuthenticationType
-summary: 'The type used for authentication. Type: string.'
-module: azure.synapse.artifacts.models
-constructor:
- syntax: AzureStorageAuthenticationType(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: ACCOUNT_KEY
- uid: azure.synapse.artifacts.models.AzureStorageAuthenticationType.ACCOUNT_KEY
-- name: ANONYMOUS
- uid: azure.synapse.artifacts.models.AzureStorageAuthenticationType.ANONYMOUS
-- name: MSI
- uid: azure.synapse.artifacts.models.AzureStorageAuthenticationType.MSI
-- name: SAS_URI
- uid: azure.synapse.artifacts.models.AzureStorageAuthenticationType.SAS_URI
-- name: SERVICE_PRINCIPAL
- uid: azure.synapse.artifacts.models.AzureStorageAuthenticationType.SERVICE_PRINCIPAL
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureStorageLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureStorageLinkedService.yml
index 1cf76fb9d95d..a265fe3ccd1b 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureStorageLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureStorageLinkedService.yml
@@ -10,45 +10,57 @@ 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, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, connection_string:
- MutableMapping[str, Any] | None = None, account_key: _models.AzureKeyVaultSecretReference
- | None = None, sas_uri: MutableMapping[str, Any] | None = None, sas_token: _models.AzureKeyVaultSecretReference
- | None = None, encrypted_credential: str | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
- description: 'The connection string. It is mutually exclusive with sasUri
+ description: 'The connection string. It is mutually exclusive with sasUri property.
- property. Type: string, SecureString or AzureKeyVaultSecretReference.'
+ Type: string, SecureString or AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: account_key
description: The Azure key vault secret reference of accountKey in connection
string.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- name: sas_uri
@@ -56,74 +68,21 @@ constructor:
with
connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: sas_token
description: The Azure key vault secret reference of sasToken in sas uri.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The connection string. It is mutually exclusive with sasUri property.
-
- Type: string, SecureString or AzureKeyVaultSecretReference.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of accountKey in connection string.
- name: account_key
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'SAS URI of the Azure Storage resource. It is mutually exclusive with
-
- connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.'
- name: sas_uri
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of sasToken in sas uri.
- name: sas_token
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSynapseArtifactsLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSynapseArtifactsLinkedService.yml
deleted file mode 100644
index 1a5288c502d0..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSynapseArtifactsLinkedService.yml
+++ /dev/null
@@ -1,114 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureSynapseArtifactsLinkedService
-name: AzureSynapseArtifactsLinkedService
-fullName: azure.synapse.artifacts.models.AzureSynapseArtifactsLinkedService
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.LinkedService
-summary: 'Azure Synapse Analytics (Artifacts) linked service.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureSynapseArtifactsLinkedService(*, endpoint: MutableMapping[str, Any],
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, connect_via:
- _models.IntegrationRuntimeReference | None = None, description: str | None = None,
- parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations:
- List[MutableMapping[str, Any]] | None = None, authentication: MutableMapping[str,
- Any] | None = None, workspace_resource_id: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: connect_via
- description: The integration runtime reference.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- - name: description
- description: Linked service description.
- types:
- - <xref:str>
- - name: parameters
- description: Parameters for linked service.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the linked service.
- types:
- - <xref:list>[<xref:JSON>]
- - name: endpoint
- description: '[https://](https://)`<workspacename>`.dev.azuresynapse.net, Azure
- Synapse
-
- Analytics workspace URL. Type: string (or Expression with resultType string).
- Required.'
- types:
- - <xref:JSON>
- - name: authentication
- description: 'Required to specify MSI, if using system assigned managed identity
- as
-
- authentication method. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: workspace_resource_id
- description: 'The resource ID of the Synapse workspace. The format should be:
-
- /subscriptions/{subscriptionID}/resourceGroups/{resourceGroup}/providers/Microsoft.Synapse/workspaces/{workspaceName}.
-
- Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: '[https://](https://)`<workspacename>`.dev.azuresynapse.net, Azure
- Synapse Analytics
-
- workspace URL. Type: string (or Expression with resultType string). Required.'
- name: endpoint
- types:
- - <xref:JSON>
-- description: 'Required to specify MSI, if using system assigned managed identity
- as
-
- authentication method. Type: string (or Expression with resultType string).'
- name: authentication
- types:
- - <xref:JSON>
-- description: 'The resource ID of the Synapse workspace. The format should be:
-
- /subscriptions/{subscriptionID}/resourceGroups/{resourceGroup}/providers/Microsoft.Synapse/workspaces/{workspaceName}.
-
- Type: string (or Expression with resultType string).'
- name: workspace_resource_id
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableDataset.yml
index 464d005bfc53..6f7cb7cc7e5d 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableDataset.yml
@@ -10,113 +10,73 @@ summary: 'The Azure Table storage dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'AzureTableDataset(*, linked_service_name: _models.LinkedServiceReference,
- table_name: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, structure: MutableMapping[str,
- Any] | None = None, schema: MutableMapping[str, Any] | None = None, parameters:
- Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str,
- Any]] | None = None, folder: _models.DatasetFolder | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
- description: 'The table name of the Azure Table storage. Type: string (or Expression
+ description: 'Required. The table name of the Azure Table storage. Type: string
+ (or
- with resultType string). Required.'
+ Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name of the Azure Table storage. Type: string (or Expression
- with
-
- resultType string). Required.'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableSink.yml
deleted file mode 100644
index 86650e067633..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableSink.yml
+++ /dev/null
@@ -1,147 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureTableSink
-name: AzureTableSink
-fullName: azure.synapse.artifacts.models.AzureTableSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Azure Table sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureTableSink(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, write_batch_size: MutableMapping[str, Any] | None = None,
- write_batch_timeout: MutableMapping[str, Any] | None = None, sink_retry_count:
- MutableMapping[str, Any] | None = None, sink_retry_wait: MutableMapping[str, Any]
- | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None,
- azure_table_default_partition_key_value: MutableMapping[str, Any] | None = None,
- azure_table_partition_key_name: MutableMapping[str, Any] | None = None, azure_table_row_key_name:
- MutableMapping[str, Any] | None = None, azure_table_insert_type: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: azure_table_default_partition_key_value
- description: 'Azure Table default partition key value.
-
- Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: azure_table_partition_key_name
- description: 'Azure Table partition key name. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: azure_table_row_key_name
- description: 'Azure Table row key name. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: azure_table_insert_type
- description: 'Azure Table insert type. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Azure Table default partition key value. Type:
-
- string (or Expression with resultType string).'
- name: azure_table_default_partition_key_value
- types:
- - <xref:JSON>
-- description: 'Azure Table partition key name. Type: string (or
-
- Expression with resultType string).'
- name: azure_table_partition_key_name
- types:
- - <xref:JSON>
-- description: 'Azure Table row key name. Type: string (or Expression with
-
- resultType string).'
- name: azure_table_row_key_name
- types:
- - <xref:JSON>
-- description: 'Azure Table insert type. Type: string (or Expression with
-
- resultType string).'
- name: azure_table_insert_type
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableSource.yml
deleted file mode 100644
index 7431f6bc792f..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableSource.yml
+++ /dev/null
@@ -1,122 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.AzureTableSource
-name: AzureTableSource
-fullName: azure.synapse.artifacts.models.AzureTableSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Azure Table source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'AzureTableSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, azure_table_source_query:
- MutableMapping[str, Any] | None = None, azure_table_source_ignore_table_not_found:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: azure_table_source_query
- description: 'Azure Table source query. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: azure_table_source_ignore_table_not_found
- description: 'Azure Table source ignore table not found.
-
- Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'Azure Table source query. Type: string (or Expression with
-
- resultType string).'
- name: azure_table_source_query
- types:
- - <xref:JSON>
-- description: 'Azure Table source ignore table not found.
-
- Type: boolean (or Expression with resultType boolean).'
- name: azure_table_source_ignore_table_not_found
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableStorageLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableStorageLinkedService.yml
index 32a11d4305d0..7ef5ebb1268f 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableStorageLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableStorageLinkedService.yml
@@ -10,45 +10,57 @@ 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, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, connection_string:
- MutableMapping[str, Any] | None = None, account_key: _models.AzureKeyVaultSecretReference
- | None = None, sas_uri: MutableMapping[str, Any] | None = None, sas_token: _models.AzureKeyVaultSecretReference
- | None = None, encrypted_credential: str | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
- description: 'The connection string. It is mutually exclusive with sasUri
+ description: 'The connection string. It is mutually exclusive with sasUri property.
- property. Type: string, SecureString or AzureKeyVaultSecretReference.'
+ Type: string, SecureString or AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: account_key
description: The Azure key vault secret reference of accountKey in connection
string.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- name: sas_uri
@@ -56,74 +68,21 @@ constructor:
with
connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: sas_token
description: The Azure key vault secret reference of sasToken in sas uri.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The connection string. It is mutually exclusive with sasUri property.
-
- Type: string, SecureString or AzureKeyVaultSecretReference.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of accountKey in connection string.
- name: account_key
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'SAS URI of the Azure Storage resource. It is mutually exclusive with
-
- connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.'
- name: sas_uri
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of sasToken in sas uri.
- name: sas_token
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BigDataPoolParametrizationReference.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BigDataPoolParametrizationReference.yml
deleted file mode 100644
index d4ff768de9c8..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BigDataPoolParametrizationReference.yml
+++ /dev/null
@@ -1,38 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.BigDataPoolParametrizationReference
-name: BigDataPoolParametrizationReference
-fullName: azure.synapse.artifacts.models.BigDataPoolParametrizationReference
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Big data pool reference type.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'BigDataPoolParametrizationReference(*, type: str | _models.BigDataPoolReferenceType,
- reference_name: MutableMapping[str, Any], **kwargs: Any)'
- parameters:
- - name: type
- description: Big data pool reference type. Required. "BigDataPoolReference"
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.BigDataPoolReferenceType>
- - name: reference_name
- description: 'Reference big data pool name. Type: string (or Expression with
-
- resultType string). Required.'
- types:
- - <xref:JSON>
-variables:
-- description: Big data pool reference type. Required. "BigDataPoolReference"
- name: type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.BigDataPoolReferenceType>
-- description: 'Reference big data pool name. Type: string (or Expression with resultType
-
- string). Required.'
- name: reference_name
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BigDataPoolReference.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BigDataPoolReference.yml
index 7782b115ba34..cf79e59c2462 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BigDataPoolReference.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BigDataPoolReference.yml
@@ -4,31 +4,28 @@ name: BigDataPoolReference
fullName: azure.synapse.artifacts.models.BigDataPoolReference
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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(*, type: str | _models.BigDataPoolReferenceType, reference_name:
- str, **kwargs: Any)'
+ syntax: 'BigDataPoolReference(*, reference_name: str, **kwargs)'
parameters:
- - name: type
- description: Big data pool reference type. Required. "BigDataPoolReference"
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.BigDataPoolReferenceType>
- name: reference_name
- description: Reference big data pool name. Required.
+ description: Required. Reference big data pool name.
+ isRequired: true
types:
- <xref:str>
variables:
-- description: Big data pool reference type. Required. "BigDataPoolReference"
+- description: 'Required. Big data pool reference type. Default value: "BigDataPoolReference".'
name: type
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.BigDataPoolReferenceType>
-- description: Reference big data pool name. Required.
- name: reference_name
- types:
- - <xref:str>
+attributes:
+- uid: azure.synapse.artifacts.models.BigDataPoolReference.type
+ name: type
+ signature: type = 'BigDataPoolReference'
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BigDataPoolReferenceType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BigDataPoolReferenceType.yml
deleted file mode 100644
index 1f8959b3d12a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BigDataPoolReferenceType.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.BigDataPoolReferenceType
-name: BigDataPoolReferenceType
-fullName: azure.synapse.artifacts.models.BigDataPoolReferenceType
-summary: Big data pool reference type.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: BigDataPoolReferenceType(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: BIG_DATA_POOL_REFERENCE
- uid: azure.synapse.artifacts.models.BigDataPoolReferenceType.BIG_DATA_POOL_REFERENCE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BigDataPoolResourceInfo.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BigDataPoolResourceInfo.yml
deleted file mode 100644
index 868fee4b7b55..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BigDataPoolResourceInfo.yml
+++ /dev/null
@@ -1,216 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.BigDataPoolResourceInfo
-name: BigDataPoolResourceInfo
-fullName: azure.synapse.artifacts.models.BigDataPoolResourceInfo
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TrackedResource
-summary: 'A Big Data pool.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'BigDataPoolResourceInfo(*, location: str, tags: Dict[str, str] | None =
- None, provisioning_state: str | None = None, auto_scale: _models.AutoScaleProperties
- | None = None, creation_date: datetime | None = None, auto_pause: _models.AutoPauseProperties
- | None = None, is_compute_isolation_enabled: bool | None = None, session_level_packages_enabled:
- bool | None = None, cache_size: int | None = None, dynamic_executor_allocation:
- _models.DynamicExecutorAllocation | None = None, spark_events_folder: str | None
- = None, node_count: int | None = None, library_requirements: _models.LibraryRequirements
- | None = None, custom_libraries: List[_models.LibraryInfo] | None = None, spark_config_properties:
- _models.LibraryRequirements | None = None, spark_version: str | None = None, default_spark_log_folder:
- str | None = None, node_size: str | _models.NodeSize | None = None, node_size_family:
- str | _models.NodeSizeFamily | None = None, **kwargs: Any)'
- parameters:
- - name: tags
- description: Resource tags.
- types:
- - <xref:dict>[<xref:str>, <xref:str>]
- - name: location
- description: The geo-location where the resource lives. Required.
- types:
- - <xref:str>
- - name: provisioning_state
- description: The state of the Big Data pool.
- types:
- - <xref:str>
- - name: auto_scale
- description: Auto-scaling properties.
- types:
- - <xref:azure.synapse.artifacts.models.AutoScaleProperties>
- - name: creation_date
- description: The time when the Big Data pool was created.
- types:
- - <xref:datetime.datetime>
- - name: auto_pause
- description: Auto-pausing properties.
- types:
- - <xref:azure.synapse.artifacts.models.AutoPauseProperties>
- - name: is_compute_isolation_enabled
- description: Whether compute isolation is required or not.
- types:
- - <xref:bool>
- - name: session_level_packages_enabled
- description: Whether session level packages enabled.
- types:
- - <xref:bool>
- - name: cache_size
- description: The cache size.
- types:
- - <xref:int>
- - name: dynamic_executor_allocation
- description: Dynamic Executor Allocation.
- types:
- - <xref:azure.synapse.artifacts.models.DynamicExecutorAllocation>
- - name: spark_events_folder
- description: The Spark events folder.
- types:
- - <xref:str>
- - name: node_count
- description: The number of nodes in the Big Data pool.
- types:
- - <xref:int>
- - name: library_requirements
- description: Library version requirements.
- types:
- - <xref:azure.synapse.artifacts.models.LibraryRequirements>
- - name: custom_libraries
- description: List of custom libraries/packages associated with the spark pool.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.LibraryInfo>]
- - name: spark_config_properties
- description: Spark configuration file to specify additional properties.
- types:
- - <xref:azure.synapse.artifacts.models.LibraryRequirements>
- - name: spark_version
- description: The Apache Spark version.
- types:
- - <xref:str>
- - name: default_spark_log_folder
- description: The default folder where Spark logs will be written.
- types:
- - <xref:str>
- - name: node_size
- description: 'The level of compute power that each node in the Big Data pool has.
- Known
-
- values are: "None", "Small", "Medium", "Large", "XLarge", "XXLarge", and "XXXLarge".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.NodeSize>
- - name: node_size_family
- description: 'The kind of nodes that the Big Data pool provides. Known values
- are:
-
- "None" and "MemoryOptimized".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.NodeSizeFamily>
-variables:
-- description: 'Fully qualified resource ID for the resource. Ex -
-
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.'
- name: id
- types:
- - <xref:str>
-- description: The name of the resource.
- name: name
- types:
- - <xref:str>
-- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines"
- or
-
- "Microsoft.Storage/storageAccounts".'
- name: type
- types:
- - <xref:str>
-- description: Resource tags.
- name: tags
- types:
- - <xref:dict>[<xref:str>, <xref:str>]
-- description: The geo-location where the resource lives. Required.
- name: location
- types:
- - <xref:str>
-- description: The state of the Big Data pool.
- name: provisioning_state
- types:
- - <xref:str>
-- description: Auto-scaling properties.
- name: auto_scale
- types:
- - <xref:azure.synapse.artifacts.models.AutoScaleProperties>
-- description: The time when the Big Data pool was created.
- name: creation_date
- types:
- - <xref:datetime.datetime>
-- description: Auto-pausing properties.
- name: auto_pause
- types:
- - <xref:azure.synapse.artifacts.models.AutoPauseProperties>
-- description: Whether compute isolation is required or not.
- name: is_compute_isolation_enabled
- types:
- - <xref:bool>
-- description: Whether session level packages enabled.
- name: session_level_packages_enabled
- types:
- - <xref:bool>
-- description: The cache size.
- name: cache_size
- types:
- - <xref:int>
-- description: Dynamic Executor Allocation.
- name: dynamic_executor_allocation
- types:
- - <xref:azure.synapse.artifacts.models.DynamicExecutorAllocation>
-- description: The Spark events folder.
- name: spark_events_folder
- types:
- - <xref:str>
-- description: The number of nodes in the Big Data pool.
- name: node_count
- types:
- - <xref:int>
-- description: Library version requirements.
- name: library_requirements
- types:
- - <xref:azure.synapse.artifacts.models.LibraryRequirements>
-- description: List of custom libraries/packages associated with the spark pool.
- name: custom_libraries
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.LibraryInfo>]
-- description: Spark configuration file to specify additional properties.
- name: spark_config_properties
- types:
- - <xref:azure.synapse.artifacts.models.LibraryRequirements>
-- description: The Apache Spark version.
- name: spark_version
- types:
- - <xref:str>
-- description: The default folder where Spark logs will be written.
- name: default_spark_log_folder
- types:
- - <xref:str>
-- description: 'The level of compute power that each node in the Big Data pool has.
- Known
-
- values are: "None", "Small", "Medium", "Large", "XLarge", "XXLarge", and "XXXLarge".'
- name: node_size
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.NodeSize>
-- description: 'The kind of nodes that the Big Data pool provides. Known values are:
-
- "None" and "MemoryOptimized".'
- name: node_size_family
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.NodeSizeFamily>
-- description: The time when the Big Data pool was updated successfully.
- name: last_succeeded_timestamp
- types:
- - <xref:datetime.datetime>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BigDataPoolResourceInfoListResult.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BigDataPoolResourceInfoListResult.yml
deleted file mode 100644
index 3ac856f420aa..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BigDataPoolResourceInfoListResult.yml
+++ /dev/null
@@ -1,29 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.BigDataPoolResourceInfoListResult
-name: BigDataPoolResourceInfoListResult
-fullName: azure.synapse.artifacts.models.BigDataPoolResourceInfoListResult
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Collection of Big Data pool information.
-constructor:
- syntax: 'BigDataPoolResourceInfoListResult(*, next_link: str | None = None, value:
- List[_models.BigDataPoolResourceInfo] | None = None, **kwargs: Any)'
- parameters:
- - name: next_link
- description: Link to the next page of results.
- types:
- - <xref:str>
- - name: value
- description: List of Big Data pools.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.BigDataPoolResourceInfo>]
-variables:
-- description: Link to the next page of results.
- name: next_link
- types:
- - <xref:str>
-- description: List of Big Data pools.
- name: value
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.BigDataPoolResourceInfo>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BinaryDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BinaryDataset.yml
index 762db9576154..14936ac724cf 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BinaryDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BinaryDataset.yml
@@ -10,117 +10,76 @@ summary: 'Binary dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'BinaryDataset(*, linked_service_name: _models.LinkedServiceReference, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None,
- structure: MutableMapping[str, Any] | None = None, schema: MutableMapping[str,
- Any] | None = None, parameters: Dict[str, _models.ParameterSpecification] | None
- = None, annotations: List[MutableMapping[str, Any]] | None = None, folder: _models.DatasetFolder
- | None = None, location: _models.DatasetLocation | None = None, compression: _models.DatasetCompression
- | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: location
description: The location of the Binary storage.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetLocation>
- name: compression
description: The data compression method used for the binary dataset.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetCompression>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: The location of the Binary storage.
- name: location
- types:
- - <xref:azure.synapse.artifacts.models.DatasetLocation>
-- description: The data compression method used for the binary dataset.
- name: compression
- types:
- - <xref:azure.synapse.artifacts.models.DatasetCompression>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BinaryReadSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BinaryReadSettings.yml
deleted file mode 100644
index f068dcd3d3d6..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BinaryReadSettings.yml
+++ /dev/null
@@ -1,41 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.BinaryReadSettings
-name: BinaryReadSettings
-fullName: azure.synapse.artifacts.models.BinaryReadSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.FormatReadSettings
-summary: 'Binary read settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'BinaryReadSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, compression_properties: _models.CompressionReadSettings |
- None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: compression_properties
- description: Compression settings.
- types:
- - <xref:azure.synapse.artifacts.models.CompressionReadSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The read setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: Compression settings.
- name: compression_properties
- types:
- - <xref:azure.synapse.artifacts.models.CompressionReadSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BinarySink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BinarySink.yml
deleted file mode 100644
index 02a3edeebeb4..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BinarySink.yml
+++ /dev/null
@@ -1,104 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.BinarySink
-name: BinarySink
-fullName: azure.synapse.artifacts.models.BinarySink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Binary sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'BinarySink(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, write_batch_size: MutableMapping[str, Any] | None = None, write_batch_timeout:
- MutableMapping[str, Any] | None = None, sink_retry_count: MutableMapping[str,
- Any] | None = None, sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, store_settings: _models.StoreWriteSettings
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: store_settings
- description: Binary store settings.
- types:
- - <xref:azure.synapse.artifacts.models.StoreWriteSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: Binary store settings.
- name: store_settings
- types:
- - <xref:azure.synapse.artifacts.models.StoreWriteSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BinarySource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BinarySource.yml
deleted file mode 100644
index c5ad8ba7a28b..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BinarySource.yml
+++ /dev/null
@@ -1,87 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.BinarySource
-name: BinarySource
-fullName: azure.synapse.artifacts.models.BinarySource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity Binary source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'BinarySource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, store_settings: _models.StoreReadSettings | None = None, format_settings:
- _models.BinaryReadSettings | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: store_settings
- description: Binary store settings.
- types:
- - <xref:azure.synapse.artifacts.models.StoreReadSettings>
- - name: format_settings
- description: Binary format settings.
- types:
- - <xref:azure.synapse.artifacts.models.BinaryReadSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: Binary store settings.
- name: store_settings
- types:
- - <xref:azure.synapse.artifacts.models.StoreReadSettings>
-- description: Binary format settings.
- name: format_settings
- types:
- - <xref:azure.synapse.artifacts.models.BinaryReadSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BlobEventType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BlobEventType.yml
deleted file mode 100644
index 9f7462c0f364..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BlobEventType.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.BlobEventType
-name: BlobEventType
-fullName: azure.synapse.artifacts.models.BlobEventType
-summary: BlobEventType.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: BlobEventType(value, names=None, *, module=None, qualname=None, type=None,
- start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: MICROSOFT_STORAGE_BLOB_CREATED
- uid: azure.synapse.artifacts.models.BlobEventType.MICROSOFT_STORAGE_BLOB_CREATED
-- name: MICROSOFT_STORAGE_BLOB_DELETED
- uid: azure.synapse.artifacts.models.BlobEventType.MICROSOFT_STORAGE_BLOB_DELETED
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BlobEventsTrigger.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BlobEventsTrigger.yml
deleted file mode 100644
index ec0717100e77..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BlobEventsTrigger.yml
+++ /dev/null
@@ -1,138 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.BlobEventsTrigger
-name: BlobEventsTrigger
-fullName: azure.synapse.artifacts.models.BlobEventsTrigger
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.MultiplePipelineTrigger
-summary: 'Trigger that runs every time a Blob event occurs.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'BlobEventsTrigger(*, events: List[str | _models.BlobEventType], scope:
- str, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- description: str | None = None, annotations: List[MutableMapping[str, Any]] |
- None = None, pipelines: List[_models.TriggerPipelineReference] | None = None,
- blob_path_begins_with: str | None = None, blob_path_ends_with: str | None = None,
- ignore_empty_blobs: bool | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Trigger description.
- types:
- - <xref:str>
- - name: annotations
- description: List of tags that can be used for describing the trigger.
- types:
- - <xref:list>[<xref:JSON>]
- - name: pipelines
- description: Pipelines that need to be started.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.TriggerPipelineReference>]
- - name: blob_path_begins_with
- description: 'The blob path must begin with the pattern provided for trigger
-
- to fire. For example, ''/records/blobs/december/'' will only fire the trigger
- for blobs in the
-
- december folder under the records container. At least one of these must be provided:
-
- blobPathBeginsWith, blobPathEndsWith.'
- types:
- - <xref:str>
- - name: blob_path_ends_with
- description: 'The blob path must end with the pattern provided for trigger to
-
- fire. For example, ''december/boxes.csv'' will only fire the trigger for blobs
- named boxes in a
-
- december folder. At least one of these must be provided: blobPathBeginsWith,
- blobPathEndsWith.'
- types:
- - <xref:str>
- - name: ignore_empty_blobs
- description: If set to true, blobs with zero bytes will be ignored.
- types:
- - <xref:bool>
- - name: events
- description: The type of events that cause this trigger to fire. Required.
- types:
- - <xref:list>[<xref:str>
- - <xref:azure.synapse.artifacts.models.BlobEventType>]
- - name: scope
- description: The ARM resource ID of the Storage Account. Required.
- types:
- - <xref:str>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Trigger type. Required.
- name: type
- types:
- - <xref:str>
-- description: Trigger description.
- name: description
- types:
- - <xref:str>
-- description: 'Indicates if trigger is running or not. Updated when Start/Stop APIs
- are
-
- called on the Trigger. Known values are: "Started", "Stopped", and "Disabled".'
- name: runtime_state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.TriggerRuntimeState>
-- description: List of tags that can be used for describing the trigger.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: Pipelines that need to be started.
- name: pipelines
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.TriggerPipelineReference>]
-- description: 'The blob path must begin with the pattern provided for trigger to
-
- fire. For example, ''/records/blobs/december/'' will only fire the trigger for
- blobs in the
-
- december folder under the records container. At least one of these must be provided:
-
- blobPathBeginsWith, blobPathEndsWith.'
- name: blob_path_begins_with
- types:
- - <xref:str>
-- description: 'The blob path must end with the pattern provided for trigger to
-
- fire. For example, ''december/boxes.csv'' will only fire the trigger for blobs
- named boxes in a
-
- december folder. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.'
- name: blob_path_ends_with
- types:
- - <xref:str>
-- description: If set to true, blobs with zero bytes will be ignored.
- name: ignore_empty_blobs
- types:
- - <xref:bool>
-- description: The type of events that cause this trigger to fire. Required.
- name: events
- types:
- - <xref:list>[<xref:str>
- - <xref:azure.synapse.artifacts.models.BlobEventType>]
-- description: The ARM resource ID of the Storage Account. Required.
- name: scope
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BlobSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BlobSink.yml
deleted file mode 100644
index 84ca1860535a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BlobSink.yml
+++ /dev/null
@@ -1,142 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.BlobSink
-name: BlobSink
-fullName: azure.synapse.artifacts.models.BlobSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Azure Blob sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'BlobSink(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, write_batch_size: MutableMapping[str, Any] | None = None, write_batch_timeout:
- MutableMapping[str, Any] | None = None, sink_retry_count: MutableMapping[str,
- Any] | None = None, sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, blob_writer_overwrite_files: MutableMapping[str,
- Any] | None = None, blob_writer_date_time_format: MutableMapping[str, Any] | None
- = None, blob_writer_add_header: MutableMapping[str, Any] | None = None, copy_behavior:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: blob_writer_overwrite_files
- description: 'Blob writer overwrite files. Type: boolean (or Expression
-
- with resultType boolean).'
- types:
- - <xref:JSON>
- - name: blob_writer_date_time_format
- description: 'Blob writer date time format. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: blob_writer_add_header
- description: 'Blob writer add header. Type: boolean (or Expression with
-
- resultType boolean).'
- types:
- - <xref:JSON>
- - name: copy_behavior
- description: The type of copy behavior for copy sink.
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Blob writer overwrite files. Type: boolean (or Expression
-
- with resultType boolean).'
- name: blob_writer_overwrite_files
- types:
- - <xref:JSON>
-- description: 'Blob writer date time format. Type: string (or Expression
-
- with resultType string).'
- name: blob_writer_date_time_format
- types:
- - <xref:JSON>
-- description: 'Blob writer add header. Type: boolean (or Expression with
-
- resultType boolean).'
- name: blob_writer_add_header
- types:
- - <xref:JSON>
-- description: The type of copy behavior for copy sink.
- name: copy_behavior
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BlobSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BlobSource.yml
deleted file mode 100644
index 28438b1371b4..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BlobSource.yml
+++ /dev/null
@@ -1,110 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.BlobSource
-name: BlobSource
-fullName: azure.synapse.artifacts.models.BlobSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity Azure Blob source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'BlobSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, treat_empty_as_null: MutableMapping[str, Any] | None = None,
- skip_header_line_count: MutableMapping[str, Any] | None = None, recursive: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: treat_empty_as_null
- description: 'Treat empty as null. Type: boolean (or Expression with resultType
-
- boolean).'
- types:
- - <xref:JSON>
- - name: skip_header_line_count
- description: 'Number of header lines to skip from each blob. Type: integer
-
- (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: recursive
- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Treat empty as null. Type: boolean (or Expression with resultType
-
- boolean).'
- name: treat_empty_as_null
- types:
- - <xref:JSON>
-- description: 'Number of header lines to skip from each blob. Type: integer (or
-
- Expression with resultType integer).'
- name: skip_header_line_count
- types:
- - <xref:JSON>
-- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- name: recursive
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BlobTrigger.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BlobTrigger.yml
deleted file mode 100644
index 79b0861d0fcd..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BlobTrigger.yml
+++ /dev/null
@@ -1,100 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.BlobTrigger
-name: BlobTrigger
-fullName: azure.synapse.artifacts.models.BlobTrigger
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.MultiplePipelineTrigger
-summary: 'Trigger that runs every time the selected Blob container changes.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'BlobTrigger(*, folder_path: str, max_concurrency: int, linked_service:
- _models.LinkedServiceReference, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, annotations: List[MutableMapping[str,
- Any]] | None = None, pipelines: List[_models.TriggerPipelineReference] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Trigger description.
- types:
- - <xref:str>
- - name: annotations
- description: List of tags that can be used for describing the trigger.
- types:
- - <xref:list>[<xref:JSON>]
- - name: pipelines
- description: Pipelines that need to be started.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.TriggerPipelineReference>]
- - name: folder_path
- description: 'The path of the container/folder that will trigger the pipeline.
-
- Required.'
- types:
- - <xref:str>
- - name: max_concurrency
- description: 'The max number of parallel files to handle when it is triggered.
-
- Required.'
- types:
- - <xref:int>
- - name: linked_service
- description: The Azure Storage linked service reference. Required.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Trigger type. Required.
- name: type
- types:
- - <xref:str>
-- description: Trigger description.
- name: description
- types:
- - <xref:str>
-- description: 'Indicates if trigger is running or not. Updated when Start/Stop APIs
- are
-
- called on the Trigger. Known values are: "Started", "Stopped", and "Disabled".'
- name: runtime_state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.TriggerRuntimeState>
-- description: List of tags that can be used for describing the trigger.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: Pipelines that need to be started.
- name: pipelines
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.TriggerPipelineReference>]
-- description: The path of the container/folder that will trigger the pipeline. Required.
- name: folder_path
- types:
- - <xref:str>
-- description: 'The max number of parallel files to handle when it is triggered.
-
- Required.'
- name: max_concurrency
- types:
- - <xref:int>
-- description: The Azure Storage linked service reference. Required.
- name: linked_service
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraLinkedService.yml
index 85b26ee3b8e7..9b86055c2c8f 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraLinkedService.yml
@@ -10,136 +10,86 @@ summary: 'Linked service for Cassandra data source.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'CassandraLinkedService(*, host: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, authentication_type:
- MutableMapping[str, Any] | None = None, port: MutableMapping[str, Any] | None
- = None, username: MutableMapping[str, Any] | None = None, password: _models.SecretBase
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: host
- description: 'Host name for connection. Type: string (or Expression with resultType
- string).
+ description: 'Required. Host name for connection. Type: string (or Expression
+ with resultType
- Required.'
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: authentication_type
description: 'AuthenticationType to be used for connection. Type: string (or
Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: port
description: 'The port for the connection. Type: integer (or Expression with resultType
integer).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: username
description: 'Username for authentication. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: Password for authentication.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Host name for connection. Type: string (or Expression with resultType
- string).
-
- Required.'
- name: host
- types:
- - <xref:JSON>
-- description: 'AuthenticationType to be used for connection. Type: string (or
-
- Expression with resultType string).'
- name: authentication_type
- types:
- - <xref:JSON>
-- description: 'The port for the connection. Type: integer (or Expression with resultType
- integer).'
- name: port
- types:
- - <xref:JSON>
-- description: 'Username for authentication. Type: string (or Expression with resultType
-
- string).'
- name: username
- types:
- - <xref:JSON>
-- description: Password for authentication.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraSource.yml
deleted file mode 100644
index 8566473ecc6c..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraSource.yml
+++ /dev/null
@@ -1,150 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.CassandraSource
-name: CassandraSource
-fullName: azure.synapse.artifacts.models.CassandraSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity source for a Cassandra database.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'CassandraSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, query:
- MutableMapping[str, Any] | None = None, consistency_level: str | _models.CassandraSourceReadConsistencyLevels
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'Database query. Should be a SQL-92 query expression or Cassandra
- Query Language
-
- (CQL) command. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: consistency_level
- description: 'The consistency level specifies how many Cassandra servers must
-
- respond to a read request before returning data to the client application. Cassandra
- checks the
-
- specified number of Cassandra servers for data to satisfy the read request.
- Must be one of
-
- cassandraSourceReadConsistencyLevels. The default value is ''ONE''. It is case-insensitive.
- Known
-
- values are: "ALL", "EACH_QUORUM", "QUORUM", "LOCAL_QUORUM", "ONE", "TWO", "THREE",
- "LOCAL_ONE",
-
- "SERIAL", and "LOCAL_SERIAL".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.CassandraSourceReadConsistencyLevels>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'Database query. Should be a SQL-92 query expression or Cassandra Query
- Language
-
- (CQL) command. Type: string (or Expression with resultType string).'
- name: query
- types:
- - <xref:JSON>
-- description: 'The consistency level specifies how many Cassandra servers must
-
- respond to a read request before returning data to the client application. Cassandra
- checks the
-
- specified number of Cassandra servers for data to satisfy the read request. Must
- be one of
-
- cassandraSourceReadConsistencyLevels. The default value is ''ONE''. It is case-insensitive.
- Known
-
- values are: "ALL", "EACH_QUORUM", "QUORUM", "LOCAL_QUORUM", "ONE", "TWO", "THREE",
- "LOCAL_ONE",
-
- "SERIAL", and "LOCAL_SERIAL".'
- name: consistency_level
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.CassandraSourceReadConsistencyLevels>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraSourceReadConsistencyLevels.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraSourceReadConsistencyLevels.yml
deleted file mode 100644
index b8c3c0a81f3b..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraSourceReadConsistencyLevels.yml
+++ /dev/null
@@ -1,41 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.CassandraSourceReadConsistencyLevels
-name: CassandraSourceReadConsistencyLevels
-fullName: azure.synapse.artifacts.models.CassandraSourceReadConsistencyLevels
-summary: 'The consistency level specifies how many Cassandra servers must respond
- to a read request
-
- before returning data to the client application. Cassandra checks the specified
- number of
-
- Cassandra servers for data to satisfy the read request. Must be one of
-
- cassandraSourceReadConsistencyLevels. The default value is ''ONE''. It is case-insensitive.'
-module: azure.synapse.artifacts.models
-constructor:
- syntax: CassandraSourceReadConsistencyLevels(value, names=None, *, module=None,
- qualname=None, type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: ALL
- uid: azure.synapse.artifacts.models.CassandraSourceReadConsistencyLevels.ALL
-- name: EACH_QUORUM
- uid: azure.synapse.artifacts.models.CassandraSourceReadConsistencyLevels.EACH_QUORUM
-- name: LOCAL_ONE
- uid: azure.synapse.artifacts.models.CassandraSourceReadConsistencyLevels.LOCAL_ONE
-- name: LOCAL_QUORUM
- uid: azure.synapse.artifacts.models.CassandraSourceReadConsistencyLevels.LOCAL_QUORUM
-- name: LOCAL_SERIAL
- uid: azure.synapse.artifacts.models.CassandraSourceReadConsistencyLevels.LOCAL_SERIAL
-- name: ONE
- uid: azure.synapse.artifacts.models.CassandraSourceReadConsistencyLevels.ONE
-- name: QUORUM
- uid: azure.synapse.artifacts.models.CassandraSourceReadConsistencyLevels.QUORUM
-- name: SERIAL
- uid: azure.synapse.artifacts.models.CassandraSourceReadConsistencyLevels.SERIAL
-- name: THREE
- uid: azure.synapse.artifacts.models.CassandraSourceReadConsistencyLevels.THREE
-- name: TWO
- uid: azure.synapse.artifacts.models.CassandraSourceReadConsistencyLevels.TWO
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraTableDataset.yml
index 6d9720c0d6b5..a666116e31ce 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraTableDataset.yml
@@ -10,54 +10,67 @@ summary: 'The Cassandra database dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'CassandraTableDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, keyspace: MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
@@ -65,74 +78,14 @@ constructor:
with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: keyspace
description: 'The keyspace of the Cassandra database. Type: string (or Expression
with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name of the Cassandra database. Type: string (or Expression
- with
-
- resultType string).'
- name: table_name
- types:
- - <xref:JSON>
-- description: 'The keyspace of the Cassandra database. Type: string (or Expression
- with
-
- resultType string).'
- name: keyspace
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CellOutputType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CellOutputType.yml
index 9eeb2652f5cb..fe68f23e84e7 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CellOutputType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CellOutputType.yml
@@ -11,11 +11,11 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ChainingTrigger.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ChainingTrigger.yml
deleted file mode 100644
index e66c92e4bcb1..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ChainingTrigger.yml
+++ /dev/null
@@ -1,103 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ChainingTrigger
-name: ChainingTrigger
-fullName: azure.synapse.artifacts.models.ChainingTrigger
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.Trigger
-summary: 'Trigger that allows the referenced pipeline to depend on other pipeline
- runs based on
-
- runDimension Name/Value pairs. Upstream pipelines should declare the same runDimension
- Name and
-
- their runs should have the values for those runDimensions. The referenced pipeline
- run would be
-
- triggered if the values for the runDimension match for all upstream pipeline runs.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ChainingTrigger(*, pipeline: _models.TriggerPipelineReference, depends_on:
- List[_models.PipelineReference], run_dimension: str, additional_properties: Dict[str,
- MutableMapping[str, Any]] | None = None, description: str | None = None, annotations:
- List[MutableMapping[str, Any]] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Trigger description.
- types:
- - <xref:str>
- - name: annotations
- description: List of tags that can be used for describing the trigger.
- types:
- - <xref:list>[<xref:JSON>]
- - name: pipeline
- description: 'Pipeline for which runs are created when all upstream pipelines
- complete
-
- successfully. Required.'
- types:
- - <xref:azure.synapse.artifacts.models.TriggerPipelineReference>
- - name: depends_on
- description: Upstream Pipelines. Required.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.PipelineReference>]
- - name: run_dimension
- description: 'Run Dimension property that needs to be emitted by upstream pipelines.
-
- Required.'
- types:
- - <xref:str>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Trigger type. Required.
- name: type
- types:
- - <xref:str>
-- description: Trigger description.
- name: description
- types:
- - <xref:str>
-- description: 'Indicates if trigger is running or not. Updated when Start/Stop APIs
- are
-
- called on the Trigger. Known values are: "Started", "Stopped", and "Disabled".'
- name: runtime_state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.TriggerRuntimeState>
-- description: List of tags that can be used for describing the trigger.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Pipeline for which runs are created when all upstream pipelines complete
-
- successfully. Required.'
- name: pipeline
- types:
- - <xref:azure.synapse.artifacts.models.TriggerPipelineReference>
-- description: Upstream Pipelines. Required.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.PipelineReference>]
-- description: 'Run Dimension property that needs to be emitted by upstream pipelines.
-
- Required.'
- name: run_dimension
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CloudError.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CloudError.yml
index 1e51e926a3bb..2c440739fa67 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CloudError.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CloudError.yml
@@ -4,45 +4,32 @@ name: CloudError
fullName: azure.synapse.artifacts.models.CloudError
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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[_models.CloudError] | None = None, **kwargs: Any)'
+ List[CloudError] | None = None, **kwargs)'
parameters:
- name: code
- description: Error code. Required.
+ description: Required. Error code.
+ isRequired: true
types:
- <xref:str>
- name: message
- description: Error message. Required.
+ description: Required. Error message.
+ isRequired: true
types:
- <xref:str>
- name: target
description: Property name/path in request associated with error.
+ isRequired: true
types:
- <xref:str>
- name: details
description: Array with additional error details.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.CloudError>]
-variables:
-- description: Error code. Required.
- name: code
- types:
- - <xref:str>
-- description: Error message. Required.
- name: message
- types:
- - <xref:str>
-- description: Property name/path in request associated with error.
- name: target
- types:
- - <xref:str>
-- description: Array with additional error details.
- name: details
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.CloudError>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset.yml
index 8f6ad6e6c393..5caa6acd9620 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset.yml
@@ -10,113 +10,74 @@ 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: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, entity_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: entity_name
description: 'The logical name of the entity. Type: string (or Expression with
+ resultType
- resultType string).'
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The logical name of the entity. Type: string (or Expression with resultType
-
- string).'
- name: entity_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService.yml
index cea66021126a..4ad10229cbda 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService.yml
@@ -10,53 +10,63 @@ 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: MutableMapping[str,
- Any], authentication_type: MutableMapping[str, Any], additional_properties: Dict[str,
- MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, host_name:
- MutableMapping[str, Any] | None = None, port: MutableMapping[str, Any] | None
- = None, service_uri: MutableMapping[str, Any] | None = None, organization_name:
- MutableMapping[str, Any] | None = None, username: MutableMapping[str, Any] | None
- = None, password: _models.SecretBase | None = None, service_principal_id: MutableMapping[str,
- Any] | None = None, service_principal_credential_type: MutableMapping[str, Any]
- | None = None, service_principal_credential: _models.SecretBase | None = None,
- encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: deployment_type
- description: 'The deployment type of the Common Data Service for Apps instance.
+ description: 'Required. The deployment type of the Common Data Service for Apps
- ''Online'' for Common Data Service for Apps Online and ''OnPremisesWithIfd''
- for Common Data
+ instance. ''Online'' for Common Data Service for Apps Online and ''OnPremisesWithIfd''
+ for Common
- Service for Apps on-premises with Ifd. Type: string (or Expression with resultType
- string).
+ Data Service for Apps on-premises with Ifd. Type: string (or Expression with
+ resultType
- Required.'
+ string). Possible values include: "Online", "OnPremisesWithIfd".'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:str>
+ - <xref:azure.synapse.artifacts.models.DynamicsDeploymentType>
- name: host_name
description: 'The host name of the on-premises Common Data Service for Apps server.
The
@@ -65,8 +75,9 @@ constructor:
Expression with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: port
description: 'The port of on-premises Common Data Service for Apps server. The
property is
@@ -75,17 +86,20 @@ constructor:
(or Expression
with resultType integer), minimum: 0.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: service_uri
description: 'The URL to the Microsoft Common Data Service for Apps server. The
+ property
- property is required for on-line and not allowed for on-prem. Type: string (or
- Expression with
+ is required for on-line and not allowed for on-prem. Type: string (or Expression
+ with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: organization_name
description: 'The organization name of the Common Data Service for Apps instance.
@@ -96,29 +110,36 @@ constructor:
(or Expression
with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: authentication_type
- description: 'The authentication type to connect to Common Data Service for
+ description: 'Required. The authentication type to connect to Common Data Service
- Apps server. ''Office365'' for online scenario, ''Ifd'' for on-premises with
- Ifd scenario.
+ 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). Required.'
+ Expression with resultType string). Possible values include: "Office365", "Ifd",
+
+ "AADServicePrincipal".'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:str>
+ - <xref:azure.synapse.artifacts.models.DynamicsAuthenticationType>
- name: username
description: 'User name to access the Common Data Service for Apps instance. Type:
string
(or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: Password to access the Common Data Service for Apps instance.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: service_principal_id
@@ -126,14 +147,22 @@ constructor:
for Server-To-Server authentication. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_credential_type
- description: 'A string from ServicePrincipalCredentialEnum or an
+ 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:
- expression.'
+ "ServicePrincipalKey", "ServicePrincipalCert".'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:str>
+ - <xref:azure.synapse.artifacts.models.DynamicsServicePrincipalCredentialType>
- name: service_principal_credential
description: 'The credential of the service principal object in Azure
@@ -146,152 +175,16 @@ constructor:
can only
be AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: '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).
-
- Required.'
- name: deployment_type
- types:
- - <xref:JSON>
-- 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).'
- name: host_name
- types:
- - <xref:JSON>
-- 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.'
- name: port
- types:
- - <xref:JSON>
-- 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).'
- name: service_uri
- types:
- - <xref:JSON>
-- 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).'
- name: organization_name
- types:
- - <xref:JSON>
-- description: '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). Required.'
- name: authentication_type
- types:
- - <xref:JSON>
-- description: 'User name to access the Common Data Service for Apps instance. Type:
- string (or
-
- Expression with resultType string).'
- name: username
- types:
- - <xref:JSON>
-- description: Password to access the Common Data Service for Apps instance.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The client ID of the application in Azure Active Directory used for
-
- Server-To-Server authentication. Type: string (or Expression with resultType string).'
- name: service_principal_id
- types:
- - <xref:JSON>
-- description: 'A string from ServicePrincipalCredentialEnum or an
-
- expression.'
- name: service_principal_credential_type
- types:
- - <xref:JSON>
-- 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.'
- name: service_principal_credential
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsSink.yml
deleted file mode 100644
index 211be10ef0f3..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsSink.yml
+++ /dev/null
@@ -1,138 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.CommonDataServiceForAppsSink
-name: CommonDataServiceForAppsSink
-fullName: azure.synapse.artifacts.models.CommonDataServiceForAppsSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Common Data Service for Apps sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'CommonDataServiceForAppsSink(*, write_behavior: str | _models.DynamicsSinkWriteBehavior,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, write_batch_size:
- MutableMapping[str, Any] | None = None, write_batch_timeout: MutableMapping[str,
- Any] | None = None, sink_retry_count: MutableMapping[str, Any] | None = None,
- sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, ignore_null_values: MutableMapping[str,
- Any] | None = None, alternate_key_name: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: write_behavior
- description: The write behavior for the operation. Required. "Upsert"
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.DynamicsSinkWriteBehavior>
- - name: ignore_null_values
- description: 'The flag indicating whether to ignore null values from input
-
- dataset (except key fields) during write operation. Default is false. Type:
- boolean (or
-
- Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: alternate_key_name
- description: 'The logical name of the alternate key which will be used when
-
- upserting records. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: The write behavior for the operation. Required. "Upsert"
- name: write_behavior
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.DynamicsSinkWriteBehavior>
-- description: 'The flag indicating whether to ignore null values from input dataset
-
- (except key fields) during write operation. Default is false. Type: boolean (or
- Expression with
-
- resultType boolean).'
- name: ignore_null_values
- types:
- - <xref:JSON>
-- description: 'The logical name of the alternate key which will be used when
-
- upserting records. Type: string (or Expression with resultType string).'
- name: alternate_key_name
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsSource.yml
deleted file mode 100644
index 76bd51b8d97d..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsSource.yml
+++ /dev/null
@@ -1,101 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.CommonDataServiceForAppsSource
-name: CommonDataServiceForAppsSource
-fullName: azure.synapse.artifacts.models.CommonDataServiceForAppsSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity Common Data Service for Apps source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'CommonDataServiceForAppsSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, additional_columns: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query
- description: 'FetchXML is a proprietary query language that is used in Microsoft
- Common Data
-
- Service for Apps (online & on-premises). Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'FetchXML is a proprietary query language that is used in Microsoft
- Common Data
-
- Service for Apps (online & on-premises). Type: string (or Expression with resultType
- string).'
- name: query
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CompressionCodec.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CompressionCodec.yml
deleted file mode 100644
index 3ea3ae8303c3..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CompressionCodec.yml
+++ /dev/null
@@ -1,33 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.CompressionCodec
-name: CompressionCodec
-fullName: azure.synapse.artifacts.models.CompressionCodec
-summary: All available compressionCodec values.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: CompressionCodec(value, names=None, *, module=None, qualname=None, type=None,
- start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: BZIP2
- uid: azure.synapse.artifacts.models.CompressionCodec.BZIP2
-- name: DEFLATE
- uid: azure.synapse.artifacts.models.CompressionCodec.DEFLATE
-- name: GZIP
- uid: azure.synapse.artifacts.models.CompressionCodec.GZIP
-- name: LZ4
- uid: azure.synapse.artifacts.models.CompressionCodec.LZ4
-- name: LZO
- uid: azure.synapse.artifacts.models.CompressionCodec.LZO
-- name: NONE
- uid: azure.synapse.artifacts.models.CompressionCodec.NONE
-- name: SNAPPY
- uid: azure.synapse.artifacts.models.CompressionCodec.SNAPPY
-- name: TAR
- uid: azure.synapse.artifacts.models.CompressionCodec.TAR
-- name: TAR_G_ZIP
- uid: azure.synapse.artifacts.models.CompressionCodec.TAR_G_ZIP
-- name: ZIP_DEFLATE
- uid: azure.synapse.artifacts.models.CompressionCodec.ZIP_DEFLATE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CompressionReadSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CompressionReadSettings.yml
deleted file mode 100644
index c8dbbf8ae484..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CompressionReadSettings.yml
+++ /dev/null
@@ -1,38 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.CompressionReadSettings
-name: CompressionReadSettings
-fullName: azure.synapse.artifacts.models.CompressionReadSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Compression read settings.
-
-
- You probably want to use the sub-classes and not this class directly. Known sub-classes
- are:
-
- TarGZipReadSettings, TarReadSettings, ZipDeflateReadSettings
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'CompressionReadSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The Compression setting type. Required.
- name: type
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurLinkedService.yml
index a78300e39b27..0b590122b9e9 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurLinkedService.yml
@@ -10,66 +10,71 @@ summary: 'Concur Service linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'ConcurLinkedService(*, client_id: MutableMapping[str, Any], username: MutableMapping[str,
- Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- connect_via: _models.IntegrationRuntimeReference | None = None, description: str
- | None = None, parameters: Dict[str, _models.ParameterSpecification] | None =
- None, annotations: List[MutableMapping[str, Any]] | None = None, connection_properties:
- MutableMapping[str, Any] | None = None, password: _models.SecretBase | None =
- None, use_encrypted_endpoints: MutableMapping[str, Any] | None = None, use_host_verification:
- MutableMapping[str, Any] | None = None, use_peer_verification: MutableMapping[str,
- Any] | None = None, encrypted_credential: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
- - name: connection_properties
- description: 'Properties used to connect to Concur. It is mutually exclusive
-
- with any other properties in the linked service. Type: object.'
- types:
- - <xref:JSON>
+ - <xref:list>[<xref:object>]
- name: client_id
- description: Application client_id supplied by Concur App Management. Required.
+ description: Required. Application client_id supplied by Concur App Management.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: username
- description: The user name that you use to access Concur Service. Required.
+ description: Required. The user name that you use to access Concur Service.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: 'The password corresponding to the user name that you provided in
- the
+ the username
- username field.'
+ field.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: use_encrypted_endpoints
- description: 'Specifies whether the data source endpoints are encrypted
+ description: 'Specifies whether the data source endpoints are encrypted using
- using HTTPS. The default value is true.'
+ HTTPS. The default value is true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_host_verification
description: 'Specifies whether to require the host name in the server''s
@@ -77,98 +82,23 @@ constructor:
default value is
true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Properties used to connect to Concur. It is mutually exclusive
-
- with any other properties in the linked service. Type: object.'
- name: connection_properties
- types:
- - <xref:JSON>
-- description: Application client_id supplied by Concur App Management. Required.
- name: client_id
- types:
- - <xref:JSON>
-- description: The user name that you use to access Concur Service. Required.
- name: username
- types:
- - <xref:JSON>
-- description: 'The password corresponding to the user name that you provided in the
- username
-
- field.'
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Specifies whether the data source endpoints are encrypted using
-
- HTTPS. The default value is true.'
- name: use_encrypted_endpoints
- types:
- - <xref:JSON>
-- 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.'
- name: use_host_verification
- types:
- - <xref:JSON>
-- description: 'Specifies whether to verify the identity of the server when
-
- connecting over SSL. The default value is true.'
- name: use_peer_verification
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurObjectDataset.yml
index e8f085c0b310..216334c4aff5 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurObjectDataset.yml
@@ -10,109 +10,70 @@ summary: 'Concur Service dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'ConcurObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The table name. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurSource.yml
deleted file mode 100644
index 745aa3053f37..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ConcurSource
-name: ConcurSource
-fullName: azure.synapse.artifacts.models.ConcurSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Concur Service source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ConcurSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConfigurationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConfigurationType.yml
deleted file mode 100644
index 62537ca49ae3..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConfigurationType.yml
+++ /dev/null
@@ -1,19 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.ConfigurationType
-name: ConfigurationType
-fullName: azure.synapse.artifacts.models.ConfigurationType
-summary: The type of the spark config.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: ConfigurationType(value, names=None, *, module=None, qualname=None, type=None,
- start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: ARTIFACT
- uid: azure.synapse.artifacts.models.ConfigurationType.ARTIFACT
-- name: CUSTOMIZED
- uid: azure.synapse.artifacts.models.ConfigurationType.CUSTOMIZED
-- name: DEFAULT
- uid: azure.synapse.artifacts.models.ConfigurationType.DEFAULT
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ControlActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ControlActivity.yml
index 470f2c5a9ea0..26b1df89a43e 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ControlActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ControlActivity.yml
@@ -8,106 +8,41 @@ inheritances:
summary: 'Base class for all control activities like IfCondition, ForEach , Until.
- You probably want to use the sub-classes and not this class directly. Known sub-classes
- are:
-
- AppendVariableActivity, ExecutePipelineActivity, FailActivity, FilterActivity, ForEachActivity,
-
- IfConditionActivity, SetVariableActivity, SwitchActivity, UntilActivity, ValidationActivity,
-
- WaitActivity, WebHookActivity
-
-
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'ControlActivity(*, name: str, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, state: str | _models.ActivityState
- | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None
- = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
- types:
- - <xref:str>
- - name: description
- description: Activity description.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopyActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopyActivity.yml
index edccfb8e1931..450fb208f508 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopyActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopyActivity.yml
@@ -10,101 +10,97 @@ summary: 'Copy activity.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'CopyActivity(*, name: str, source: _models.CopySource, sink: _models.CopySink,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, state: str | _models.ActivityState | None = None, on_inactive_mark_as:
- str | _models.ActivityOnInactiveMarkAs | None = None, depends_on: List[_models.ActivityDependency]
- | None = None, user_properties: List[_models.UserProperty] | None = None, linked_service_name:
- _models.LinkedServiceReference | None = None, policy: _models.ActivityPolicy |
- None = None, inputs: List[_models.DatasetReference] | None = None, outputs: List[_models.DatasetReference]
- | None = None, translator: MutableMapping[str, Any] | None = None, enable_staging:
- MutableMapping[str, Any] | None = None, staging_settings: _models.StagingSettings
- | None = None, parallel_copies: MutableMapping[str, Any] | None = None, data_integration_units:
- MutableMapping[str, Any] | None = None, enable_skip_incompatible_row: MutableMapping[str,
- Any] | None = None, redirect_incompatible_row_settings: _models.RedirectIncompatibleRowSettings
- | None = None, log_storage_settings: _models.LogStorageSettings | None = None,
- log_settings: _models.LogSettings | None = None, preserve_rules: List[MutableMapping[str,
- Any]] | None = None, preserve: List[MutableMapping[str, Any]] | None = None, validate_data_consistency:
- MutableMapping[str, Any] | None = None, skip_error_file: _models.SkipErrorFile
- | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
- name: inputs
description: List of inputs for the activity.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.DatasetReference>]
- name: outputs
description: List of outputs for the activity.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.DatasetReference>]
- name: source
- description: Copy activity source. Required.
+ description: Required. Copy activity source.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.CopySource>
- name: sink
- description: Copy activity sink. Required.
+ description: Required. Copy activity sink.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.CopySink>
- name: translator
description: Copy activity translator. If not specified, tabular translator is
used.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: enable_staging
description: 'Specifies whether to copy data via an interim staging. Default value
+ is
- is false. Type: boolean (or Expression with resultType boolean).'
+ false. Type: boolean (or Expression with resultType boolean).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: staging_settings
description: Specifies interim staging settings when EnableStaging is true.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.StagingSettings>
- name: parallel_copies
@@ -115,193 +111,38 @@ constructor:
integer),
minimum: 0.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: enable_skip_incompatible_row
- description: 'Whether to skip incompatible row. Default value is
+ description: 'Whether to skip incompatible row. Default value is false.
- false. Type: boolean (or Expression with resultType boolean).'
+ Type: boolean (or Expression with resultType boolean).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: redirect_incompatible_row_settings
description: 'Redirect incompatible row settings when
EnableSkipIncompatibleRow is true.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.RedirectIncompatibleRowSettings>
- - name: log_storage_settings
- description: '(Deprecated. Please use LogSettings) Log storage settings
-
- customer need to provide when enabling session log.'
- types:
- - <xref:azure.synapse.artifacts.models.LogStorageSettings>
- - name: log_settings
- description: Log settings customer needs provide when enabling log.
- types:
- - <xref:azure.synapse.artifacts.models.LogSettings>
- name: preserve_rules
description: Preserve Rules.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: preserve
description: Preserve rules.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
- - name: validate_data_consistency
- description: 'Whether to enable Data Consistency validation. Type:
-
- boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: skip_error_file
- description: Specify the fault tolerance for data consistency.
- types:
- - <xref:azure.synapse.artifacts.models.SkipErrorFile>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: List of inputs for the activity.
- name: inputs
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DatasetReference>]
-- description: List of outputs for the activity.
- name: outputs
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DatasetReference>]
-- description: Copy activity source. Required.
- name: source
- types:
- - <xref:azure.synapse.artifacts.models.CopySource>
-- description: Copy activity sink. Required.
- name: sink
- types:
- - <xref:azure.synapse.artifacts.models.CopySink>
-- description: Copy activity translator. If not specified, tabular translator is used.
- name: translator
- types:
- - <xref:JSON>
-- description: 'Specifies whether to copy data via an interim staging. Default value
- is
-
- false. Type: boolean (or Expression with resultType boolean).'
- name: enable_staging
- types:
- - <xref:JSON>
-- description: Specifies interim staging settings when EnableStaging is true.
- name: staging_settings
- types:
- - <xref:azure.synapse.artifacts.models.StagingSettings>
-- 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.'
- name: parallel_copies
- types:
- - <xref:JSON>
-- 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.'
- name: data_integration_units
- types:
- - <xref:JSON>
-- description: 'Whether to skip incompatible row. Default value is false.
-
- Type: boolean (or Expression with resultType boolean).'
- name: enable_skip_incompatible_row
- types:
- - <xref:JSON>
-- description: 'Redirect incompatible row settings when
-
- EnableSkipIncompatibleRow is true.'
- name: redirect_incompatible_row_settings
- types:
- - <xref:azure.synapse.artifacts.models.RedirectIncompatibleRowSettings>
-- description: '(Deprecated. Please use LogSettings) Log storage settings customer
-
- need to provide when enabling session log.'
- name: log_storage_settings
- types:
- - <xref:azure.synapse.artifacts.models.LogStorageSettings>
-- description: Log settings customer needs provide when enabling log.
- name: log_settings
- types:
- - <xref:azure.synapse.artifacts.models.LogSettings>
-- description: Preserve Rules.
- name: preserve_rules
- types:
- - <xref:list>[<xref:JSON>]
-- description: Preserve rules.
- name: preserve
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Whether to enable Data Consistency validation. Type: boolean
-
- (or Expression with resultType boolean).'
- name: validate_data_consistency
- types:
- - <xref:JSON>
-- description: Specify the fault tolerance for data consistency.
- name: skip_error_file
- types:
- - <xref:azure.synapse.artifacts.models.SkipErrorFile>
+ - <xref:list>[<xref:object>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopyActivityLogSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopyActivityLogSettings.yml
deleted file mode 100644
index d000e8bdc548..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopyActivityLogSettings.yml
+++ /dev/null
@@ -1,39 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.CopyActivityLogSettings
-name: CopyActivityLogSettings
-fullName: azure.synapse.artifacts.models.CopyActivityLogSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Settings for copy activity log.
-constructor:
- syntax: 'CopyActivityLogSettings(*, log_level: MutableMapping[str, Any] | None =
- None, enable_reliable_logging: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
- parameters:
- - name: log_level
- description: 'Gets or sets the log level, support: Info, Warning. Type: string
- (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: enable_reliable_logging
- description: 'Specifies whether to enable reliable logging. Type: boolean
-
- (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Gets or sets the log level, support: Info, Warning. Type: string (or
-
- Expression with resultType string).'
- name: log_level
- types:
- - <xref:JSON>
-- description: 'Specifies whether to enable reliable logging. Type: boolean (or
-
- Expression with resultType boolean).'
- name: enable_reliable_logging
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopyBehaviorType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopyBehaviorType.yml
deleted file mode 100644
index 1860ac8bffcc..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopyBehaviorType.yml
+++ /dev/null
@@ -1,19 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.CopyBehaviorType
-name: CopyBehaviorType
-fullName: azure.synapse.artifacts.models.CopyBehaviorType
-summary: All available types of copy behavior.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: CopyBehaviorType(value, names=None, *, module=None, qualname=None, type=None,
- start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: FLATTEN_HIERARCHY
- uid: azure.synapse.artifacts.models.CopyBehaviorType.FLATTEN_HIERARCHY
-- name: MERGE_FILES
- uid: azure.synapse.artifacts.models.CopyBehaviorType.MERGE_FILES
-- name: PRESERVE_HIERARCHY
- uid: azure.synapse.artifacts.models.CopyBehaviorType.PRESERVE_HIERARCHY
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySink.yml
index 5692cd4d8a98..32bb6ea4671b 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySink.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySink.yml
@@ -4,113 +4,66 @@ name: CopySink
fullName: azure.synapse.artifacts.models.CopySink
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'A copy activity sink.
- You probably want to use the sub-classes and not this class directly. Known sub-classes
- are:
+ You probably want to use the sub-classes and not this class directly. Known
- AvroSink, AzureBlobFSSink, AzureDataExplorerSink, AzureDataLakeStoreSink,
-
- AzureDatabricksDeltaLakeSink, AzureMySqlSink, AzurePostgreSqlSink, AzureQueueSink,
-
- AzureSearchIndexSink, AzureSqlSink, AzureTableSink, BinarySink, BlobSink,
-
- CommonDataServiceForAppsSink, CosmosDbMongoDbApiSink, CosmosDbSqlApiSink, DelimitedTextSink,
-
- DocumentDbCollectionSink, DynamicsCrmSink, DynamicsSink, FileSystemSink, InformixSink,
-
- JsonSink, MicrosoftAccessSink, OdbcSink, OracleSink, OrcSink, ParquetSink, RestSink,
-
- SalesforceServiceCloudSink, SalesforceSink, SapCloudForCustomerSink, SnowflakeSink,
- SqlDWSink,
-
- SqlMISink, SqlServerSink, SqlSink
+ sub-classes are: .
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'CopySink(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, write_batch_size: MutableMapping[str, Any] | None = None, write_batch_timeout:
- MutableMapping[str, Any] | None = None, sink_retry_count: MutableMapping[str,
- Any] | None = None, sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Copy sink type.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: write_batch_size
description: 'Write batch size. Type: integer (or Expression with resultType
integer), minimum: 0.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: sink_retry_count
description: 'Sink retry count. Type: integer (or Expression with resultType
integer).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySource.yml
index 96346df9910e..5007dc3f3742 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySource.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySource.yml
@@ -4,88 +4,51 @@ name: CopySource
fullName: azure.synapse.artifacts.models.CopySource
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'A copy activity source.
- You probably want to use the sub-classes and not this class directly. Known sub-classes
- are:
+ You probably want to use the sub-classes and not this class directly. Known
- AmazonRdsForOracleSource, AvroSource, AzureBlobFSSource, AzureDataExplorerSource,
-
- AzureDataLakeStoreSource, AzureDatabricksDeltaLakeSource, BinarySource, BlobSource,
-
- CommonDataServiceForAppsSource, CosmosDbMongoDbApiSource, CosmosDbSqlApiSource,
-
- DelimitedTextSource, DocumentDbCollectionSource, DynamicsCrmSource, DynamicsSource,
-
- ExcelSource, FileSystemSource, HdfsSource, HttpSource, JsonSource, MicrosoftAccessSource,
-
- MongoDbAtlasSource, MongoDbSource, MongoDbV2Source, ODataSource, Office365Source,
- OracleSource,
-
- OrcSource, ParquetSource, RelationalSource, RestSource, SalesforceServiceCloudSource,
-
- SharePointOnlineListSource, SnowflakeSource, TabularSource, WebSource, XmlSource
+ sub-classes are: .
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'CopySource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
+ 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:
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Copy source type.Constant filled by server.
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:str>
- name: source_retry_count
description: 'Source retry count. Type: integer (or Expression with resultType
integer).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
+ description: 'The maximum concurrent connection count for the source data
- data store. Type: integer (or Expression with resultType integer).'
+ store. Type: integer (or Expression with resultType integer).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopyTranslator.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopyTranslator.yml
deleted file mode 100644
index 40d998ba2fcf..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopyTranslator.yml
+++ /dev/null
@@ -1,38 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.CopyTranslator
-name: CopyTranslator
-fullName: azure.synapse.artifacts.models.CopyTranslator
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'A copy activity translator.
-
-
- You probably want to use the sub-classes and not this class directly. Known sub-classes
- are:
-
- TabularTranslator
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'CopyTranslator(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy translator type. Required.
- name: type
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbLinkedService.yml
index af9506016d79..f3b3ad142671 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbLinkedService.yml
@@ -10,137 +10,80 @@ 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, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, connection_string:
- MutableMapping[str, Any] | None = None, account_endpoint: MutableMapping[str,
- Any] | None = None, database: MutableMapping[str, Any] | None = None, account_key:
- _models.SecretBase | None = None, encrypted_credential: MutableMapping[str, Any]
- | None = None, credential: _models.CredentialReference | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
description: 'The connection string. Type: string, SecureString or
AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: account_endpoint
description: 'The endpoint of the Azure CosmosDB account. Type: string (or
Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: database
description: 'The name of the database. Type: string (or Expression with resultType
-
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: account_key
description: 'The account key of the Azure CosmosDB account. Type: SecureString
or
AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
- - name: credential
- description: The credential reference containing authentication information.
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: 'The endpoint of the Azure CosmosDB account. Type: string (or Expression
-
- with resultType string).'
- name: account_endpoint
- types:
- - <xref:JSON>
-- description: 'The name of the database. Type: string (or Expression with resultType
- string).'
- name: database
- types:
- - <xref:JSON>
-- description: 'The account key of the Azure CosmosDB account. Type: SecureString
- or
-
- AzureKeyVaultSecretReference.'
- name: account_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
-- description: The credential reference containing authentication information.
- name: credential
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset.yml
index 9d5f977bd166..d4d351506ba8 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset.yml
@@ -10,114 +10,73 @@ 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: _models.LinkedServiceReference,
- collection: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, structure: MutableMapping[str,
- Any] | None = None, schema: MutableMapping[str, Any] | None = None, parameters:
- Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str,
- Any]] | None = None, folder: _models.DatasetFolder | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: collection
- description: 'The collection name of the CosmosDB (MongoDB API) database. Type:
- string
+ description: 'Required. The collection name of the CosmosDB (MongoDB API) database.
+ Type:
- (or Expression with resultType string). Required.'
+ string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The collection name of the CosmosDB (MongoDB API) database. Type:
- string (or
-
- Expression with resultType string). Required.'
- name: collection
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService.yml
index 91dc95ba6345..ea4af375ff15 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService.yml
@@ -10,89 +10,57 @@ 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: MutableMapping[str,
- Any], database: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
- description: 'The CosmosDB (MongoDB API) connection string. Type: string,
+ description: 'Required. The CosmosDB (MongoDB API) connection string. Type: string,
SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or
- AzureKeyVaultSecretReference. Required.'
+ AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: database
- description: 'The name of the CosmosDB (MongoDB API) database that you want to
- access.
+ description: 'Required. The name of the CosmosDB (MongoDB API) database that you
+ want to
- Type: string (or Expression with resultType string). Required.'
+ access. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The CosmosDB (MongoDB API) connection string. Type: string,
-
- SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or
-
- AzureKeyVaultSecretReference. Required.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: 'The name of the CosmosDB (MongoDB API) database that you want to access.
- Type:
-
- string (or Expression with resultType string). Required.'
- name: database
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiSink.yml
deleted file mode 100644
index 625855e551d4..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiSink.yml
+++ /dev/null
@@ -1,116 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiSink
-name: CosmosDbMongoDbApiSink
-fullName: azure.synapse.artifacts.models.CosmosDbMongoDbApiSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity sink for a CosmosDB (MongoDB API) database.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'CosmosDbMongoDbApiSink(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, write_batch_size: MutableMapping[str, Any] | None = None,
- write_batch_timeout: MutableMapping[str, Any] | None = None, sink_retry_count:
- MutableMapping[str, Any] | None = None, sink_retry_wait: MutableMapping[str, Any]
- | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None,
- write_behavior: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: write_behavior
- description: 'Specifies whether the document with same key to be overwritten
-
- (upsert) rather than throw exception (insert). The default value is "insert".
- Type: string (or
-
- Expression with resultType string). Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Specifies whether the document with same key to be overwritten (upsert)
-
- rather than throw exception (insert). The default value is "insert". Type: string
- (or
-
- Expression with resultType string). Type: string (or Expression with resultType
- string).'
- name: write_behavior
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiSource.yml
deleted file mode 100644
index 7b5e30941747..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiSource.yml
+++ /dev/null
@@ -1,152 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiSource
-name: CosmosDbMongoDbApiSource
-fullName: azure.synapse.artifacts.models.CosmosDbMongoDbApiSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity source for a CosmosDB (MongoDB API) database.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'CosmosDbMongoDbApiSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, filter: MutableMapping[str, Any] | None
- = None, cursor_methods: _models.MongoDbCursorMethodsProperties | None = None,
- batch_size: MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str,
- Any] | None = None, additional_columns: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: filter
- description: 'Specifies selection filter using query operators. To return all
- documents in a
-
- collection, omit this parameter or pass an empty document ({}). Type: string
- (or Expression
-
- with resultType string).'
- types:
- - <xref:JSON>
- - name: cursor_methods
- description: Cursor methods for Mongodb query.
- types:
- - <xref:azure.synapse.artifacts.models.MongoDbCursorMethodsProperties>
- - name: batch_size
- description: 'Specifies the number of documents to return in each batch of the
- response
-
- from MongoDB instance. In most cases, modifying the batch size will not affect
- the user or the
-
- application. This property''s main purpose is to avoid hit the limitation of
- response size.
-
- Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Specifies selection filter using query operators. To return all documents
- in a
-
- collection, omit this parameter or pass an empty document ({}). Type: string (or
- Expression
-
- with resultType string).'
- name: filter
- types:
- - <xref:JSON>
-- description: Cursor methods for Mongodb query.
- name: cursor_methods
- types:
- - <xref:azure.synapse.artifacts.models.MongoDbCursorMethodsProperties>
-- description: 'Specifies the number of documents to return in each batch of the response
-
- from MongoDB instance. In most cases, modifying the batch size will not affect
- the user or the
-
- application. This property''s main purpose is to avoid hit the limitation of response
- size.
-
- Type: integer (or Expression with resultType integer).'
- name: batch_size
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset.yml
index 8c30da336baf..d6e378b9a89a 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset.yml
@@ -10,113 +10,72 @@ 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: _models.LinkedServiceReference,
- collection_name: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, structure: MutableMapping[str,
- Any] | None = None, schema: MutableMapping[str, Any] | None = None, parameters:
- Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str,
- Any]] | None = None, folder: _models.DatasetFolder | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: collection_name
- description: 'CosmosDB (SQL API) collection name. Type: string (or Expression
- with
+ description: 'Required. CosmosDB (SQL API) collection name. Type: string (or
- resultType string). Required.'
+ Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'CosmosDB (SQL API) collection name. Type: string (or Expression with
-
- resultType string). Required.'
- name: collection_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbSqlApiSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbSqlApiSink.yml
deleted file mode 100644
index cbd251764d6e..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbSqlApiSink.yml
+++ /dev/null
@@ -1,108 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.CosmosDbSqlApiSink
-name: CosmosDbSqlApiSink
-fullName: azure.synapse.artifacts.models.CosmosDbSqlApiSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Azure CosmosDB (SQL API) Collection sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'CosmosDbSqlApiSink(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, write_batch_size: MutableMapping[str, Any] | None = None,
- write_batch_timeout: MutableMapping[str, Any] | None = None, sink_retry_count:
- MutableMapping[str, Any] | None = None, sink_retry_wait: MutableMapping[str, Any]
- | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None,
- write_behavior: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: write_behavior
- description: 'Describes how to write data to Azure Cosmos DB. Type: string (or
-
- Expression with resultType string). Allowed values: insert and upsert.'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Describes how to write data to Azure Cosmos DB. Type: string (or
-
- Expression with resultType string). Allowed values: insert and upsert.'
- name: write_behavior
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbSqlApiSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbSqlApiSource.yml
deleted file mode 100644
index 7705f6ac11b0..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbSqlApiSource.yml
+++ /dev/null
@@ -1,133 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.CosmosDbSqlApiSource
-name: CosmosDbSqlApiSource
-fullName: azure.synapse.artifacts.models.CosmosDbSqlApiSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity Azure CosmosDB (SQL API) Collection source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'CosmosDbSqlApiSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, page_size: MutableMapping[str, Any] | None = None, preferred_regions:
- MutableMapping[str, Any] | None = None, detect_datetime: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query
- description: 'SQL API query. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: page_size
- description: 'Page size of the result. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - name: preferred_regions
- description: 'Preferred regions. Type: array of strings (or Expression with
-
- resultType array of strings).'
- types:
- - <xref:JSON>
- - name: detect_datetime
- description: 'Whether detect primitive values as datetime values. Type: boolean
- (or
-
- Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'SQL API query. Type: string (or Expression with resultType string).'
- name: query
- types:
- - <xref:JSON>
-- description: 'Page size of the result. Type: integer (or Expression with resultType
-
- integer).'
- name: page_size
- types:
- - <xref:JSON>
-- description: 'Preferred regions. Type: array of strings (or Expression with
-
- resultType array of strings).'
- name: preferred_regions
- types:
- - <xref:JSON>
-- description: 'Whether detect primitive values as datetime values. Type: boolean
- (or
-
- Expression with resultType boolean).'
- name: detect_datetime
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseLinkedService.yml
index 9fc07f4ec020..136242681df4 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseLinkedService.yml
@@ -10,99 +10,65 @@ summary: 'Couchbase server linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'CouchbaseLinkedService(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, connection_string:
- MutableMapping[str, Any] | None = None, cred_string: _models.AzureKeyVaultSecretReference
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
description: 'An ODBC connection string. Type: string, SecureString or
AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: cred_string
description: The Azure key vault secret reference of credString in connection
string.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'An ODBC connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of credString in connection string.
- name: cred_string
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseSource.yml
deleted file mode 100644
index 14a329fadabe..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.CouchbaseSource
-name: CouchbaseSource
-fullName: azure.synapse.artifacts.models.CouchbaseSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Couchbase server source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'CouchbaseSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, query:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseTableDataset.yml
index 55551dd98d36..218e3b35c306 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseTableDataset.yml
@@ -10,109 +10,70 @@ summary: 'Couchbase server dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'CouchbaseTableDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The table name. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest.yml
index 2aa38c1fd82a..fe15572c21a5 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest.yml
@@ -4,57 +4,41 @@ name: CreateDataFlowDebugSessionRequest
fullName: azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: Request body structure for creating data flow debug session.
constructor:
- syntax: 'CreateDataFlowDebugSessionRequest(*, compute_type: str | None = None, core_count:
- int | None = None, time_to_live: int | None = None, integration_runtime: _models.IntegrationRuntimeDebugResource
- | None = None, **kwargs: Any)'
+ 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: compute_type
- description: 'Compute type of the cluster. The value will be overwritten by the
- same
-
- setting in integration runtime if provided.'
+ - name: data_flow_name
+ description: The name of the data flow.
+ isRequired: true
types:
- <xref:str>
- - name: core_count
- description: 'Core count of the cluster. The value will be overwritten by the
- same
-
- setting in integration runtime if provided.'
+ - name: existing_cluster_id
+ description: The ID of existing Databricks cluster.
+ isRequired: true
types:
- - <xref:int>
- - name: time_to_live
- description: Time to live setting of the cluster in minutes.
+ - <xref:str>
+ - name: cluster_timeout
+ description: Timeout setting for Databricks cluster.
+ isRequired: true
types:
- <xref:int>
- - name: integration_runtime
- description: 'Set to use integration runtime setting for data flow debug
-
- session.'
+ - name: new_cluster_name
+ description: The name of new Databricks cluster.
+ isRequired: true
+ types:
+ - <xref:str>
+ - name: new_cluster_node_type
+ description: The type of new Databricks cluster.
+ isRequired: true
+ types:
+ - <xref:str>
+ - name: data_bricks_linked_service
+ description: Data bricks linked service.
+ isRequired: true
types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeDebugResource>
-variables:
-- description: 'Compute type of the cluster. The value will be overwritten by the
- same
-
- setting in integration runtime if provided.'
- name: compute_type
- types:
- - <xref:str>
-- description: 'Core count of the cluster. The value will be overwritten by the same
- setting
-
- in integration runtime if provided.'
- name: core_count
- types:
- - <xref:int>
-- description: Time to live setting of the cluster in minutes.
- name: time_to_live
- types:
- - <xref:int>
-- description: Set to use integration runtime setting for data flow debug session.
- name: integration_runtime
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeDebugResource>
+ - <xref:azure.synapse.artifacts.models.LinkedServiceResource>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse.yml
index 3b17e9bc97e5..058cd61fb22b 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse.yml
@@ -4,18 +4,13 @@ name: CreateDataFlowDebugSessionResponse
fullName: azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: Response body structure for creating data flow debug session.
constructor:
- syntax: 'CreateDataFlowDebugSessionResponse(*, session_id: str | None = None, **kwargs:
- Any)'
+ syntax: 'CreateDataFlowDebugSessionResponse(*, session_id: str | None = None, **kwargs)'
parameters:
- name: session_id
description: The ID of data flow debug session.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: The ID of data flow debug session.
- name: session_id
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateMode.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateMode.yml
deleted file mode 100644
index aa6e15906f5f..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateMode.yml
+++ /dev/null
@@ -1,46 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.CreateMode
-name: CreateMode
-fullName: azure.synapse.artifacts.models.CreateMode
-summary: 'Specifies the mode of sql pool creation.
-
-
- Default: regular sql pool creation.
-
-
- PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an
- existing sql
-
- pool. sourceDatabaseId must be specified as the resource ID of the existing sql
- pool, and
-
- restorePointInTime must be specified.
-
-
- Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must
- be specified as
-
- the recoverableDatabaseId to restore.
-
-
- Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId
-
- should be the sql pool''s original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate
-
- must be specified.'
-module: azure.synapse.artifacts.models
-constructor:
- syntax: CreateMode(value, names=None, *, module=None, qualname=None, type=None,
- start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: DEFAULT
- uid: azure.synapse.artifacts.models.CreateMode.DEFAULT
-- name: POINT_IN_TIME_RESTORE
- uid: azure.synapse.artifacts.models.CreateMode.POINT_IN_TIME_RESTORE
-- name: RECOVERY
- uid: azure.synapse.artifacts.models.CreateMode.RECOVERY
-- name: RESTORE
- uid: azure.synapse.artifacts.models.CreateMode.RESTORE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateRunResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateRunResponse.yml
index d91e725cd432..9ed8c43298af 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateRunResponse.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateRunResponse.yml
@@ -4,20 +4,16 @@ name: CreateRunResponse
fullName: azure.synapse.artifacts.models.CreateRunResponse
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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: Any)'
+ syntax: 'CreateRunResponse(*, run_id: str, **kwargs)'
parameters:
- name: run_id
- description: Identifier of a run. Required.
+ description: Required. Identifier of a run.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: Identifier of a run. Required.
- name: run_id
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CredentialReference.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CredentialReference.yml
deleted file mode 100644
index 799baeb60409..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CredentialReference.yml
+++ /dev/null
@@ -1,47 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.CredentialReference
-name: CredentialReference
-fullName: azure.synapse.artifacts.models.CredentialReference
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Credential reference type.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'CredentialReference(*, type: str | _models.CredentialReferenceType, reference_name:
- str, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: type
- description: Credential reference type. Required. "CredentialReference"
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.CredentialReferenceType>
- - name: reference_name
- description: Reference credential name. Required.
- types:
- - <xref:str>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Credential reference type. Required. "CredentialReference"
- name: type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.CredentialReferenceType>
-- description: Reference credential name. Required.
- name: reference_name
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CredentialReferenceType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CredentialReferenceType.yml
deleted file mode 100644
index 5d3f41caefd1..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CredentialReferenceType.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.CredentialReferenceType
-name: CredentialReferenceType
-fullName: azure.synapse.artifacts.models.CredentialReferenceType
-summary: Credential reference type.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: CredentialReferenceType(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: CREDENTIAL_REFERENCE
- uid: azure.synapse.artifacts.models.CredentialReferenceType.CREDENTIAL_REFERENCE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivity.yml
index 5997ac55d876..0deda72ae898 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivity.yml
@@ -10,84 +10,80 @@ summary: 'Custom activity type.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'CustomActivity(*, name: str, command: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None,
- state: str | _models.ActivityState | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs
- | None = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, linked_service_name: _models.LinkedServiceReference
- | None = None, policy: _models.ActivityPolicy | None = None, resource_linked_service:
- _models.LinkedServiceReference | None = None, folder_path: MutableMapping[str,
- Any] | None = None, reference_objects: _models.CustomActivityReferenceObject |
- None = None, extended_properties: Dict[str, MutableMapping[str, Any]] | None =
- None, retention_time_in_days: MutableMapping[str, Any] | None = None, auto_user_specification:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
- name: command
- description: 'Command for custom activity Type: string (or Expression with resultType
+ description: 'Required. Command for custom activity Type: string (or Expression
+ with
- string). Required.'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: resource_linked_service
description: Resource linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: folder_path
description: 'Folder path for resource files Type: string (or Expression with
+ resultType
- resultType string).'
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: reference_objects
description: Reference objects.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.CustomActivityReferenceObject>
- name: extended_properties
@@ -97,112 +93,13 @@ constructor:
to
consume and interpret the content defined.'
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: retention_time_in_days
- description: 'The retention time for the files submitted for custom
+ description: 'The retention time for the files submitted for custom activity.
- activity. Type: double (or Expression with resultType double).'
+ Type: double (or Expression with resultType double).'
+ isRequired: true
types:
- - <xref:JSON>
- - name: auto_user_specification
- description: 'Elevation level and scope for the user, default is nonadmin
-
- task. Type: string (or Expression with resultType double).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: 'Command for custom activity Type: string (or Expression with resultType
- string).
-
- Required.'
- name: command
- types:
- - <xref:JSON>
-- description: Resource linked service reference.
- name: resource_linked_service
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: 'Folder path for resource files Type: string (or Expression with resultType
-
- string).'
- name: folder_path
- types:
- - <xref:JSON>
-- description: Reference objects.
- name: reference_objects
- types:
- - <xref:azure.synapse.artifacts.models.CustomActivityReferenceObject>
-- 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.'
- name: extended_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: 'The retention time for the files submitted for custom activity.
-
- Type: double (or Expression with resultType double).'
- name: retention_time_in_days
- types:
- - <xref:JSON>
-- description: 'Elevation level and scope for the user, default is nonadmin
-
- task. Type: string (or Expression with resultType double).'
- name: auto_user_specification
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivityReferenceObject.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivityReferenceObject.yml
index 15f44399d79d..93cc4df9c847 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivityReferenceObject.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivityReferenceObject.yml
@@ -4,27 +4,19 @@ name: CustomActivityReferenceObject
fullName: azure.synapse.artifacts.models.CustomActivityReferenceObject
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: Reference objects for custom activity.
constructor:
- syntax: 'CustomActivityReferenceObject(*, linked_services: List[_models.LinkedServiceReference]
- | None = None, datasets: List[_models.DatasetReference] | None = None, **kwargs:
- Any)'
+ 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:
- <xref:list>[<xref:azure.synapse.artifacts.models.LinkedServiceReference>]
- name: datasets
description: Dataset references.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.DatasetReference>]
-variables:
-- description: Linked service references.
- name: linked_services
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.LinkedServiceReference>]
-- description: Dataset references.
- name: datasets
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DatasetReference>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomDataSourceLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomDataSourceLinkedService.yml
index 0e2b906e49c2..96d383f6a580 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomDataSourceLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomDataSourceLinkedService.yml
@@ -10,66 +10,45 @@ summary: 'Custom linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'CustomDataSourceLinkedService(*, type_properties: MutableMapping[str, Any],
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, connect_via:
- _models.IntegrationRuntimeReference | None = None, description: str | None = None,
- parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations:
- List[MutableMapping[str, Any]] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: type_properties
- description: Custom linked service properties. Required.
+ description: Required. Custom linked service properties.
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: Custom linked service properties. Required.
- name: type_properties
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomDataset.yml
deleted file mode 100644
index 1e64b870e696..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomDataset.yml
+++ /dev/null
@@ -1,118 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.CustomDataset
-name: CustomDataset
-fullName: azure.synapse.artifacts.models.CustomDataset
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.Dataset
-summary: 'The custom dataset.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'CustomDataset(*, linked_service_name: _models.LinkedServiceReference, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None,
- structure: MutableMapping[str, Any] | None = None, schema: MutableMapping[str,
- Any] | None = None, parameters: Dict[str, _models.ParameterSpecification] | None
- = None, annotations: List[MutableMapping[str, Any]] | None = None, folder: _models.DatasetFolder
- | None = None, type_properties: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Dataset description.
- types:
- - <xref:str>
- - name: structure
- description: 'Columns that define the structure of the dataset. Type: array (or
-
- Expression with resultType array), itemType: DatasetDataElement.'
- types:
- - <xref:JSON>
- - name: schema
- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- types:
- - <xref:JSON>
- - name: linked_service_name
- description: Linked service reference. Required.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: parameters
- description: Parameters for dataset.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the Dataset.
- types:
- - <xref:list>[<xref:JSON>]
- - name: folder
- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
-
- the root level.'
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
- - name: type_properties
- description: Custom dataset properties.
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: Custom dataset properties.
- name: type_properties
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomEventsTrigger.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomEventsTrigger.yml
deleted file mode 100644
index fcbbbe64cce9..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomEventsTrigger.yml
+++ /dev/null
@@ -1,112 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.CustomEventsTrigger
-name: CustomEventsTrigger
-fullName: azure.synapse.artifacts.models.CustomEventsTrigger
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.MultiplePipelineTrigger
-summary: 'Trigger that runs every time a custom event is received.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'CustomEventsTrigger(*, events: List[MutableMapping[str, Any]], scope: str,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, annotations: List[MutableMapping[str, Any]] | None = None,
- pipelines: List[_models.TriggerPipelineReference] | None = None, subject_begins_with:
- str | None = None, subject_ends_with: str | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Trigger description.
- types:
- - <xref:str>
- - name: annotations
- description: List of tags that can be used for describing the trigger.
- types:
- - <xref:list>[<xref:JSON>]
- - name: pipelines
- description: Pipelines that need to be started.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.TriggerPipelineReference>]
- - name: subject_begins_with
- description: 'The event subject must begin with the pattern provided for
-
- trigger to fire. At least one of these must be provided: subjectBeginsWith,
- subjectEndsWith.'
- types:
- - <xref:str>
- - name: subject_ends_with
- description: 'The event subject must end with the pattern provided for trigger
- to
-
- fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith.'
- types:
- - <xref:str>
- - name: events
- description: The list of event types that cause this trigger to fire. Required.
- types:
- - <xref:list>[<xref:JSON>]
- - name: scope
- description: The ARM resource ID of the Azure Event Grid Topic. Required.
- types:
- - <xref:str>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Trigger type. Required.
- name: type
- types:
- - <xref:str>
-- description: Trigger description.
- name: description
- types:
- - <xref:str>
-- description: 'Indicates if trigger is running or not. Updated when Start/Stop APIs
- are
-
- called on the Trigger. Known values are: "Started", "Stopped", and "Disabled".'
- name: runtime_state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.TriggerRuntimeState>
-- description: List of tags that can be used for describing the trigger.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: Pipelines that need to be started.
- name: pipelines
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.TriggerPipelineReference>]
-- description: 'The event subject must begin with the pattern provided for trigger
-
- to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith.'
- name: subject_begins_with
- types:
- - <xref:str>
-- description: 'The event subject must end with the pattern provided for trigger to
-
- fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith.'
- name: subject_ends_with
- types:
- - <xref:str>
-- description: The list of event types that cause this trigger to fire. Required.
- name: events
- types:
- - <xref:list>[<xref:JSON>]
-- description: The ARM resource ID of the Azure Event Grid Topic. Required.
- name: scope
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomSetupBase.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomSetupBase.yml
deleted file mode 100644
index 72050cd33263..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomSetupBase.yml
+++ /dev/null
@@ -1,18 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.CustomSetupBase
-name: CustomSetupBase
-fullName: azure.synapse.artifacts.models.CustomSetupBase
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'The base definition of the custom setup.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'CustomSetupBase(**kwargs: Any)'
-variables:
-- description: The type of custom setup. Required.
- name: type
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomerManagedKeyDetails.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomerManagedKeyDetails.yml
deleted file mode 100644
index a7aeabcd2bf1..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomerManagedKeyDetails.yml
+++ /dev/null
@@ -1,28 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.CustomerManagedKeyDetails
-name: CustomerManagedKeyDetails
-fullName: azure.synapse.artifacts.models.CustomerManagedKeyDetails
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Details of the customer managed key associated with the workspace.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.'
-constructor:
- syntax: 'CustomerManagedKeyDetails(*, key: _models.WorkspaceKeyDetails | None =
- None, **kwargs: Any)'
- parameters:
- - name: key
- description: The key object of the workspace.
- types:
- - <xref:azure.synapse.artifacts.models.WorkspaceKeyDetails>
-variables:
-- description: The customer managed key status on the workspace.
- name: status
- types:
- - <xref:str>
-- description: The key object of the workspace.
- name: key
- types:
- - <xref:azure.synapse.artifacts.models.WorkspaceKeyDetails>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DWCopyCommandDefaultValue.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DWCopyCommandDefaultValue.yml
deleted file mode 100644
index 32befa84499e..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DWCopyCommandDefaultValue.yml
+++ /dev/null
@@ -1,33 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.DWCopyCommandDefaultValue
-name: DWCopyCommandDefaultValue
-fullName: azure.synapse.artifacts.models.DWCopyCommandDefaultValue
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Default value.
-constructor:
- syntax: 'DWCopyCommandDefaultValue(*, column_name: MutableMapping[str, Any] | None
- = None, default_value: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: column_name
- description: 'Column name. Type: object (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: default_value
- description: 'The default value of the column. Type: object (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Column name. Type: object (or Expression with resultType string).'
- name: column_name
- types:
- - <xref:JSON>
-- description: 'The default value of the column. Type: object (or Expression with
-
- resultType string).'
- name: default_value
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DWCopyCommandSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DWCopyCommandSettings.yml
deleted file mode 100644
index 68fdd3628109..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DWCopyCommandSettings.yml
+++ /dev/null
@@ -1,56 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.DWCopyCommandSettings
-name: DWCopyCommandSettings
-fullName: azure.synapse.artifacts.models.DWCopyCommandSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: DW Copy Command settings.
-constructor:
- syntax: 'DWCopyCommandSettings(*, default_values: List[_models.DWCopyCommandDefaultValue]
- | None = None, additional_options: Dict[str, str] | None = None, **kwargs: Any)'
- parameters:
- - name: default_values
- description: 'Specifies the default values for each target column in SQL DW. The
-
- default values in the property overwrite the DEFAULT constraint set in the DB,
- and identity
-
- column cannot have a default value. Type: array of objects (or Expression with
- resultType array
-
- of objects).'
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DWCopyCommandDefaultValue>]
- - name: additional_options
- description: 'Additional options directly passed to SQL DW in Copy Command.
-
- Type: key value pairs (value should be string type) (or Expression with resultType
- object).
-
- Example: "additionalOptions": { "MAXERRORS": "1000", "DATEFORMAT": "''ymd''"
- }.'
- types:
- - <xref:dict>[<xref:str>, <xref:str>]
-variables:
-- description: 'Specifies the default values for each target column in SQL DW. The
-
- default values in the property overwrite the DEFAULT constraint set in the DB,
- and identity
-
- column cannot have a default value. Type: array of objects (or Expression with
- resultType array
-
- of objects).'
- name: default_values
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DWCopyCommandDefaultValue>]
-- description: 'Additional options directly passed to SQL DW in Copy Command. Type:
-
- key value pairs (value should be string type) (or Expression with resultType object).
- Example:
-
- "additionalOptions": { "MAXERRORS": "1000", "DATEFORMAT": "''ymd''" }.'
- name: additional_options
- types:
- - <xref:dict>[<xref:str>, <xref:str>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlow.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlow.yml
index c36f68830363..98d9bac53eee 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlow.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlow.yml
@@ -4,54 +4,41 @@ name: DataFlow
fullName: azure.synapse.artifacts.models.DataFlow
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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:
+ You probably want to use the sub-classes and not this class directly. Known
- Flowlet, MappingDataFlow
+ 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[MutableMapping[str,
- Any]] | None = None, folder: _models.DataFlowFolder | None = None, **kwargs: Any)'
+ 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:
+ - <xref:str>
- name: description
description: The description of the data flow.
+ isRequired: true
types:
- <xref:str>
- name: annotations
description: List of tags that can be used for describing the data flow.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this data flow is in. If not specified, Data flow
- will appear
+ will appear at
- at the root level.'
+ the root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DataFlowFolder>
-variables:
-- description: Type of data flow. Required.
- name: type
- types:
- - <xref:str>
-- description: The description of the data flow.
- name: description
- types:
- - <xref:str>
-- description: List of tags that can be used for describing the data flow.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this data flow is in. If not specified, Data flow
- will appear at
-
- the root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DataFlowFolder>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowComputeType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowComputeType.yml
index b30199c6615a..5d7224f20686 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowComputeType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowComputeType.yml
@@ -11,9 +11,9 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandPayload.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandPayload.yml
deleted file mode 100644
index d2fa6cde9f78..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandPayload.yml
+++ /dev/null
@@ -1,49 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.DataFlowDebugCommandPayload
-name: DataFlowDebugCommandPayload
-fullName: azure.synapse.artifacts.models.DataFlowDebugCommandPayload
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Structure of command payload.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'DataFlowDebugCommandPayload(*, stream_name: str, row_limits: int | None
- = None, columns: List[str] | None = None, expression: str | None = None, **kwargs:
- Any)'
- parameters:
- - name: stream_name
- description: The stream name which is used for preview. Required.
- types:
- - <xref:str>
- - name: row_limits
- description: Row limits for preview response.
- types:
- - <xref:int>
- - name: columns
- description: Array of column names.
- types:
- - <xref:list>[<xref:str>]
- - name: expression
- description: The expression which is used for preview.
- types:
- - <xref:str>
-variables:
-- description: The stream name which is used for preview. Required.
- name: stream_name
- types:
- - <xref:str>
-- description: Row limits for preview response.
- name: row_limits
- types:
- - <xref:int>
-- description: Array of column names.
- name: columns
- types:
- - <xref:list>[<xref:str>]
-- description: The expression which is used for preview.
- name: expression
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandRequest.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandRequest.yml
index be665a0ea79a..7ccaecd0ce0c 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandRequest.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandRequest.yml
@@ -4,41 +4,30 @@ name: DataFlowDebugCommandRequest
fullName: azure.synapse.artifacts.models.DataFlowDebugCommandRequest
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: Request body structure for data flow expression preview.
constructor:
- syntax: 'DataFlowDebugCommandRequest(*, session_id: str | None = None, command:
- str | _models.DataFlowDebugCommandType | None = None, command_payload: _models.DataFlowDebugCommandPayload
- | None = None, **kwargs: Any)'
+ 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:
- <xref:str>
- - name: command
- description: 'The command type. Known values are: "executePreviewQuery",
-
- "executeStatisticsQuery", and "executeExpressionQuery".'
+ - name: data_flow_name
+ description: The data flow which contains the debug session.
+ isRequired: true
+ types:
+ - <xref:str>
+ - name: command_name
+ description: The command name.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.DataFlowDebugCommandType>
- name: command_payload
description: The command payload object.
+ isRequired: true
types:
- - <xref:azure.synapse.artifacts.models.DataFlowDebugCommandPayload>
-variables:
-- description: The ID of data flow debug session.
- name: session_id
- types:
- - <xref:str>
-- description: 'The command type. Known values are: "executePreviewQuery",
-
- "executeStatisticsQuery", and "executeExpressionQuery".'
- name: command
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.DataFlowDebugCommandType>
-- description: The command payload object.
- name: command_payload
- types:
- - <xref:azure.synapse.artifacts.models.DataFlowDebugCommandPayload>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandResponse.yml
index e22c68340870..f4db27008933 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandResponse.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandResponse.yml
@@ -4,27 +4,20 @@ name: DataFlowDebugCommandResponse
fullName: azure.synapse.artifacts.models.DataFlowDebugCommandResponse
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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: Any)'
+ None = None, **kwargs)'
parameters:
- name: status
description: The run status of data preview, statistics or expression preview.
+ isRequired: true
types:
- <xref:str>
- name: data
description: The result data of data preview, statistics or expression preview.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: The run status of data preview, statistics or expression preview.
- name: status
- types:
- - <xref:str>
-- description: The result data of data preview, statistics or expression preview.
- name: data
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandType.yml
deleted file mode 100644
index 4d571efbcb2e..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandType.yml
+++ /dev/null
@@ -1,19 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.DataFlowDebugCommandType
-name: DataFlowDebugCommandType
-fullName: azure.synapse.artifacts.models.DataFlowDebugCommandType
-summary: The command type.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: DataFlowDebugCommandType(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: EXECUTE_EXPRESSION_QUERY
- uid: azure.synapse.artifacts.models.DataFlowDebugCommandType.EXECUTE_EXPRESSION_QUERY
-- name: EXECUTE_PREVIEW_QUERY
- uid: azure.synapse.artifacts.models.DataFlowDebugCommandType.EXECUTE_PREVIEW_QUERY
-- name: EXECUTE_STATISTICS_QUERY
- uid: azure.synapse.artifacts.models.DataFlowDebugCommandType.EXECUTE_STATISTICS_QUERY
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackage.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackage.yml
index 9cf859ca0574..8c76eca991e2 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackage.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackage.yml
@@ -4,82 +4,49 @@ name: DataFlowDebugPackage
fullName: azure.synapse.artifacts.models.DataFlowDebugPackage
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: Request body structure for starting data flow debug session.
constructor:
- syntax: 'DataFlowDebugPackage(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, session_id: str | None = None, data_flow: _models.DataFlowDebugResource
- | None = None, data_flows: List[_models.DataFlowDebugResource] | None = None,
- datasets: List[_models.DatasetDebugResource] | None = None, linked_services: List[_models.LinkedServiceDebugResource]
- | None = None, staging: _models.DataFlowStagingInfo | None = None, debug_settings:
- _models.DataFlowDebugPackageDebugSettings | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: session_id
description: The ID of data flow debug session.
+ isRequired: true
types:
- <xref:str>
- name: data_flow
description: Data flow instance.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DataFlowDebugResource>
- - name: data_flows
- description: List of Data flows.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DataFlowDebugResource>]
- name: datasets
description: List of datasets.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.DatasetDebugResource>]
- name: linked_services
description: List of linked services.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.LinkedServiceDebugResource>]
- name: staging
description: Staging info for debug session.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DataFlowStagingInfo>
- name: debug_settings
description: Data flow debug settings.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The ID of data flow debug session.
- name: session_id
- types:
- - <xref:str>
-- description: Data flow instance.
- name: data_flow
- types:
- - <xref:azure.synapse.artifacts.models.DataFlowDebugResource>
-- description: List of Data flows.
- name: data_flows
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DataFlowDebugResource>]
-- description: List of datasets.
- name: datasets
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DatasetDebugResource>]
-- description: List of linked services.
- name: linked_services
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.LinkedServiceDebugResource>]
-- description: Staging info for debug session.
- name: staging
- types:
- - <xref:azure.synapse.artifacts.models.DataFlowStagingInfo>
-- description: Data flow debug settings.
- name: debug_settings
- types:
- - <xref:azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings.yml
index 230f14e76fe0..fdd8aec2ed5f 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings.yml
@@ -4,35 +4,25 @@ name: DataFlowDebugPackageDebugSettings
fullName: azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: Data flow debug settings.
constructor:
- syntax: 'DataFlowDebugPackageDebugSettings(*, source_settings: List[_models.DataFlowSourceSetting]
- | None = None, parameters: Dict[str, MutableMapping[str, Any]] | None = None,
- dataset_parameters: MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- <xref:list>[<xref:azure.synapse.artifacts.models.DataFlowSourceSetting>]
- name: parameters
description: Data flow parameters.
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: dataset_parameters
description: Parameters for dataset.
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: Source setting for data flow debug.
- name: source_settings
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DataFlowSourceSetting>]
-- description: Data flow parameters.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Parameters for dataset.
- name: dataset_parameters
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest.yml
index 7aa7435039cc..5ce50771edd8 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest.yml
@@ -4,43 +4,30 @@ name: DataFlowDebugPreviewDataRequest
fullName: azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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: Any)'
+ **kwargs)'
parameters:
- name: session_id
description: The ID of data flow debug session.
+ isRequired: true
types:
- <xref:str>
- name: data_flow_name
description: The data flow which contains the debug session.
+ isRequired: true
types:
- <xref:str>
- name: stream_name
description: The output stream name.
+ isRequired: true
types:
- <xref:str>
- name: row_limits
description: The row limit for preview request.
+ isRequired: true
types:
- <xref:int>
-variables:
-- description: The ID of data flow debug session.
- name: session_id
- types:
- - <xref:str>
-- description: The data flow which contains the debug session.
- name: data_flow_name
- types:
- - <xref:str>
-- description: The output stream name.
- name: stream_name
- types:
- - <xref:str>
-- description: The row limit for preview request.
- name: row_limits
- types:
- - <xref:int>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugQueryResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugQueryResponse.yml
index 685f14839d9b..7141ef3d5b65 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugQueryResponse.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugQueryResponse.yml
@@ -4,18 +4,14 @@ name: DataFlowDebugQueryResponse
fullName: azure.synapse.artifacts.models.DataFlowDebugQueryResponse
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: Response body structure of data flow query for data preview, statistics or
expression preview.
constructor:
- syntax: 'DataFlowDebugQueryResponse(*, run_id: str | None = None, **kwargs: Any)'
+ syntax: 'DataFlowDebugQueryResponse(*, run_id: str | None = None, **kwargs)'
parameters:
- name: run_id
description: The run ID of data flow debug session.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: The run ID of data flow debug session.
- name: run_id
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResource.yml
index 252148e779eb..0d26d33606d0 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResource.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResource.yml
@@ -10,23 +10,16 @@ summary: 'Data flow debug resource.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'DataFlowDebugResource(*, properties: _models.DataFlow, name: str | None
- = None, **kwargs: Any)'
+ syntax: 'DataFlowDebugResource(*, properties: DataFlow, name: str | None = None,
+ **kwargs)'
parameters:
- name: name
description: The resource name.
+ isRequired: true
types:
- <xref:str>
- name: properties
- description: Data flow properties. Required.
+ description: Required. Data flow properties.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DataFlow>
-variables:
-- description: The resource name.
- name: name
- types:
- - <xref:str>
-- description: Data flow properties. Required.
- name: properties
- types:
- - <xref:azure.synapse.artifacts.models.DataFlow>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResultResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResultResponse.yml
index d8e8c63fd5eb..6eb81c94728f 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResultResponse.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResultResponse.yml
@@ -4,27 +4,20 @@ name: DataFlowDebugResultResponse
fullName: azure.synapse.artifacts.models.DataFlowDebugResultResponse
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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: Any)'
+ = None, **kwargs)'
parameters:
- name: status
description: The run status of data preview, statistics or expression preview.
+ isRequired: true
types:
- <xref:str>
- name: data
description: The result data of data preview, statistics or expression preview.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: The run status of data preview, statistics or expression preview.
- name: status
- types:
- - <xref:str>
-- description: The result data of data preview, statistics or expression preview.
- name: data
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugSessionInfo.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugSessionInfo.yml
index 6ad58dabe442..4d8ae16b722a 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugSessionInfo.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugSessionInfo.yml
@@ -4,100 +4,65 @@ name: DataFlowDebugSessionInfo
fullName: azure.synapse.artifacts.models.DataFlowDebugSessionInfo
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: Data flow debug session info.
constructor:
- syntax: 'DataFlowDebugSessionInfo(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | 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:
+ 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: Any)'
+ **kwargs)'
parameters:
- name: additional_properties
description: 'Unmatched properties from the message are deserialized to this
collection.'
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: data_flow_name
description: The name of the data flow.
+ isRequired: true
types:
- <xref:str>
- name: compute_type
description: Compute type of the cluster.
+ isRequired: true
types:
- <xref:str>
- name: core_count
description: Core count of the cluster.
+ isRequired: true
types:
- <xref:int>
- name: node_count
description: Node count of the cluster. (deprecated property).
+ isRequired: true
types:
- <xref:int>
- name: integration_runtime_name
- description: 'Attached integration runtime name of data flow debug
-
- session.'
+ description: Attached integration runtime name of data flow debug session.
+ isRequired: true
types:
- <xref:str>
- name: session_id
description: The ID of data flow debug session.
+ isRequired: true
types:
- <xref:str>
- name: start_time
description: Start time of data flow debug session.
+ isRequired: true
types:
- <xref:str>
- name: time_to_live_in_minutes
description: Compute type of the cluster.
+ isRequired: true
types:
- <xref:int>
- name: last_activity_time
description: Last activity time of data flow debug session.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The name of the data flow.
- name: data_flow_name
- types:
- - <xref:str>
-- description: Compute type of the cluster.
- name: compute_type
- types:
- - <xref:str>
-- description: Core count of the cluster.
- name: core_count
- types:
- - <xref:int>
-- description: Node count of the cluster. (deprecated property).
- name: node_count
- types:
- - <xref:int>
-- description: Attached integration runtime name of data flow debug session.
- name: integration_runtime_name
- types:
- - <xref:str>
-- description: The ID of data flow debug session.
- name: session_id
- types:
- - <xref:str>
-- description: Start time of data flow debug session.
- name: start_time
- types:
- - <xref:str>
-- description: Compute type of the cluster.
- name: time_to_live_in_minutes
- types:
- - <xref:int>
-- description: Last activity time of data flow debug session.
- name: last_activity_time
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest.yml
index 7242f9dac835..6d43bb0d8a6e 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest.yml
@@ -4,43 +4,30 @@ name: DataFlowDebugStatisticsRequest
fullName: azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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: Any)'
+ None, **kwargs)'
parameters:
- name: session_id
description: The ID of data flow debug session.
+ isRequired: true
types:
- <xref:str>
- name: data_flow_name
description: The data flow which contains the debug session.
+ isRequired: true
types:
- <xref:str>
- name: stream_name
description: The output stream name.
+ isRequired: true
types:
- <xref:str>
- name: columns
description: List of column names.
+ isRequired: true
types:
- <xref:list>[<xref:str>]
-variables:
-- description: The ID of data flow debug session.
- name: session_id
- types:
- - <xref:str>
-- description: The data flow which contains the debug session.
- name: data_flow_name
- types:
- - <xref:str>
-- description: The output stream name.
- name: stream_name
- types:
- - <xref:str>
-- description: List of column names.
- name: columns
- types:
- - <xref:list>[<xref:str>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowFolder.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowFolder.yml
index 3eb56d430c24..f908722879d8 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowFolder.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowFolder.yml
@@ -4,20 +4,14 @@ name: DataFlowFolder
fullName: azure.synapse.artifacts.models.DataFlowFolder
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'The folder that this data flow is in. If not specified, Data flow will appear
- at the root
-
- level.'
+- msrest.serialization.Model
+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: Any)'
+ 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:
- <xref:str>
-variables:
-- description: The name of the folder that this data flow is in.
- name: name
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowListResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowListResponse.yml
index ba6c221d39cf..29adbd1f80eb 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowListResponse.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowListResponse.yml
@@ -4,29 +4,22 @@ name: DataFlowListResponse
fullName: azure.synapse.artifacts.models.DataFlowListResponse
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'A list of data flow resources.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'DataFlowListResponse(*, value: List[_models.DataFlowResource], next_link:
- str | None = None, **kwargs: Any)'
+ syntax: 'DataFlowListResponse(*, value: List[DataFlowResource], next_link: str |
+ None = None, **kwargs)'
parameters:
- name: value
- description: List of data flows. Required.
+ description: Required. List of data flows.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.DataFlowResource>]
- name: next_link
description: The link to the next page of results, if any remaining results exist.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: List of data flows. Required.
- name: value
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DataFlowResource>]
-- description: The link to the next page of results, if any remaining results exist.
- name: next_link
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowReference.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowReference.yml
index 8b24efb55a9d..4a175f166ef9 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowReference.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowReference.yml
@@ -4,61 +4,41 @@ name: DataFlowReference
fullName: azure.synapse.artifacts.models.DataFlowReference
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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(*, type: str | _models.DataFlowReferenceType, reference_name:
- str, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- dataset_parameters: MutableMapping[str, Any] | None = None, parameters: Dict[str,
- MutableMapping[str, Any]] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: type
- description: Data flow reference type. Required. "DataFlowReference"
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.DataFlowReferenceType>
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: reference_name
- description: Reference data flow name. Required.
+ description: Required. Reference data flow name.
+ isRequired: true
types:
- <xref:str>
- name: dataset_parameters
description: Reference data flow parameters from dataset.
+ isRequired: true
types:
- - <xref:JSON>
- - name: parameters
- description: Data flow parameters.
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:object>
variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Data flow reference type. Required. "DataFlowReference"
+- description: 'Required. Data flow reference type. Default value: "DataFlowReference".'
name: type
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.DataFlowReferenceType>
-- description: Reference data flow name. Required.
- name: reference_name
- types:
- - <xref:str>
-- description: Reference data flow parameters from dataset.
- name: dataset_parameters
- types:
- - <xref:JSON>
-- description: Data flow parameters.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+attributes:
+- uid: azure.synapse.artifacts.models.DataFlowReference.type
+ name: type
+ signature: type = 'DataFlowReference'
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowReferenceType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowReferenceType.yml
deleted file mode 100644
index e2fd34b05961..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowReferenceType.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.DataFlowReferenceType
-name: DataFlowReferenceType
-fullName: azure.synapse.artifacts.models.DataFlowReferenceType
-summary: Data flow reference type.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: DataFlowReferenceType(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: DATA_FLOW_REFERENCE
- uid: azure.synapse.artifacts.models.DataFlowReferenceType.DATA_FLOW_REFERENCE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowResource.yml
index decac877d602..c39ba14a8c76 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowResource.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowResource.yml
@@ -13,35 +13,27 @@ summary: 'Data flow resource type.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'DataFlowResource(*, properties: _models.DataFlow, **kwargs: Any)'
+ syntax: 'DataFlowResource(*, properties: DataFlow, **kwargs)'
parameters:
- name: properties
- description: Data flow properties. Required.
+ description: Required. Data flow properties.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DataFlow>
variables:
-- description: 'Fully qualified resource ID for the resource. Ex -
-
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.'
+- description: The resource identifier.
name: id
types:
- <xref:str>
-- description: The name of the resource.
+- description: The resource name.
name: name
types:
- <xref:str>
-- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines"
- or
-
- "Microsoft.Storage/storageAccounts".'
+- description: The resource type.
name: type
types:
- <xref:str>
-- description: Resource Etag.
+- description: Etag identifies change in the resource.
name: etag
types:
- <xref:str>
-- description: Data flow properties. Required.
- name: properties
- types:
- - <xref:azure.synapse.artifacts.models.DataFlow>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSink.yml
index 1d1a165bfadb..d070278841ae 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSink.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSink.yml
@@ -10,66 +10,21 @@ 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: _models.DatasetReference
- | None = None, linked_service: _models.LinkedServiceReference | None = None, flowlet:
- _models.DataFlowReference | None = None, schema_linked_service: _models.LinkedServiceReference
- | None = None, rejected_data_linked_service: _models.LinkedServiceReference |
- None = None, **kwargs: Any)'
+ syntax: 'DataFlowSink(*, name: str, description: str | None = None, dataset: DatasetReference
+ | None = None, **kwargs)'
parameters:
- name: name
- description: Transformation name. Required.
+ description: Required. Transformation name.
+ isRequired: true
types:
- <xref:str>
- name: description
description: Transformation description.
+ isRequired: true
types:
- <xref:str>
- name: dataset
description: Dataset reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetReference>
- - name: linked_service
- description: Linked service reference.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: flowlet
- description: Flowlet Reference.
- types:
- - <xref:azure.synapse.artifacts.models.DataFlowReference>
- - name: schema_linked_service
- description: Schema linked service reference.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: rejected_data_linked_service
- description: Rejected data linked service reference.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-variables:
-- description: Transformation name. Required.
- name: name
- types:
- - <xref:str>
-- description: Transformation description.
- name: description
- types:
- - <xref:str>
-- description: Dataset reference.
- name: dataset
- types:
- - <xref:azure.synapse.artifacts.models.DatasetReference>
-- description: Linked service reference.
- name: linked_service
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Flowlet Reference.
- name: flowlet
- types:
- - <xref:azure.synapse.artifacts.models.DataFlowReference>
-- description: Schema linked service reference.
- name: schema_linked_service
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Rejected data linked service reference.
- name: rejected_data_linked_service
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSource.yml
index d06e107504c1..c0a67b106af3 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSource.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSource.yml
@@ -10,57 +10,21 @@ 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: _models.DatasetReference
- | None = None, linked_service: _models.LinkedServiceReference | None = None, flowlet:
- _models.DataFlowReference | None = None, schema_linked_service: _models.LinkedServiceReference
- | None = None, **kwargs: Any)'
+ syntax: 'DataFlowSource(*, name: str, description: str | None = None, dataset: DatasetReference
+ | None = None, **kwargs)'
parameters:
- name: name
- description: Transformation name. Required.
+ description: Required. Transformation name.
+ isRequired: true
types:
- <xref:str>
- name: description
description: Transformation description.
+ isRequired: true
types:
- <xref:str>
- name: dataset
description: Dataset reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetReference>
- - name: linked_service
- description: Linked service reference.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: flowlet
- description: Flowlet Reference.
- types:
- - <xref:azure.synapse.artifacts.models.DataFlowReference>
- - name: schema_linked_service
- description: Schema linked service reference.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-variables:
-- description: Transformation name. Required.
- name: name
- types:
- - <xref:str>
-- description: Transformation description.
- name: description
- types:
- - <xref:str>
-- description: Dataset reference.
- name: dataset
- types:
- - <xref:azure.synapse.artifacts.models.DatasetReference>
-- description: Linked service reference.
- name: linked_service
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Flowlet Reference.
- name: flowlet
- types:
- - <xref:azure.synapse.artifacts.models.DataFlowReference>
-- description: Schema linked service reference.
- name: schema_linked_service
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSourceSetting.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSourceSetting.yml
index e54cfc8a87d0..f110687a20ea 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSourceSetting.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSourceSetting.yml
@@ -4,39 +4,26 @@ name: DataFlowSourceSetting
fullName: azure.synapse.artifacts.models.DataFlowSourceSetting
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: Definition of data flow source setting for debug.
constructor:
- syntax: 'DataFlowSourceSetting(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_name: str | None = None, row_limit: int | None = None,
- **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: source_name
description: The data flow source name.
+ isRequired: true
types:
- <xref:str>
- name: row_limit
description: Defines the row limit of data flow source in debug.
+ isRequired: true
types:
- <xref:int>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The data flow source name.
- name: source_name
- types:
- - <xref:str>
-- description: Defines the row limit of data flow source in debug.
- name: row_limit
- types:
- - <xref:int>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowStagingInfo.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowStagingInfo.yml
index b42730959b4b..09b5f3d37371 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowStagingInfo.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowStagingInfo.yml
@@ -4,26 +4,19 @@ name: DataFlowStagingInfo
fullName: azure.synapse.artifacts.models.DataFlowStagingInfo
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: Staging info for execute data flow activity.
constructor:
- syntax: 'DataFlowStagingInfo(*, linked_service: _models.LinkedServiceReference |
- None = None, folder_path: MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: folder_path
description: Folder path for staging blob.
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: Staging linked service reference.
- name: linked_service
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Folder path for staging blob.
- name: folder_path
- types:
- - <xref:JSON>
+ - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity.yml
index f754c9d4ec90..2180de9fc391 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity.yml
@@ -10,74 +10,68 @@ 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: MutableMapping[str,
- Any], script_linked_service: _models.LinkedServiceReference, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None,
- state: str | _models.ActivityState | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs
- | None = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, linked_service_name: _models.LinkedServiceReference
- | None = None, policy: _models.ActivityPolicy | None = None, degree_of_parallelism:
- MutableMapping[str, Any] | None = None, priority: MutableMapping[str, Any] | None
- = None, parameters: Dict[str, MutableMapping[str, Any]] | None = None, runtime_version:
- MutableMapping[str, Any] | None = None, compilation_mode: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
- name: script_path
- description: 'Case-sensitive path to folder that contains the U-SQL script. Type:
+ description: 'Required. Case-sensitive path to folder that contains the U-SQL
+ script.
- string (or Expression with resultType string). Required.'
+ Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: script_linked_service
- description: Script linked service reference. Required.
+ description: Required. Script linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: degree_of_parallelism
@@ -85,8 +79,9 @@ constructor:
Default value is 1. Type: integer (or Expression with resultType integer), minimum:
1.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: priority
description: 'Determines which jobs out of all that are queued should be selected
to run
@@ -95,119 +90,25 @@ constructor:
Type: integer (or
Expression with resultType integer), minimum: 1.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: parameters
description: Parameters for U-SQL job request.
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: runtime_version
- description: 'Runtime version of the U-SQL engine to use. Type: string (or
+ description: 'Runtime version of the U-SQL engine to use. Type: string (or Expression
- Expression with resultType string).'
+ with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: 'Case-sensitive path to folder that contains the U-SQL script. Type:
- string
-
- (or Expression with resultType string). Required.'
- name: script_path
- types:
- - <xref:JSON>
-- description: Script linked service reference. Required.
- name: script_linked_service
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- 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.'
- name: degree_of_parallelism
- types:
- - <xref:JSON>
-- 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.'
- name: priority
- types:
- - <xref:JSON>
-- description: Parameters for U-SQL job request.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: 'Runtime version of the U-SQL engine to use. Type: string (or Expression
-
- with resultType string).'
- name: runtime_version
- types:
- - <xref:JSON>
-- description: 'Compilation mode of U-SQL. Must be one of these values : Semantic,
- Full
-
- and SingleBox. Type: string (or Expression with resultType string).'
- name: compilation_mode
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataLakeStorageAccountDetails.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataLakeStorageAccountDetails.yml
deleted file mode 100644
index f9f07e63e701..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataLakeStorageAccountDetails.yml
+++ /dev/null
@@ -1,29 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.DataLakeStorageAccountDetails
-name: DataLakeStorageAccountDetails
-fullName: azure.synapse.artifacts.models.DataLakeStorageAccountDetails
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Details of the data lake storage account associated with the workspace.
-constructor:
- syntax: 'DataLakeStorageAccountDetails(*, account_url: str | None = None, filesystem:
- str | None = None, **kwargs: Any)'
- parameters:
- - name: account_url
- description: Account URL.
- types:
- - <xref:str>
- - name: filesystem
- description: Filesystem name.
- types:
- - <xref:str>
-variables:
-- description: Account URL.
- name: account_url
- types:
- - <xref:str>
-- description: Filesystem name.
- name: filesystem
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksNotebookActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksNotebookActivity.yml
index 57f76c97e60a..5f2ce186971c 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksNotebookActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksNotebookActivity.yml
@@ -10,158 +10,76 @@ summary: 'DatabricksNotebook activity.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'DatabricksNotebookActivity(*, name: str, notebook_path: MutableMapping[str,
- Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- description: str | None = None, state: str | _models.ActivityState | None = None,
- on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None = None, depends_on:
- List[_models.ActivityDependency] | None = None, user_properties: List[_models.UserProperty]
- | None = None, linked_service_name: _models.LinkedServiceReference | None = None,
- policy: _models.ActivityPolicy | None = None, base_parameters: Dict[str, MutableMapping[str,
- Any]] | None = None, libraries: List[Dict[str, MutableMapping[str, Any]]] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
- name: notebook_path
- description: 'The absolute path of the notebook to be run in the Databricks
+ 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). Required.'
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: libraries
- description: 'A list of libraries to be installed on the cluster that will execute
- the
-
- job.'
+ description: A list of libraries to be installed on the cluster that will execute
+ the job.
+ isRequired: true
types:
- - <xref:list>[<xref:dict>[<xref:str>, <xref:JSON>]]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: '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).
-
- Required.'
- name: notebook_path
- types:
- - <xref:JSON>
-- 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.'
- name: base_parameters
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: A list of libraries to be installed on the cluster that will execute
- the job.
- name: libraries
- types:
- - <xref:list>[<xref:dict>[<xref:str>, <xref:JSON>]]
+ - <xref:list>[<xref:dict>[<xref:str>, <xref:object>]]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkJarActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkJarActivity.yml
index 4c595c4cfd70..734a06173a83 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkJarActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkJarActivity.yml
@@ -10,152 +10,74 @@ summary: 'DatabricksSparkJar activity.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'DatabricksSparkJarActivity(*, name: str, main_class_name: MutableMapping[str,
- Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- description: str | None = None, state: str | _models.ActivityState | None = None,
- on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None = None, depends_on:
- List[_models.ActivityDependency] | None = None, user_properties: List[_models.UserProperty]
- | None = None, linked_service_name: _models.LinkedServiceReference | None = None,
- policy: _models.ActivityPolicy | None = None, parameters: List[MutableMapping[str,
- Any]] | None = None, libraries: List[Dict[str, MutableMapping[str, Any]]] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
- name: main_class_name
- description: 'The full name of the class containing the main method to be executed.
+ description: 'Required. The full name of the class containing the main method
+ to be
- This class must be contained in a JAR provided as a library. Type: string (or
- Expression with
+ executed. This class must be contained in a JAR provided as a library. Type:
+ string (or
- resultType string). Required.'
+ Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: parameters
description: Parameters that will be passed to the main method.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: libraries
- description: 'A list of libraries to be installed on the cluster that will execute
- the
-
- job.'
+ description: A list of libraries to be installed on the cluster that will execute
+ the job.
+ isRequired: true
types:
- - <xref:list>[<xref:dict>[<xref:str>, <xref:JSON>]]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: '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). Required.'
- name: main_class_name
- types:
- - <xref:JSON>
-- description: Parameters that will be passed to the main method.
- name: parameters
- types:
- - <xref:list>[<xref:JSON>]
-- description: A list of libraries to be installed on the cluster that will execute
- the job.
- name: libraries
- types:
- - <xref:list>[<xref:dict>[<xref:str>, <xref:JSON>]]
+ - <xref:list>[<xref:dict>[<xref:str>, <xref:object>]]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkPythonActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkPythonActivity.yml
index 079dc2ad4759..248d8087cc1d 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkPythonActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkPythonActivity.yml
@@ -10,147 +10,71 @@ summary: 'DatabricksSparkPython activity.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'DatabricksSparkPythonActivity(*, name: str, python_file: MutableMapping[str,
- Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- description: str | None = None, state: str | _models.ActivityState | None = None,
- on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None = None, depends_on:
- List[_models.ActivityDependency] | None = None, user_properties: List[_models.UserProperty]
- | None = None, linked_service_name: _models.LinkedServiceReference | None = None,
- policy: _models.ActivityPolicy | None = None, parameters: List[MutableMapping[str,
- Any]] | None = None, libraries: List[Dict[str, MutableMapping[str, Any]]] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
- name: python_file
- description: 'The URI of the Python file to be executed. DBFS paths are supported.
+ description: 'Required. The URI of the Python file to be executed. DBFS paths
+ are
- Type: string (or Expression with resultType string). Required.'
+ supported. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: parameters
description: Command line parameters that will be passed to the Python file.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: libraries
- description: 'A list of libraries to be installed on the cluster that will execute
- the
-
- job.'
+ description: A list of libraries to be installed on the cluster that will execute
+ the job.
+ isRequired: true
types:
- - <xref:list>[<xref:dict>[<xref:str>, <xref:JSON>]]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: 'The URI of the Python file to be executed. DBFS paths are supported.
- Type:
-
- string (or Expression with resultType string). Required.'
- name: python_file
- types:
- - <xref:JSON>
-- description: Command line parameters that will be passed to the Python file.
- name: parameters
- types:
- - <xref:list>[<xref:JSON>]
-- description: A list of libraries to be installed on the cluster that will execute
- the job.
- name: libraries
- types:
- - <xref:list>[<xref:dict>[<xref:str>, <xref:JSON>]]
+ - <xref:list>[<xref:dict>[<xref:str>, <xref:object>]]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Dataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Dataset.yml
index bfcc98b6c20d..f4d327336264 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Dataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Dataset.yml
@@ -4,165 +4,97 @@ name: Dataset
fullName: azure.synapse.artifacts.models.Dataset
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'The Azure Data Factory nested object which identifies data within different
- data stores, such
+ data stores, such as tables, files, folders, and documents.
- as tables, files, folders, and documents.
+ You probably want to use the sub-classes and not this class directly. Known
- You probably want to use the sub-classes and not this class directly. Known sub-classes
- are:
-
- AmazonMWSObjectDataset, AmazonRdsForOracleTableDataset, AmazonRdsForSqlServerTableDataset,
-
- AmazonRedshiftTableDataset, AmazonS3Dataset, AvroDataset, AzureBlobDataset, AzureBlobFSDataset,
-
- AzureDataExplorerTableDataset, AzureDataLakeStoreDataset, AzureDatabricksDeltaLakeDataset,
-
- AzureMariaDBTableDataset, AzureMySqlTableDataset, AzurePostgreSqlTableDataset,
-
- AzureSearchIndexDataset, AzureSqlDWTableDataset, AzureSqlMITableDataset, AzureSqlTableDataset,
-
- AzureTableDataset, BinaryDataset, CassandraTableDataset, CommonDataServiceForAppsEntityDataset,
-
+ sub-classes are: AmazonMWSObjectDataset, AmazonRedshiftTableDataset, AvroDataset,
+ AzureDataExplorerTableDataset, AzureMariaDBTableDataset, AzureMySqlTableDataset,
+ AzurePostgreSqlTableDataset, AzureSearchIndexDataset, AzureSqlDWTableDataset, AzureSqlMITableDataset,
+ AzureSqlTableDataset, AzureTableDataset, BinaryDataset, CassandraTableDataset, CommonDataServiceForAppsEntityDataset,
ConcurObjectDataset, CosmosDbMongoDbApiCollectionDataset, CosmosDbSqlApiCollectionDataset,
-
- CouchbaseTableDataset, CustomDataset, Db2TableDataset, DelimitedTextDataset,
-
- DocumentDbCollectionDataset, DrillTableDataset, DynamicsAXResourceDataset,
-
- DynamicsCrmEntityDataset, DynamicsEntityDataset, EloquaObjectDataset, ExcelDataset,
-
- FileShareDataset, GoogleAdWordsObjectDataset, GoogleBigQueryObjectDataset,
-
- GreenplumTableDataset, HBaseObjectDataset, HiveObjectDataset, HttpDataset,
-
- HubspotObjectDataset, ImpalaObjectDataset, InformixTableDataset, JiraObjectDataset,
-
- JsonDataset, MagentoObjectDataset, MariaDBTableDataset, MarketoObjectDataset,
-
- MicrosoftAccessTableDataset, MongoDbAtlasCollectionDataset, MongoDbCollectionDataset,
-
- MongoDbV2CollectionDataset, MySqlTableDataset, NetezzaTableDataset, ODataResourceDataset,
-
- OdbcTableDataset, Office365Dataset, OracleServiceCloudObjectDataset, OracleTableDataset,
-
- OrcDataset, ParquetDataset, PaypalObjectDataset, PhoenixObjectDataset, PostgreSqlTableDataset,
-
+ 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, SapOdpResourceDataset, SapOpenHubTableDataset,
-
- SapTableResourceDataset, ServiceNowObjectDataset, SharePointOnlineListResourceDataset,
-
- ShopifyObjectDataset, SnowflakeDataset, SparkObjectDataset, SqlServerTableDataset,
-
+ SapEccResourceDataset, SapHanaTableDataset, SapOpenHubTableDataset, SapTableResourceDataset,
+ ServiceNowObjectDataset, ShopifyObjectDataset, SparkObjectDataset, SqlServerTableDataset,
SquareObjectDataset, SybaseTableDataset, TeradataTableDataset, VerticaTableDataset,
-
- WebTableDataset, XeroObjectDataset, XmlDataset, ZohoObjectDataset
+ WebTableDataset, XeroObjectDataset, ZohoObjectDataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'Dataset(*, linked_service_name: _models.LinkedServiceReference, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None,
- structure: MutableMapping[str, Any] | None = None, schema: MutableMapping[str,
- Any] | None = None, parameters: Dict[str, _models.ParameterSpecification] | None
- = None, annotations: List[MutableMapping[str, Any]] | None = None, folder: _models.DatasetFolder
- | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetBZip2Compression.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetBZip2Compression.yml
new file mode 100644
index 000000000000..c6e8095fa309
--- /dev/null
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetBZip2Compression.yml
@@ -0,0 +1,27 @@
+### YamlMime:PythonClass
+uid: azure.synapse.artifacts.models.DatasetBZip2Compression
+name: DatasetBZip2Compression
+fullName: azure.synapse.artifacts.models.DatasetBZip2Compression
+module: azure.synapse.artifacts.models
+inheritances:
+- azure.synapse.artifacts.models._models_py3.DatasetCompression
+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:
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset compression.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetCompression.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetCompression.yml
index d5ea3f115097..67d24a5dc449 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetCompression.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetCompression.yml
@@ -4,52 +4,30 @@ name: DatasetCompression
fullName: azure.synapse.artifacts.models.DatasetCompression
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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(*, type: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, level: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: type
- description: 'Type of dataset compression. Type: string (or Expression with resultType
-
- string). Required.'
+ description: Required. Type of dataset compression.Constant filled by server.
+ isRequired: true
types:
- - <xref:JSON>
- - name: level
- description: 'The dataset compression level. Type: string (or Expression with
- resultType
-
- string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: 'Type of dataset compression. Type: string (or Expression with resultType
- string).
-
- Required.'
- name: type
- types:
- - <xref:JSON>
-- description: 'The dataset compression level. Type: string (or Expression with resultType
-
- string).'
- name: level
- types:
- - <xref:JSON>
+ - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetCompressionLevel.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetCompressionLevel.yml
index f32b372b39c5..20f5b729412c 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetCompressionLevel.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetCompressionLevel.yml
@@ -2,7 +2,7 @@
uid: azure.synapse.artifacts.models.DatasetCompressionLevel
name: DatasetCompressionLevel
fullName: azure.synapse.artifacts.models.DatasetCompressionLevel
-summary: DatasetCompressionLevel.
+summary: All available compression levels.
module: azure.synapse.artifacts.models
constructor:
syntax: DatasetCompressionLevel(value, names=None, *, module=None, qualname=None,
@@ -11,7 +11,7 @@ inheritances:
- builtins.str
- enum.Enum
fields:
-- name: FASTEST
- uid: azure.synapse.artifacts.models.DatasetCompressionLevel.FASTEST
-- name: OPTIMAL
- uid: azure.synapse.artifacts.models.DatasetCompressionLevel.OPTIMAL
+- name: fastest
+ uid: azure.synapse.artifacts.models.DatasetCompressionLevel.fastest
+- name: optimal
+ uid: azure.synapse.artifacts.models.DatasetCompressionLevel.optimal
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDataElement.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDataElement.yml
deleted file mode 100644
index 2e9458aabe0a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDataElement.yml
+++ /dev/null
@@ -1,31 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.DatasetDataElement
-name: DatasetDataElement
-fullName: azure.synapse.artifacts.models.DatasetDataElement
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Columns that define the structure of the dataset.
-constructor:
- syntax: 'DatasetDataElement(*, name: MutableMapping[str, Any] | None = None, type:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: name
- description: 'Name of the column. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
- - name: type
- description: 'Type of the column. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Name of the column. Type: string (or Expression with resultType string).'
- name: name
- types:
- - <xref:JSON>
-- description: 'Type of the column. Type: string (or Expression with resultType string).'
- name: type
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDebugResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDebugResource.yml
index d634f7fc8645..ef76e0c28fad 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDebugResource.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDebugResource.yml
@@ -10,23 +10,15 @@ summary: 'Dataset debug resource.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'DatasetDebugResource(*, properties: _models.Dataset, name: str | None =
- None, **kwargs: Any)'
+ syntax: 'DatasetDebugResource(*, properties: Dataset, name: str | None = None, **kwargs)'
parameters:
- name: name
description: The resource name.
+ isRequired: true
types:
- <xref:str>
- name: properties
- description: Dataset properties. Required.
+ description: Required. Dataset properties.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.Dataset>
-variables:
-- description: The resource name.
- name: name
- types:
- - <xref:str>
-- description: Dataset properties. Required.
- name: properties
- types:
- - <xref:azure.synapse.artifacts.models.Dataset>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDeflateCompression.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDeflateCompression.yml
new file mode 100644
index 000000000000..1997b46548fb
--- /dev/null
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDeflateCompression.yml
@@ -0,0 +1,34 @@
+### YamlMime:PythonClass
+uid: azure.synapse.artifacts.models.DatasetDeflateCompression
+name: DatasetDeflateCompression
+fullName: azure.synapse.artifacts.models.DatasetDeflateCompression
+module: azure.synapse.artifacts.models
+inheritances:
+- azure.synapse.artifacts.models._models_py3.DatasetCompression
+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:
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset compression.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
+ - name: level
+ description: 'The Deflate compression level. Possible values include: "Optimal",
+ "Fastest".'
+ isRequired: true
+ types:
+ - <xref:str>
+ - <xref:azure.synapse.artifacts.models.DatasetCompressionLevel>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetFolder.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetFolder.yml
index e4381a9395cf..6fc5f17642e7 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetFolder.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetFolder.yml
@@ -4,18 +4,14 @@ name: DatasetFolder
fullName: azure.synapse.artifacts.models.DatasetFolder
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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: Any)'
+ syntax: 'DatasetFolder(*, name: str | None = None, **kwargs)'
parameters:
- name: name
description: The name of the folder that this Dataset is in.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: The name of the folder that this Dataset is in.
- name: name
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetGZipCompression.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetGZipCompression.yml
new file mode 100644
index 000000000000..49b8b70969a4
--- /dev/null
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetGZipCompression.yml
@@ -0,0 +1,34 @@
+### YamlMime:PythonClass
+uid: azure.synapse.artifacts.models.DatasetGZipCompression
+name: DatasetGZipCompression
+fullName: azure.synapse.artifacts.models.DatasetGZipCompression
+module: azure.synapse.artifacts.models
+inheritances:
+- azure.synapse.artifacts.models._models_py3.DatasetCompression
+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:
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset compression.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
+ - name: level
+ description: 'The GZip compression level. Possible values include: "Optimal",
+ "Fastest".'
+ isRequired: true
+ types:
+ - <xref:str>
+ - <xref:azure.synapse.artifacts.models.DatasetCompressionLevel>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetListResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetListResponse.yml
index afa4ce29549d..b3d2d81c7578 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetListResponse.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetListResponse.yml
@@ -4,29 +4,22 @@ name: DatasetListResponse
fullName: azure.synapse.artifacts.models.DatasetListResponse
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'A list of dataset resources.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'DatasetListResponse(*, value: List[_models.DatasetResource], next_link:
- str | None = None, **kwargs: Any)'
+ syntax: 'DatasetListResponse(*, value: List[DatasetResource], next_link: str | None
+ = None, **kwargs)'
parameters:
- name: value
- description: List of datasets. Required.
+ description: Required. List of datasets.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.DatasetResource>]
- name: next_link
description: The link to the next page of results, if any remaining results exist.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: List of datasets. Required.
- name: value
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DatasetResource>]
-- description: The link to the next page of results, if any remaining results exist.
- name: next_link
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetLocation.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetLocation.yml
index 51f986354411..e431dd0bd3dc 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetLocation.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetLocation.yml
@@ -4,66 +4,45 @@ name: DatasetLocation
fullName: azure.synapse.artifacts.models.DatasetLocation
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'Dataset location.
- You probably want to use the sub-classes and not this class directly. Known sub-classes
- are:
+ You probably want to use the sub-classes and not this class directly. Known
- AmazonS3Location, AzureBlobFSLocation, AzureBlobStorageLocation, AzureDataLakeStoreLocation,
-
- AzureFileStorageLocation, FileServerLocation, FtpServerLocation, GoogleCloudStorageLocation,
-
- HdfsLocation, HttpServerLocation, SftpLocation
+ sub-classes are: .
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'DatasetLocation(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, folder_path: MutableMapping[str, Any] | None = None, file_name:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset storage location.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: folder_path
description: 'Specify the folder path of dataset. Type: string (or Expression
with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: file_name
description: 'Specify the file name of dataset. Type: string (or Expression with
+ resultType
- resultType string).'
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset storage location. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Specify the folder path of dataset. Type: string (or Expression with
-
- resultType string).'
- name: folder_path
- types:
- - <xref:JSON>
-- description: 'Specify the file name of dataset. Type: string (or Expression with
- resultType
-
- string).'
- name: file_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetReference.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetReference.yml
index 6fa6cdf57ad9..94bf5c9b73db 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetReference.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetReference.yml
@@ -4,40 +4,34 @@ name: DatasetReference
fullName: azure.synapse.artifacts.models.DatasetReference
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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(*, type: str | _models.DatasetReferenceType, reference_name:
- str, parameters: Dict[str, MutableMapping[str, Any]] | None = None, **kwargs:
- Any)'
+ syntax: 'DatasetReference(*, reference_name: str, parameters: Dict[str, object]
+ | None = None, **kwargs)'
parameters:
- - name: type
- description: Dataset reference type. Required. "DatasetReference"
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.DatasetReferenceType>
- name: reference_name
- description: Reference dataset name. Required.
+ description: Required. Reference dataset name.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Arguments for dataset.
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
variables:
-- description: Dataset reference type. Required. "DatasetReference"
+- description: 'Required. Dataset reference type. Default value: "DatasetReference".'
name: type
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.DatasetReferenceType>
-- description: Reference dataset name. Required.
- name: reference_name
- types:
- - <xref:str>
-- description: Arguments for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+attributes:
+- uid: azure.synapse.artifacts.models.DatasetReference.type
+ name: type
+ signature: type = 'DatasetReference'
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetReferenceType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetReferenceType.yml
deleted file mode 100644
index a35a188fbebe..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetReferenceType.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.DatasetReferenceType
-name: DatasetReferenceType
-fullName: azure.synapse.artifacts.models.DatasetReferenceType
-summary: Dataset reference type.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: DatasetReferenceType(value, names=None, *, module=None, qualname=None, type=None,
- start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: DATASET_REFERENCE
- uid: azure.synapse.artifacts.models.DatasetReferenceType.DATASET_REFERENCE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetResource.yml
index e50393a9522e..66fd22be0a29 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetResource.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetResource.yml
@@ -13,35 +13,27 @@ summary: 'Dataset resource type.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'DatasetResource(*, properties: _models.Dataset, **kwargs: Any)'
+ syntax: 'DatasetResource(*, properties: Dataset, **kwargs)'
parameters:
- name: properties
- description: Dataset properties. Required.
+ description: Required. Dataset properties.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.Dataset>
variables:
-- description: 'Fully qualified resource ID for the resource. Ex -
-
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.'
+- description: The resource identifier.
name: id
types:
- <xref:str>
-- description: The name of the resource.
+- description: The resource name.
name: name
types:
- <xref:str>
-- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines"
- or
-
- "Microsoft.Storage/storageAccounts".'
+- description: The resource type.
name: type
types:
- <xref:str>
-- description: Resource Etag.
+- description: Etag identifies change in the resource.
name: etag
types:
- <xref:str>
-- description: Dataset properties. Required.
- name: properties
- types:
- - <xref:azure.synapse.artifacts.models.Dataset>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetSchemaDataElement.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetSchemaDataElement.yml
deleted file mode 100644
index d780afd4dbfd..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetSchemaDataElement.yml
+++ /dev/null
@@ -1,46 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.DatasetSchemaDataElement
-name: DatasetSchemaDataElement
-fullName: azure.synapse.artifacts.models.DatasetSchemaDataElement
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Columns that define the physical type schema of the dataset.
-constructor:
- syntax: 'DatasetSchemaDataElement(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, name: MutableMapping[str, Any] | None = None, type: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: name
- description: 'Name of the schema column. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
- - name: type
- description: 'Type of the schema column. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: 'Name of the schema column. Type: string (or Expression with resultType
- string).'
- name: name
- types:
- - <xref:JSON>
-- description: 'Type of the schema column. Type: string (or Expression with resultType
- string).'
- name: type
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetStorageFormat.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetStorageFormat.yml
deleted file mode 100644
index 1437c47ebe6c..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetStorageFormat.yml
+++ /dev/null
@@ -1,55 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.DatasetStorageFormat
-name: DatasetStorageFormat
-fullName: azure.synapse.artifacts.models.DatasetStorageFormat
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'The format definition of a storage.
-
-
- You probably want to use the sub-classes and not this class directly. Known sub-classes
- are:
-
- AvroFormat, JsonFormat, OrcFormat, ParquetFormat, TextFormat
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'DatasetStorageFormat(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, serializer: MutableMapping[str, Any] | None = None, deserializer:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: serializer
- description: 'Serializer. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: deserializer
- description: 'Deserializer. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset storage format. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Serializer. Type: string (or Expression with resultType string).'
- name: serializer
- types:
- - <xref:JSON>
-- description: 'Deserializer. Type: string (or Expression with resultType string).'
- name: deserializer
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetZipDeflateCompression.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetZipDeflateCompression.yml
new file mode 100644
index 000000000000..8eec0b3b8135
--- /dev/null
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetZipDeflateCompression.yml
@@ -0,0 +1,34 @@
+### YamlMime:PythonClass
+uid: azure.synapse.artifacts.models.DatasetZipDeflateCompression
+name: DatasetZipDeflateCompression
+fullName: azure.synapse.artifacts.models.DatasetZipDeflateCompression
+module: azure.synapse.artifacts.models
+inheritances:
+- azure.synapse.artifacts.models._models_py3.DatasetCompression
+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:
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset compression.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
+ - name: level
+ description: 'The ZipDeflate compression level. Possible values include: "Optimal",
+ "Fastest".'
+ isRequired: true
+ types:
+ - <xref:str>
+ - <xref:azure.synapse.artifacts.models.DatasetCompressionLevel>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataworldLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataworldLinkedService.yml
deleted file mode 100644
index 206114946698..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataworldLinkedService.yml
+++ /dev/null
@@ -1,93 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.DataworldLinkedService
-name: DataworldLinkedService
-fullName: azure.synapse.artifacts.models.DataworldLinkedService
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.LinkedService
-summary: 'Linked service for Dataworld.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'DataworldLinkedService(*, api_token: _models.SecretBase, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, encrypted_credential:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: connect_via
- description: The integration runtime reference.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- - name: description
- description: Linked service description.
- types:
- - <xref:str>
- - name: parameters
- description: Parameters for linked service.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the linked service.
- types:
- - <xref:list>[<xref:JSON>]
- - name: api_token
- description: The api token for the Dataworld source. Required.
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
- - 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).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The api token for the Dataworld source. Required.
- name: api_token
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DayOfWeek.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DayOfWeek.yml
deleted file mode 100644
index 8cc29b4baf84..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DayOfWeek.yml
+++ /dev/null
@@ -1,27 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.DayOfWeek
-name: DayOfWeek
-fullName: azure.synapse.artifacts.models.DayOfWeek
-summary: DayOfWeek.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: DayOfWeek(value, names=None, *, module=None, qualname=None, type=None, start=1,
- boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: FRIDAY
- uid: azure.synapse.artifacts.models.DayOfWeek.FRIDAY
-- name: MONDAY
- uid: azure.synapse.artifacts.models.DayOfWeek.MONDAY
-- name: SATURDAY
- uid: azure.synapse.artifacts.models.DayOfWeek.SATURDAY
-- name: SUNDAY
- uid: azure.synapse.artifacts.models.DayOfWeek.SUNDAY
-- name: THURSDAY
- uid: azure.synapse.artifacts.models.DayOfWeek.THURSDAY
-- name: TUESDAY
- uid: azure.synapse.artifacts.models.DayOfWeek.TUESDAY
-- name: WEDNESDAY
- uid: azure.synapse.artifacts.models.DayOfWeek.WEDNESDAY
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2AuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2AuthenticationType.yml
deleted file mode 100644
index e3af7daafb68..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2AuthenticationType.yml
+++ /dev/null
@@ -1,18 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.Db2AuthenticationType
-name: Db2AuthenticationType
-fullName: azure.synapse.artifacts.models.Db2AuthenticationType
-summary: 'AuthenticationType to be used for connection. It is mutually exclusive with
- connectionString
-
- property.'
-module: azure.synapse.artifacts.models
-constructor:
- syntax: Db2AuthenticationType(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: BASIC
- uid: azure.synapse.artifacts.models.Db2AuthenticationType.BASIC
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2LinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2LinkedService.yml
index 917278256aee..394ebcc26de6 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2LinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2LinkedService.yml
@@ -8,191 +8,111 @@ inheritances:
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: MutableMapping[str, Any], database: MutableMapping[str,
- Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- connect_via: _models.IntegrationRuntimeReference | None = None, description: str
- | None = None, parameters: Dict[str, _models.ParameterSpecification] | None =
- None, annotations: List[MutableMapping[str, Any]] | None = None, connection_string:
- MutableMapping[str, Any] | None = None, authentication_type: str | _models.Db2AuthenticationType
- | None = None, username: MutableMapping[str, Any] | None = None, password: _models.SecretBase
- | None = None, package_collection: MutableMapping[str, Any] | None = None, certificate_common_name:
- MutableMapping[str, Any] | None = None, encrypted_credential: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
+ 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:
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
- - name: connection_string
- description: 'The connection string. It is mutually exclusive with server,
-
- database, authenticationType, userName, packageCollection and certificateCommonName
- property.
-
- Type: string, SecureString or AzureKeyVaultSecretReference.'
- types:
- - <xref:JSON>
+ - <xref:list>[<xref:object>]
- name: server
- description: 'Server name for connection. It is mutually exclusive with connectionString
+ description: 'Required. Server name for connection. Type: string (or Expression
+ with
- property. Type: string (or Expression with resultType string). Required.'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: database
- description: 'Database name for connection. It is mutually exclusive with connectionString
-
- property. Type: string (or Expression with resultType string). Required.'
- types:
- - <xref:JSON>
- - name: authentication_type
- description: 'AuthenticationType to be used for connection. It is mutually
+ description: 'Required. Database name for connection. Type: string (or Expression
+ with
- exclusive with connectionString property. "Basic"'
+ resultType string).'
+ isRequired: true
types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.Db2AuthenticationType>
+ - <xref:object>
- name: username
- description: 'Username for authentication. It is mutually exclusive with connectionString
+ description: 'Username for authentication. Type: string (or Expression with resultType
- property. Type: string (or Expression with resultType string).'
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: Password for authentication.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: package_collection
- description: 'Under where packages are created when querying database. It is
+ description: 'Under where packages are created when querying database. Type:
- mutually exclusive with connectionString property. Type: string (or Expression
- with resultType
-
- string).'
+ string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: certificate_common_name
- description: 'Certificate Common Name when TLS is enabled. It is mutually
+ description: 'Certificate Common Name when TLS is enabled. Type: string (or
- exclusive with connectionString property. Type: string (or Expression with resultType
- string).'
+ Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. It is mutually
- exclusive with
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- connectionString property. Type: string (or Expression with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The connection string. It is mutually exclusive with server, database,
-
- authenticationType, userName, packageCollection and certificateCommonName property.
- Type:
+- description: 'AuthenticationType to be used for connection. Default value:
- string, SecureString or AzureKeyVaultSecretReference.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: 'Server name for connection. It is mutually exclusive with connectionString
-
- property. Type: string (or Expression with resultType string). Required.'
- name: server
- types:
- - <xref:JSON>
-- description: 'Database name for connection. It is mutually exclusive with connectionString
-
- property. Type: string (or Expression with resultType string). Required.'
- name: database
- types:
- - <xref:JSON>
-- description: 'AuthenticationType to be used for connection. It is mutually
-
- exclusive with connectionString property. "Basic"'
+ "Basic".'
name: authentication_type
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.Db2AuthenticationType>
-- description: 'Username for authentication. It is mutually exclusive with connectionString
-
- property. Type: string (or Expression with resultType string).'
- name: username
- types:
- - <xref:JSON>
-- description: Password for authentication.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Under where packages are created when querying database. It is
-
- mutually exclusive with connectionString property. Type: string (or Expression
- with resultType
-
- string).'
- name: package_collection
- types:
- - <xref:JSON>
-- description: 'Certificate Common Name when TLS is enabled. It is mutually
-
- exclusive with connectionString property. Type: string (or Expression with resultType
- string).'
- name: certificate_common_name
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. It is mutually exclusive
- with
-
- connectionString property. Type: string (or Expression with resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+attributes:
+- uid: azure.synapse.artifacts.models.Db2LinkedService.authentication_type
+ name: authentication_type
+ signature: authentication_type = 'Basic'
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2Source.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2Source.yml
deleted file mode 100644
index 41270b1a3ae8..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2Source.yml
+++ /dev/null
@@ -1,105 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.Db2Source
-name: Db2Source
-fullName: azure.synapse.artifacts.models.Db2Source
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity source for Db2 databases.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'Db2Source(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'Database query. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'Database query. Type: string (or Expression with resultType string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2TableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2TableDataset.yml
index 088cf16d0202..bb6164d12e4f 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2TableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2TableDataset.yml
@@ -10,135 +10,86 @@ summary: 'The Db2 table dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'Db2TableDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, schema_type_properties_schema: MutableMapping[str, Any] | None = None,
- table: MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'This property will be retired. Please consider using schema + table
properties instead.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: schema_type_properties_schema
description: 'The Db2 schema name. Type: string (or Expression with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: table
description: 'The Db2 table name. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'This property will be retired. Please consider using schema + table
-
- properties instead.'
- name: table_name
- types:
- - <xref:JSON>
-- description: 'The Db2 schema name. Type: string (or Expression with
-
- resultType string).'
- name: schema_type_properties_schema
- types:
- - <xref:JSON>
-- description: 'The Db2 table name. Type: string (or Expression with resultType string).'
- name: table
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteActivity.yml
index 70294ea410ed..ff0dda5b5539 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteActivity.yml
@@ -10,63 +10,54 @@ summary: 'Delete activity.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'DeleteActivity(*, name: str, dataset: _models.DatasetReference, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None,
- state: str | _models.ActivityState | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs
- | None = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, linked_service_name: _models.LinkedServiceReference
- | None = None, policy: _models.ActivityPolicy | None = None, recursive: MutableMapping[str,
- Any] | None = None, max_concurrent_connections: int | None = None, enable_logging:
- MutableMapping[str, Any] | None = None, log_storage_settings: _models.LogStorageSettings
- | None = None, store_settings: _models.StoreReadSettings | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
- name: recursive
@@ -75,116 +66,32 @@ constructor:
recursively. Default is false. Type: boolean (or Expression with resultType
boolean).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: max_concurrent_connections
- description: 'The max concurrent connections to connect data source at
+ description: 'The max concurrent connections to connect data source at the
- the same time.'
+ same time.'
+ isRequired: true
types:
- <xref:int>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: log_storage_settings
description: 'Log storage settings customer need to provide when enableLogging
is true.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LogStorageSettings>
- name: dataset
- description: Delete activity dataset reference. Required.
+ description: Required. Delete activity dataset reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetReference>
- - name: store_settings
- description: Delete activity store settings.
- types:
- - <xref:azure.synapse.artifacts.models.StoreReadSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- 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).'
- name: recursive
- types:
- - <xref:JSON>
-- description: 'The max concurrent connections to connect data source at the
-
- same time.'
- name: max_concurrent_connections
- types:
- - <xref:int>
-- description: 'Whether to record detailed logs of delete-activity execution. Default
-
- value is false. Type: boolean (or Expression with resultType boolean).'
- name: enable_logging
- types:
- - <xref:JSON>
-- description: 'Log storage settings customer need to provide when enableLogging is
-
- true.'
- name: log_storage_settings
- types:
- - <xref:azure.synapse.artifacts.models.LogStorageSettings>
-- description: Delete activity dataset reference. Required.
- name: dataset
- types:
- - <xref:azure.synapse.artifacts.models.DatasetReference>
-- description: Delete activity store settings.
- name: store_settings
- types:
- - <xref:azure.synapse.artifacts.models.StoreReadSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest.yml
index 2dbaba85a146..1cc40c741d92 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest.yml
@@ -4,26 +4,19 @@ name: DeleteDataFlowDebugSessionRequest
fullName: azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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: Any)'
+ str | None = None, **kwargs)'
parameters:
- name: session_id
description: The ID of data flow debug session.
+ isRequired: true
types:
- <xref:str>
- name: data_flow_name
description: The data flow which contains the debug session.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: The ID of data flow debug session.
- name: session_id
- types:
- - <xref:str>
-- description: The data flow which contains the debug session.
- name: data_flow_name
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextCompressionCodec.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextCompressionCodec.yml
new file mode 100644
index 000000000000..f877654ab003
--- /dev/null
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextCompressionCodec.yml
@@ -0,0 +1,24 @@
+### YamlMime:PythonEnum
+uid: azure.synapse.artifacts.models.DelimitedTextCompressionCodec
+name: DelimitedTextCompressionCodec
+fullName: azure.synapse.artifacts.models.DelimitedTextCompressionCodec
+module: azure.synapse.artifacts.models
+constructor:
+ syntax: DelimitedTextCompressionCodec(value, names=None, *, module=None, qualname=None,
+ type=None, start=1, boundary=None)
+inheritances:
+- builtins.str
+- enum.Enum
+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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextDataset.yml
index b1675b5aabe9..297cdce2142c 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextDataset.yml
@@ -10,111 +10,134 @@ summary: 'Delimited text dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'DelimitedTextDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, location: _models.DatasetLocation | None
- = None, column_delimiter: MutableMapping[str, Any] | None = None, row_delimiter:
- MutableMapping[str, Any] | None = None, encoding_name: MutableMapping[str, Any]
- | None = None, compression_codec: MutableMapping[str, Any] | None = None, compression_level:
- MutableMapping[str, Any] | None = None, quote_char: MutableMapping[str, Any] |
- None = None, escape_char: MutableMapping[str, Any] | None = None, first_row_as_header:
- MutableMapping[str, Any] | None = None, null_value: MutableMapping[str, Any] |
- None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: location
description: The location of the delimited text storage.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetLocation>
- name: column_delimiter
description: 'The column delimiter. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: row_delimiter
description: 'The row delimiter. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: encoding_name
description: 'The code page name of the preferred encoding. If miss, the default
+ value
- value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name
- column of the
+ is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column
+ of the table in
- table in the following link to set supported values:
+ 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:
- - <xref:JSON>
+ - <xref:object>
- name: compression_codec
- description: 'The data compressionCodec. Type: string (or Expression with
+ description: 'Possible values include: "bzip2", "gzip", "deflate", "zipDeflate",
- resultType string).'
+ "snappy", "lz4".'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:str>
+ - <xref:azure.synapse.artifacts.models.DelimitedTextCompressionCodec>
- name: compression_level
- description: The data compression method used for DelimitedText.
+ description: 'The data compression method used for DelimitedText. Possible values
+
+ include: "Optimal", "Fastest".'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:str>
+ - <xref:azure.synapse.artifacts.models.DatasetCompressionLevel>
- name: quote_char
description: 'The quote character. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: escape_char
description: 'The escape character. Type: string (or Expression with resultType
-
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: first_row_as_header
description: 'When used as input, treat the first row of data as headers. When
@@ -122,121 +145,12 @@ constructor:
default value is
false. Type: boolean (or Expression with resultType boolean).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: null_value
description: 'The null value string. Type: string (or Expression with resultType
-
string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: The location of the delimited text storage.
- name: location
- types:
- - <xref:azure.synapse.artifacts.models.DatasetLocation>
-- description: 'The column delimiter. Type: string (or Expression with resultType
-
- string).'
- name: column_delimiter
- types:
- - <xref:JSON>
-- description: 'The row delimiter. Type: string (or Expression with resultType string).'
- name: row_delimiter
- types:
- - <xref:JSON>
-- 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).'
- name: encoding_name
- types:
- - <xref:JSON>
-- description: 'The data compressionCodec. Type: string (or Expression with resultType
-
- string).'
- name: compression_codec
- types:
- - <xref:JSON>
-- description: The data compression method used for DelimitedText.
- name: compression_level
- types:
- - <xref:JSON>
-- description: 'The quote character. Type: string (or Expression with resultType string).'
- name: quote_char
- types:
- - <xref:JSON>
-- description: 'The escape character. Type: string (or Expression with resultType
- string).'
- name: escape_char
- types:
- - <xref:JSON>
-- 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).'
- name: first_row_as_header
- types:
- - <xref:JSON>
-- description: 'The null value string. Type: string (or Expression with resultType
- string).'
- name: null_value
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextReadSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextReadSettings.yml
deleted file mode 100644
index c96f522299a6..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextReadSettings.yml
+++ /dev/null
@@ -1,55 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.DelimitedTextReadSettings
-name: DelimitedTextReadSettings
-fullName: azure.synapse.artifacts.models.DelimitedTextReadSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.FormatReadSettings
-summary: 'Delimited text read settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'DelimitedTextReadSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, skip_line_count: MutableMapping[str, Any] | None = None,
- compression_properties: _models.CompressionReadSettings | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: skip_line_count
- description: 'Indicates the number of non-empty rows to skip when reading data
- from
-
- input files. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: compression_properties
- description: Compression settings.
- types:
- - <xref:azure.synapse.artifacts.models.CompressionReadSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The read setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Indicates the number of non-empty rows to skip when reading data from
-
- input files. Type: integer (or Expression with resultType integer).'
- name: skip_line_count
- types:
- - <xref:JSON>
-- description: Compression settings.
- name: compression_properties
- types:
- - <xref:azure.synapse.artifacts.models.CompressionReadSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextSink.yml
deleted file mode 100644
index 6df5e0770340..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextSink.yml
+++ /dev/null
@@ -1,113 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.DelimitedTextSink
-name: DelimitedTextSink
-fullName: azure.synapse.artifacts.models.DelimitedTextSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity DelimitedText sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'DelimitedTextSink(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, write_batch_size: MutableMapping[str, Any] | None = None,
- write_batch_timeout: MutableMapping[str, Any] | None = None, sink_retry_count:
- MutableMapping[str, Any] | None = None, sink_retry_wait: MutableMapping[str, Any]
- | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None,
- store_settings: _models.StoreWriteSettings | None = None, format_settings: _models.DelimitedTextWriteSettings
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: store_settings
- description: DelimitedText store settings.
- types:
- - <xref:azure.synapse.artifacts.models.StoreWriteSettings>
- - name: format_settings
- description: DelimitedText format settings.
- types:
- - <xref:azure.synapse.artifacts.models.DelimitedTextWriteSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: DelimitedText store settings.
- name: store_settings
- types:
- - <xref:azure.synapse.artifacts.models.StoreWriteSettings>
-- description: DelimitedText format settings.
- name: format_settings
- types:
- - <xref:azure.synapse.artifacts.models.DelimitedTextWriteSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextSource.yml
deleted file mode 100644
index af05c97cd565..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextSource.yml
+++ /dev/null
@@ -1,101 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.DelimitedTextSource
-name: DelimitedTextSource
-fullName: azure.synapse.artifacts.models.DelimitedTextSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity DelimitedText source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'DelimitedTextSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, store_settings: _models.StoreReadSettings
- | None = None, format_settings: _models.DelimitedTextReadSettings | None = None,
- additional_columns: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: store_settings
- description: DelimitedText store settings.
- types:
- - <xref:azure.synapse.artifacts.models.StoreReadSettings>
- - name: format_settings
- description: DelimitedText format settings.
- types:
- - <xref:azure.synapse.artifacts.models.DelimitedTextReadSettings>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: DelimitedText store settings.
- name: store_settings
- types:
- - <xref:azure.synapse.artifacts.models.StoreReadSettings>
-- description: DelimitedText format settings.
- name: format_settings
- types:
- - <xref:azure.synapse.artifacts.models.DelimitedTextReadSettings>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextWriteSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextWriteSettings.yml
deleted file mode 100644
index 242801a8d2ab..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextWriteSettings.yml
+++ /dev/null
@@ -1,93 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.DelimitedTextWriteSettings
-name: DelimitedTextWriteSettings
-fullName: azure.synapse.artifacts.models.DelimitedTextWriteSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.FormatWriteSettings
-summary: 'Delimited text write settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'DelimitedTextWriteSettings(*, file_extension: MutableMapping[str, Any],
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, quote_all_text:
- MutableMapping[str, Any] | None = None, max_rows_per_file: MutableMapping[str,
- Any] | None = None, file_name_prefix: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: quote_all_text
- description: 'Indicates whether string values should always be enclosed with quotes.
-
- Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: file_extension
- description: 'The file extension used to create the files. Type: string (or
-
- Expression with resultType string). Required.'
- types:
- - <xref:JSON>
- - name: max_rows_per_file
- description: 'Limit the written file''s row count to be smaller than or equal
- to
-
- the specified count. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: file_name_prefix
- description: 'Specifies the file name pattern
-
- >>:code:`<fileNamePrefix>`_<<`<fileIndex>`.:code:*<fileExtension>* when copy
- from non-file
-
- based store without partitionOptions. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The write setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Indicates whether string values should always be enclosed with quotes.
-
- Type: boolean (or Expression with resultType boolean).'
- name: quote_all_text
- types:
- - <xref:JSON>
-- description: 'The file extension used to create the files. Type: string (or Expression
-
- with resultType string). Required.'
- name: file_extension
- types:
- - <xref:JSON>
-- description: 'Limit the written file''s row count to be smaller than or equal to
- the
-
- specified count. Type: integer (or Expression with resultType integer).'
- name: max_rows_per_file
- types:
- - <xref:JSON>
-- description: 'Specifies the file name pattern
-
- >>:code:`<fileNamePrefix>`_<<`<fileIndex>`.:code:*<fileExtension>* when copy from
- non-file
-
- based store without partitionOptions. Type: string (or Expression with resultType
- string).'
- name: file_name_prefix
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DependencyCondition.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DependencyCondition.yml
index 8eeb8b9261e1..e87bbb91a38c 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DependencyCondition.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DependencyCondition.yml
@@ -2,7 +2,6 @@
uid: azure.synapse.artifacts.models.DependencyCondition
name: DependencyCondition
fullName: azure.synapse.artifacts.models.DependencyCondition
-summary: DependencyCondition.
module: azure.synapse.artifacts.models
constructor:
syntax: DependencyCondition(value, names=None, *, module=None, qualname=None, type=None,
@@ -11,11 +10,11 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DependencyReference.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DependencyReference.yml
deleted file mode 100644
index 7fab31980346..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DependencyReference.yml
+++ /dev/null
@@ -1,24 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.DependencyReference
-name: DependencyReference
-fullName: azure.synapse.artifacts.models.DependencyReference
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Referenced dependency.
-
-
- You probably want to use the sub-classes and not this class directly. Known sub-classes
- are:
-
- SelfDependencyTumblingWindowTriggerReference, TriggerDependencyReference
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'DependencyReference(**kwargs: Any)'
-variables:
-- description: The type of dependency reference. Required.
- name: type
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DistcpSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DistcpSettings.yml
deleted file mode 100644
index 507cac46fabc..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DistcpSettings.yml
+++ /dev/null
@@ -1,59 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.DistcpSettings
-name: DistcpSettings
-fullName: azure.synapse.artifacts.models.DistcpSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Distcp settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'DistcpSettings(*, resource_manager_endpoint: MutableMapping[str, Any],
- temp_script_path: MutableMapping[str, Any], distcp_options: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: resource_manager_endpoint
- description: 'Specifies the Yarn ResourceManager endpoint. Type: string
-
- (or Expression with resultType string). Required.'
- types:
- - <xref:JSON>
- - name: temp_script_path
- description: 'Specifies an existing folder path which will be used to store temp
-
- Distcp command script. The script file is generated by ADF and will be removed
- after Copy job
-
- finished. Type: string (or Expression with resultType string). Required.'
- types:
- - <xref:JSON>
- - name: distcp_options
- description: 'Specifies the Distcp options. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Specifies the Yarn ResourceManager endpoint. Type: string (or
-
- Expression with resultType string). Required.'
- name: resource_manager_endpoint
- types:
- - <xref:JSON>
-- description: 'Specifies an existing folder path which will be used to store temp
-
- Distcp command script. The script file is generated by ADF and will be removed
- after Copy job
-
- finished. Type: string (or Expression with resultType string). Required.'
- name: temp_script_path
- types:
- - <xref:JSON>
-- description: 'Specifies the Distcp options. Type: string (or Expression with resultType
-
- string).'
- name: distcp_options
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DocumentDbCollectionDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DocumentDbCollectionDataset.yml
index 236f3441c809..e56095da5b65 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DocumentDbCollectionDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DocumentDbCollectionDataset.yml
@@ -10,112 +10,72 @@ 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: _models.LinkedServiceReference,
- collection_name: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, structure: MutableMapping[str,
- Any] | None = None, schema: MutableMapping[str, Any] | None = None, parameters:
- Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str,
- Any]] | None = None, folder: _models.DatasetFolder | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: collection_name
- description: 'Document Database collection name. Type: string (or Expression with
+ description: 'Required. Document Database collection name. Type: string (or
- resultType string). Required.'
+ Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'Document Database collection name. Type: string (or Expression with
-
- resultType string). Required.'
- name: collection_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DocumentDbCollectionSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DocumentDbCollectionSink.yml
deleted file mode 100644
index 6dce4d893ca7..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DocumentDbCollectionSink.yml
+++ /dev/null
@@ -1,121 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.DocumentDbCollectionSink
-name: DocumentDbCollectionSink
-fullName: azure.synapse.artifacts.models.DocumentDbCollectionSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Document Database Collection sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'DocumentDbCollectionSink(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, write_batch_size: MutableMapping[str, Any] | None = None,
- write_batch_timeout: MutableMapping[str, Any] | None = None, sink_retry_count:
- MutableMapping[str, Any] | None = None, sink_retry_wait: MutableMapping[str, Any]
- | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None,
- nesting_separator: MutableMapping[str, Any] | None = None, write_behavior: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: nesting_separator
- description: 'Nested properties separator. Default is . (dot). Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: write_behavior
- description: 'Describes how to write data to Azure Cosmos DB. Type: string (or
-
- Expression with resultType string). Allowed values: insert and upsert.'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Nested properties separator. Default is . (dot). Type: string (or
-
- Expression with resultType string).'
- name: nesting_separator
- types:
- - <xref:JSON>
-- description: 'Describes how to write data to Azure Cosmos DB. Type: string (or
-
- Expression with resultType string). Allowed values: insert and upsert.'
- name: write_behavior
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DocumentDbCollectionSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DocumentDbCollectionSource.yml
deleted file mode 100644
index 5d15fbdad89e..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DocumentDbCollectionSource.yml
+++ /dev/null
@@ -1,118 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.DocumentDbCollectionSource
-name: DocumentDbCollectionSource
-fullName: azure.synapse.artifacts.models.DocumentDbCollectionSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity Document Database Collection source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'DocumentDbCollectionSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, nesting_separator: MutableMapping[str, Any] | None = None, query_timeout:
- MutableMapping[str, Any] | None = None, additional_columns: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query
- description: 'Documents query. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: nesting_separator
- description: 'Nested properties separator. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Documents query. Type: string (or Expression with resultType string).'
- name: query
- types:
- - <xref:JSON>
-- description: 'Nested properties separator. Type: string (or Expression with
-
- resultType string).'
- name: nesting_separator
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillLinkedService.yml
index 142a20429089..0d145c0f8615 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillLinkedService.yml
@@ -10,98 +10,63 @@ summary: 'Drill server linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'DrillLinkedService(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, connection_string:
- MutableMapping[str, Any] | None = None, pwd: _models.AzureKeyVaultSecretReference
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
description: 'An ODBC connection string. Type: string, SecureString or
AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: pwd
description: The Azure key vault secret reference of password in connection string.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'An ODBC connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of password in connection string.
- name: pwd
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillSource.yml
deleted file mode 100644
index 8370fb421d4d..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.DrillSource
-name: DrillSource
-fullName: azure.synapse.artifacts.models.DrillSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Drill server source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'DrillSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillTableDataset.yml
index 3a83e57cd1a7..3873942257ed 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillTableDataset.yml
@@ -10,137 +10,86 @@ summary: 'Drill server dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'DrillTableDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, table: MutableMapping[str, Any] | None = None, schema_type_properties_schema:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'This property will be retired. Please consider using schema + table
properties instead.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: table
description: 'The table name of the Drill. Type: string (or Expression with resultType
-
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: schema_type_properties_schema
- description: 'The schema name of the Drill. Type: string (or
+ description: 'The schema name of the Drill. Type: string (or Expression
- Expression with resultType string).'
+ with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'This property will be retired. Please consider using schema + table
-
- properties instead.'
- name: table_name
- types:
- - <xref:JSON>
-- description: 'The table name of the Drill. Type: string (or Expression with resultType
- string).'
- name: table
- types:
- - <xref:JSON>
-- description: 'The schema name of the Drill. Type: string (or Expression
-
- with resultType string).'
- name: schema_type_properties_schema
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicExecutorAllocation.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicExecutorAllocation.yml
deleted file mode 100644
index 4059f67a345d..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicExecutorAllocation.yml
+++ /dev/null
@@ -1,20 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.DynamicExecutorAllocation
-name: DynamicExecutorAllocation
-fullName: azure.synapse.artifacts.models.DynamicExecutorAllocation
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Dynamic Executor Allocation Properties.
-constructor:
- syntax: 'DynamicExecutorAllocation(*, enabled: bool | None = None, **kwargs: Any)'
- parameters:
- - name: enabled
- description: Indicates whether Dynamic Executor Allocation is enabled or not.
- types:
- - <xref:bool>
-variables:
-- description: Indicates whether Dynamic Executor Allocation is enabled or not.
- name: enabled
- types:
- - <xref:bool>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXLinkedService.yml
index 394c52ad8ec7..4a4b7aa4a4be 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXLinkedService.yml
@@ -10,155 +10,96 @@ summary: 'Dynamics AX linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'DynamicsAXLinkedService(*, url: MutableMapping[str, Any], service_principal_id:
- MutableMapping[str, Any], service_principal_key: _models.SecretBase, tenant: MutableMapping[str,
- Any], aad_resource_id: MutableMapping[str, Any], additional_properties: Dict[str,
- MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, encrypted_credential:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: url
- description: 'The Dynamics AX (or Dynamics 365 Finance and Operations) instance
- OData endpoint.
+ description: 'Required. The Dynamics AX (or Dynamics 365 Finance and Operations)
+ instance OData
- Required.'
+ endpoint.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_id
- description: 'Specify the application''s client ID. Type: string (or Expression
+ description: 'Required. Specify the application''s client ID. Type: string (or
- with resultType string). Required.'
+ Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_key
- description: 'Specify the application''s key. Mark this field as a
+ 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). Required.'
+ Vault. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: tenant
- description: 'Specify the tenant information (domain name or tenant ID) under
- which your
+ description: 'Required. Specify the tenant information (domain name or tenant
+ ID) under which
- application resides. Retrieve it by hovering the mouse in the top-right corner
- of the Azure
+ your application resides. Retrieve it by hovering the mouse in the top-right
+ corner of the
- portal. Type: string (or Expression with resultType string). Required.'
+ Azure portal. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: aad_resource_id
- description: 'Specify the resource you are requesting authorization. Type: string
+ description: 'Required. Specify the resource you are requesting authorization.
+ Type:
- (or Expression with resultType string). Required.'
+ string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The Dynamics AX (or Dynamics 365 Finance and Operations) instance
- OData endpoint.
-
- Required.'
- name: url
- types:
- - <xref:JSON>
-- description: 'Specify the application''s client ID. Type: string (or Expression
-
- with resultType string). Required.'
- name: service_principal_id
- types:
- - <xref:JSON>
-- description: '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). Required.'
- name: service_principal_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: '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). Required.'
- name: tenant
- types:
- - <xref:JSON>
-- description: 'Specify the resource you are requesting authorization. Type: string
- (or
-
- Expression with resultType string). Required.'
- name: aad_resource_id
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXResourceDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXResourceDataset.yml
index cf35fcd01ec1..56a2a8c1595f 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXResourceDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXResourceDataset.yml
@@ -10,114 +10,73 @@ 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: _models.LinkedServiceReference,
- path: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, structure: MutableMapping[str,
- Any] | None = None, schema: MutableMapping[str, Any] | None = None, parameters:
- Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str,
- Any]] | None = None, folder: _models.DatasetFolder | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: path
- description: 'The path of the Dynamics AX OData entity. Type: string (or Expression
- with
+ description: 'Required. The path of the Dynamics AX OData entity. Type: string
+ (or Expression
- resultType string). Required.'
+ with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The path of the Dynamics AX OData entity. Type: string (or Expression
- with
-
- resultType string). Required.'
- name: path
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXSource.yml
deleted file mode 100644
index af6b57e27824..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXSource.yml
+++ /dev/null
@@ -1,134 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.DynamicsAXSource
-name: DynamicsAXSource
-fullName: azure.synapse.artifacts.models.DynamicsAXSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Dynamics AX source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'DynamicsAXSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, query:
- MutableMapping[str, Any] | None = None, http_request_timeout: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: http_request_timeout
- description: 'The timeout (TimeSpan) to get an HTTP response. It is the
-
- timeout to get a response, not the timeout to read response data. Default value:
- 00:05:00.
-
- Type: string (or Expression with resultType string), pattern:
-
- ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
-- description: 'The timeout (TimeSpan) to get an HTTP response. It is the timeout
-
- to get a response, not the timeout to read response data. Default value: 00:05:00.
- Type: string
-
- (or Expression with resultType string), pattern:
-
- ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: http_request_timeout
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAuthenticationType.yml
index 2f39483fd961..f7f2224b4a12 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAuthenticationType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAuthenticationType.yml
@@ -2,7 +2,13 @@
uid: azure.synapse.artifacts.models.DynamicsAuthenticationType
name: DynamicsAuthenticationType
fullName: azure.synapse.artifacts.models.DynamicsAuthenticationType
-summary: All available dynamicsAuthenticationType values.
+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
constructor:
syntax: DynamicsAuthenticationType(value, names=None, *, module=None, qualname=None,
@@ -11,9 +17,9 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmEntityDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmEntityDataset.yml
index 10ba4851ff85..9d94330ff93b 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmEntityDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmEntityDataset.yml
@@ -10,113 +10,74 @@ summary: 'The Dynamics CRM entity dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'DynamicsCrmEntityDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, entity_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: entity_name
description: 'The logical name of the entity. Type: string (or Expression with
+ resultType
- resultType string).'
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The logical name of the entity. Type: string (or Expression with resultType
-
- string).'
- name: entity_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmLinkedService.yml
index 619d13b59bde..ba64f39209bf 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmLinkedService.yml
@@ -10,50 +10,62 @@ summary: 'Dynamics CRM linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'DynamicsCrmLinkedService(*, deployment_type: MutableMapping[str, Any],
- authentication_type: MutableMapping[str, Any], additional_properties: Dict[str,
- MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, host_name:
- MutableMapping[str, Any] | None = None, port: MutableMapping[str, Any] | None
- = None, service_uri: MutableMapping[str, Any] | None = None, organization_name:
- MutableMapping[str, Any] | None = None, username: MutableMapping[str, Any] | None
- = None, password: _models.SecretBase | None = None, service_principal_id: MutableMapping[str,
- Any] | None = None, service_principal_credential_type: MutableMapping[str, Any]
- | None = None, service_principal_credential: _models.SecretBase | None = None,
- encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: deployment_type
- description: 'The deployment type of the Dynamics CRM instance. ''Online'' for
+ 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:
- Dynamics CRM Online and ''OnPremisesWithIfd'' for Dynamics CRM on-premises with
- Ifd. Type: string
+ string (or Expression with resultType string). Possible values include: "Online",
- (or Expression with resultType string). Required.'
+ "OnPremisesWithIfd".'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:str>
+ - <xref:azure.synapse.artifacts.models.DynamicsDeploymentType>
- name: host_name
description: 'The host name of the on-premises Dynamics CRM server. The property
is
@@ -62,25 +74,29 @@ constructor:
with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: port
description: 'The port of on-premises Dynamics CRM server. The property is required
- for
+ for on-prem
- on-prem and not allowed for online. Default is 443. Type: integer (or Expression
- with
+ and not allowed for online. Default is 443. Type: integer (or Expression with
+ resultType
- resultType integer), minimum: 0.'
+ integer), minimum: 0.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: service_uri
description: 'The URL to the Microsoft Dynamics CRM server. The property is required
+ for
- for on-line and not allowed for on-prem. Type: string (or Expression with resultType
+ on-line and not allowed for on-prem. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: organization_name
description: 'The organization name of the Dynamics CRM instance. The property
is
@@ -90,29 +106,36 @@ constructor:
instances associated with the user. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: authentication_type
- description: 'The authentication type to connect to Dynamics CRM server.
+ description: 'Required. The authentication type to connect to Dynamics CRM
+
+ server. ''Office365'' for online scenario, ''Ifd'' for on-premises with Ifd
+ scenario,
- ''Office365'' for online scenario, ''Ifd'' for on-premises with Ifd scenario,
- ''AADServicePrincipal''
+ ''AADServicePrincipal'' for Server-To-Server authentication in online scenario.
+ Type: string (or
- for Server-To-Server authentication in online scenario. Type: string (or Expression
- with
+ Expression with resultType string). Possible values include: "Office365", "Ifd",
- resultType string). Required.'
+ "AADServicePrincipal".'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:str>
+ - <xref:azure.synapse.artifacts.models.DynamicsAuthenticationType>
- name: username
description: 'User name to access the Dynamics CRM instance. Type: string (or
Expression
with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: Password to access the Dynamics CRM instance.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: service_principal_id
@@ -120,14 +143,22 @@ constructor:
for Server-To-Server authentication. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_credential_type
- description: 'A string from ServicePrincipalCredentialEnum or an
+ description: 'The service principal credential type to use in
+
+ Server-To-Server authentication. ''ServicePrincipalKey'' for key/secret, ''ServicePrincipalCert''
- expression.'
+ for certificate. Type: string (or Expression with resultType string). Possible
+ values include:
+
+ "ServicePrincipalKey", "ServicePrincipalCert".'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:str>
+ - <xref:azure.synapse.artifacts.models.DynamicsServicePrincipalCredentialType>
- name: service_principal_credential
description: 'The credential of the service principal object in Azure
@@ -140,144 +171,16 @@ constructor:
can only
be AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: '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). Required.'
- name: deployment_type
- types:
- - <xref:JSON>
-- 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).'
- name: host_name
- types:
- - <xref:JSON>
-- 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.'
- name: port
- types:
- - <xref:JSON>
-- 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).'
- name: service_uri
- types:
- - <xref:JSON>
-- 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).'
- name: organization_name
- types:
- - <xref:JSON>
-- description: '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). Required.'
- name: authentication_type
- types:
- - <xref:JSON>
-- description: 'User name to access the Dynamics CRM instance. Type: string (or Expression
- with
-
- resultType string).'
- name: username
- types:
- - <xref:JSON>
-- description: Password to access the Dynamics CRM instance.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The client ID of the application in Azure Active Directory used for
-
- Server-To-Server authentication. Type: string (or Expression with resultType string).'
- name: service_principal_id
- types:
- - <xref:JSON>
-- description: 'A string from ServicePrincipalCredentialEnum or an
-
- expression.'
- name: service_principal_credential_type
- types:
- - <xref:JSON>
-- 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.'
- name: service_principal_credential
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmSink.yml
deleted file mode 100644
index beb3ad022364..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmSink.yml
+++ /dev/null
@@ -1,138 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.DynamicsCrmSink
-name: DynamicsCrmSink
-fullName: azure.synapse.artifacts.models.DynamicsCrmSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Dynamics CRM sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'DynamicsCrmSink(*, write_behavior: str | _models.DynamicsSinkWriteBehavior,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, write_batch_size:
- MutableMapping[str, Any] | None = None, write_batch_timeout: MutableMapping[str,
- Any] | None = None, sink_retry_count: MutableMapping[str, Any] | None = None,
- sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, ignore_null_values: MutableMapping[str,
- Any] | None = None, alternate_key_name: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: write_behavior
- description: The write behavior for the operation. Required. "Upsert"
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.DynamicsSinkWriteBehavior>
- - name: ignore_null_values
- description: 'The flag indicating whether to ignore null values from input
-
- dataset (except key fields) during write operation. Default is false. Type:
- boolean (or
-
- Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: alternate_key_name
- description: 'The logical name of the alternate key which will be used when
-
- upserting records. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: The write behavior for the operation. Required. "Upsert"
- name: write_behavior
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.DynamicsSinkWriteBehavior>
-- description: 'The flag indicating whether to ignore null values from input dataset
-
- (except key fields) during write operation. Default is false. Type: boolean (or
- Expression with
-
- resultType boolean).'
- name: ignore_null_values
- types:
- - <xref:JSON>
-- description: 'The logical name of the alternate key which will be used when
-
- upserting records. Type: string (or Expression with resultType string).'
- name: alternate_key_name
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmSource.yml
deleted file mode 100644
index d2a0022ba958..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmSource.yml
+++ /dev/null
@@ -1,99 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.DynamicsCrmSource
-name: DynamicsCrmSource
-fullName: azure.synapse.artifacts.models.DynamicsCrmSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity Dynamics CRM source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'DynamicsCrmSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, additional_columns: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query
- description: 'FetchXML is a proprietary query language that is used in Microsoft
- Dynamics CRM
-
- (online & on-premises). Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'FetchXML is a proprietary query language that is used in Microsoft
- Dynamics CRM
-
- (online & on-premises). Type: string (or Expression with resultType string).'
- name: query
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsDeploymentType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsDeploymentType.yml
index e9d2b83d7b7d..59b827d2f88d 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsDeploymentType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsDeploymentType.yml
@@ -2,7 +2,13 @@
uid: azure.synapse.artifacts.models.DynamicsDeploymentType
name: DynamicsDeploymentType
fullName: azure.synapse.artifacts.models.DynamicsDeploymentType
-summary: All available dynamicsDeploymentType values.
+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
constructor:
syntax: DynamicsDeploymentType(value, names=None, *, module=None, qualname=None,
@@ -11,7 +17,7 @@ inheritances:
- builtins.str
- enum.Enum
fields:
-- name: ONLINE
- uid: azure.synapse.artifacts.models.DynamicsDeploymentType.ONLINE
-- name: ON_PREMISES_WITH_IFD
- uid: azure.synapse.artifacts.models.DynamicsDeploymentType.ON_PREMISES_WITH_IFD
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsEntityDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsEntityDataset.yml
index b3ed311d35bb..8c0233b35b90 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsEntityDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsEntityDataset.yml
@@ -10,113 +10,73 @@ summary: 'The Dynamics entity dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'DynamicsEntityDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, entity_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: entity_name
description: 'The logical name of the entity. Type: string (or Expression with
+ resultType
- resultType string).'
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The logical name of the entity. Type: string (or Expression with resultType
-
- string).'
- name: entity_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsLinkedService.yml
index cfa0e448bedf..9237b5707624 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsLinkedService.yml
@@ -10,77 +10,90 @@ summary: 'Dynamics linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'DynamicsLinkedService(*, deployment_type: MutableMapping[str, Any], authentication_type:
- MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, host_name:
- MutableMapping[str, Any] | None = None, port: MutableMapping[str, Any] | None
- = None, service_uri: MutableMapping[str, Any] | None = None, organization_name:
- MutableMapping[str, Any] | None = None, username: MutableMapping[str, Any] | None
- = None, password: _models.SecretBase | None = None, service_principal_id: MutableMapping[str,
- Any] | None = None, service_principal_credential_type: MutableMapping[str, Any]
- | None = None, service_principal_credential: _models.SecretBase | None = None,
- encrypted_credential: MutableMapping[str, Any] | None = None, credential: _models.CredentialReference
- | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: deployment_type
- description: 'The deployment type of the Dynamics instance. ''Online'' for Dynamics
+ description: 'Required. The deployment type of the Dynamics instance. ''Online''
+ for
- Online and ''OnPremisesWithIfd'' for Dynamics on-premises with Ifd. Type: string
- (or Expression
+ Dynamics Online and ''OnPremisesWithIfd'' for Dynamics on-premises with Ifd.
+ Type: string (or
- with resultType string). Required.'
+ Expression with resultType string). Possible values include: "Online", "OnPremisesWithIfd".'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:str>
+ - <xref:azure.synapse.artifacts.models.DynamicsDeploymentType>
- 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:
- - <xref:JSON>
+ - <xref:str>
- name: port
description: 'The port of on-premises Dynamics server. The property is required
- for on-prem
+ for on-prem and
- and not allowed for online. Default is 443. Type: integer (or Expression with
- resultType
+ not allowed for online. Default is 443. Type: integer (or Expression with resultType
+ integer),
- integer), minimum: 0.'
+ minimum: 0.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:str>
- name: service_uri
description: 'The URL to the Microsoft Dynamics server. The property is required
- for
+ for on-
- on-line and not allowed for on-prem. Type: string (or Expression with resultType
+ line and not allowed for on-prem. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:str>
- name: organization_name
description: 'The organization name of the Dynamics instance. The property is
@@ -88,10 +101,11 @@ constructor:
instances
associated with the user. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:str>
- name: authentication_type
- description: 'The authentication type to connect to Dynamics server.
+ description: 'Required. The authentication type to connect to Dynamics server.
''Office365'' for online scenario, ''Ifd'' for on-premises with Ifd scenario,
''AADServicePrincipal''
@@ -99,18 +113,22 @@ constructor:
for Server-To-Server authentication in online scenario. Type: string (or Expression
with
- resultType string). Required.'
+ resultType string). Possible values include: "Office365", "Ifd", "AADServicePrincipal".'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:str>
+ - <xref:azure.synapse.artifacts.models.DynamicsAuthenticationType>
- name: username
description: 'User name to access the Dynamics instance. Type: string (or Expression
with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: Password to access the Dynamics instance.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: service_principal_id
@@ -118,16 +136,22 @@ constructor:
for Server-To-Server authentication. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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).'
+ for certificate. Type: string (or Expression with resultType string). Possible
+ values include:
+
+ "ServicePrincipalKey", "ServicePrincipalCert".'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:str>
+ - <xref:azure.synapse.artifacts.models.DynamicsServicePrincipalCredentialType>
- name: service_principal_credential
description: 'The credential of the service principal object in Azure
@@ -140,153 +164,16 @@ constructor:
can only
be AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
- types:
- - <xref:JSON>
- - name: credential
- description: The credential reference containing authentication information.
+ resultType string).'
+ isRequired: true
types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: '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). Required.'
- name: deployment_type
- types:
- - <xref:JSON>
-- 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).'
- name: host_name
- types:
- - <xref:JSON>
-- 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.'
- name: port
- types:
- - <xref:JSON>
-- 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).'
- name: service_uri
- types:
- - <xref:JSON>
-- 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).'
- name: organization_name
- types:
- - <xref:JSON>
-- description: '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). Required.'
- name: authentication_type
- types:
- - <xref:JSON>
-- description: 'User name to access the Dynamics instance. Type: string (or Expression
- with
-
- resultType string).'
- name: username
- types:
- - <xref:JSON>
-- description: Password to access the Dynamics instance.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The client ID of the application in Azure Active Directory used for
-
- Server-To-Server authentication. Type: string (or Expression with resultType string).'
- name: service_principal_id
- types:
- - <xref:JSON>
-- 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).'
- name: service_principal_credential_type
- types:
- - <xref:JSON>
-- 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.'
- name: service_principal_credential
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
-- description: The credential reference containing authentication information.
- name: credential
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsServicePrincipalCredentialType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsServicePrincipalCredentialType.yml
index 2715929cd5d2..6bc6f73cdd75 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsServicePrincipalCredentialType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsServicePrincipalCredentialType.yml
@@ -16,7 +16,7 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsSink.yml
deleted file mode 100644
index 5be1d8b26750..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsSink.yml
+++ /dev/null
@@ -1,138 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.DynamicsSink
-name: DynamicsSink
-fullName: azure.synapse.artifacts.models.DynamicsSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Dynamics sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'DynamicsSink(*, write_behavior: str | _models.DynamicsSinkWriteBehavior,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, write_batch_size:
- MutableMapping[str, Any] | None = None, write_batch_timeout: MutableMapping[str,
- Any] | None = None, sink_retry_count: MutableMapping[str, Any] | None = None,
- sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, ignore_null_values: MutableMapping[str,
- Any] | None = None, alternate_key_name: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: write_behavior
- description: The write behavior for the operation. Required. "Upsert"
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.DynamicsSinkWriteBehavior>
- - name: ignore_null_values
- description: 'The flag indicating whether ignore null values from input dataset
-
- (except key fields) during write operation. Default is false. Type: boolean
- (or Expression with
-
- resultType boolean).'
- types:
- - <xref:JSON>
- - name: alternate_key_name
- description: 'The logical name of the alternate key which will be used when
-
- upserting records. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: The write behavior for the operation. Required. "Upsert"
- name: write_behavior
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.DynamicsSinkWriteBehavior>
-- description: 'The flag indicating whether ignore null values from input dataset
-
- (except key fields) during write operation. Default is false. Type: boolean (or
- Expression with
-
- resultType boolean).'
- name: ignore_null_values
- types:
- - <xref:JSON>
-- description: 'The logical name of the alternate key which will be used when
-
- upserting records. Type: string (or Expression with resultType string).'
- name: alternate_key_name
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsSinkWriteBehavior.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsSinkWriteBehavior.yml
deleted file mode 100644
index 20388b01743a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsSinkWriteBehavior.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.DynamicsSinkWriteBehavior
-name: DynamicsSinkWriteBehavior
-fullName: azure.synapse.artifacts.models.DynamicsSinkWriteBehavior
-summary: Defines values for DynamicsSinkWriteBehavior.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: DynamicsSinkWriteBehavior(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: UPSERT
- uid: azure.synapse.artifacts.models.DynamicsSinkWriteBehavior.UPSERT
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsSource.yml
deleted file mode 100644
index ffa2c176ff80..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsSource.yml
+++ /dev/null
@@ -1,99 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.DynamicsSource
-name: DynamicsSource
-fullName: azure.synapse.artifacts.models.DynamicsSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity Dynamics source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'DynamicsSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, additional_columns: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query
- description: 'FetchXML is a proprietary query language that is used in Microsoft
- Dynamics
-
- (online & on-premises). Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'FetchXML is a proprietary query language that is used in Microsoft
- Dynamics
-
- (online & on-premises). Type: string (or Expression with resultType string).'
- name: query
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EditTablesRequest.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EditTablesRequest.yml
deleted file mode 100644
index 923df8142a9f..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EditTablesRequest.yml
+++ /dev/null
@@ -1,21 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.EditTablesRequest
-name: EditTablesRequest
-fullName: azure.synapse.artifacts.models.EditTablesRequest
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: EditTablesRequest.
-constructor:
- syntax: 'EditTablesRequest(*, link_tables: List[_models.LinkTableRequest] | None
- = None, **kwargs: Any)'
- parameters:
- - name: link_tables
- description: Edit link tables request.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.LinkTableRequest>]
-variables:
-- description: Edit link tables request.
- name: link_tables
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.LinkTableRequest>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaLinkedService.yml
index 74f07d8ab33a..8a8a4b9ea70a 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaLinkedService.yml
@@ -10,58 +10,71 @@ summary: 'Eloqua server linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'EloquaLinkedService(*, endpoint: MutableMapping[str, Any], username: MutableMapping[str,
- Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- connect_via: _models.IntegrationRuntimeReference | None = None, description: str
- | None = None, parameters: Dict[str, _models.ParameterSpecification] | None =
- None, annotations: List[MutableMapping[str, Any]] | None = None, password: _models.SecretBase
- | None = None, use_encrypted_endpoints: MutableMapping[str, Any] | None = None,
- use_host_verification: MutableMapping[str, Any] | None = None, use_peer_verification:
- MutableMapping[str, Any] | None = None, encrypted_credential: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: endpoint
- description: The endpoint of the Eloqua server. (i.e. eloqua.example.com). Required.
+ description: Required. The endpoint of the Eloqua server. (i.e. eloqua.example.com).
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: username
- description: 'The site name and user name of your Eloqua account in the form:
+ description: 'Required. The site name and user name of your Eloqua account in
+ the form:
- sitename/username. (i.e. Eloqua/Alice). Required.'
+ sitename/username. (i.e. Eloqua/Alice).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: The password corresponding to the user name.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: use_encrypted_endpoints
- description: 'Specifies whether the data source endpoints are encrypted
+ description: 'Specifies whether the data source endpoints are encrypted using
- using HTTPS. The default value is true.'
+ HTTPS. The default value is true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_host_verification
description: 'Specifies whether to require the host name in the server''s
@@ -69,91 +82,23 @@ constructor:
default value is
true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The endpoint of the Eloqua server. (i.e. eloqua.example.com). Required.
- name: endpoint
- types:
- - <xref:JSON>
-- description: 'The site name and user name of your Eloqua account in the form:
-
- sitename/username. (i.e. Eloqua/Alice). Required.'
- name: username
- types:
- - <xref:JSON>
-- description: The password corresponding to the user name.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Specifies whether the data source endpoints are encrypted using
-
- HTTPS. The default value is true.'
- name: use_encrypted_endpoints
- types:
- - <xref:JSON>
-- 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.'
- name: use_host_verification
- types:
- - <xref:JSON>
-- description: 'Specifies whether to verify the identity of the server when
-
- connecting over SSL. The default value is true.'
- name: use_peer_verification
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaObjectDataset.yml
index 03b3cc409b93..6a8d29bd4ea2 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaObjectDataset.yml
@@ -10,109 +10,70 @@ summary: 'Eloqua server dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'EloquaObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The table name. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaSource.yml
deleted file mode 100644
index 05cf36b09eab..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.EloquaSource
-name: EloquaSource
-fullName: azure.synapse.artifacts.models.EloquaSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Eloqua server source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'EloquaSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EncryptionDetails.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EncryptionDetails.yml
deleted file mode 100644
index e814f0f3734d..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EncryptionDetails.yml
+++ /dev/null
@@ -1,28 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.EncryptionDetails
-name: EncryptionDetails
-fullName: azure.synapse.artifacts.models.EncryptionDetails
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Details of the encryption associated with the workspace.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.'
-constructor:
- syntax: 'EncryptionDetails(*, cmk: _models.CustomerManagedKeyDetails | None = None,
- **kwargs: Any)'
- parameters:
- - name: cmk
- description: Customer Managed Key Details.
- types:
- - <xref:azure.synapse.artifacts.models.CustomerManagedKeyDetails>
-variables:
-- description: Double Encryption enabled.
- name: double_encryption_enabled
- types:
- - <xref:bool>
-- description: Customer Managed Key Details.
- name: cmk
- types:
- - <xref:azure.synapse.artifacts.models.CustomerManagedKeyDetails>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EntityReference.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EntityReference.yml
deleted file mode 100644
index bfc0b027cba9..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EntityReference.yml
+++ /dev/null
@@ -1,35 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.EntityReference
-name: EntityReference
-fullName: azure.synapse.artifacts.models.EntityReference
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: The entity reference.
-constructor:
- syntax: 'EntityReference(*, type: str | _models.IntegrationRuntimeEntityReferenceType
- | None = None, reference_name: str | None = None, **kwargs: Any)'
- parameters:
- - name: type
- description: 'The type of this referenced entity. Known values are:
-
- "IntegrationRuntimeReference" and "LinkedServiceReference".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeEntityReferenceType>
- - name: reference_name
- description: The name of this referenced entity.
- types:
- - <xref:str>
-variables:
-- description: 'The type of this referenced entity. Known values are: "IntegrationRuntimeReference"
-
- and "LinkedServiceReference".'
- name: type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeEntityReferenceType>
-- description: The name of this referenced entity.
- name: reference_name
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Enum13.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Enum13.yml
deleted file mode 100644
index 766c684a373a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Enum13.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.Enum13
-name: Enum13
-fullName: azure.synapse.artifacts.models.Enum13
-summary: Enum13.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: Enum13(value, names=None, *, module=None, qualname=None, type=None, start=1,
- boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: APPENDBLOCK
- uid: azure.synapse.artifacts.models.Enum13.APPENDBLOCK
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ErrorAdditionalInfo.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ErrorAdditionalInfo.yml
deleted file mode 100644
index 0f9ece2e7991..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ErrorAdditionalInfo.yml
+++ /dev/null
@@ -1,22 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ErrorAdditionalInfo
-name: ErrorAdditionalInfo
-fullName: azure.synapse.artifacts.models.ErrorAdditionalInfo
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-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:
- - <xref:str>
-- description: The additional info.
- name: info
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ErrorContract.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ErrorContract.yml
deleted file mode 100644
index 2140525795c8..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ErrorContract.yml
+++ /dev/null
@@ -1,21 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ErrorContract
-name: ErrorContract
-fullName: azure.synapse.artifacts.models.ErrorContract
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Contains details when the response code indicates an error.
-constructor:
- syntax: 'ErrorContract(*, error: _models.ErrorResponse | None = None, **kwargs:
- Any)'
- parameters:
- - name: error
- description: The error details.
- types:
- - <xref:azure.synapse.artifacts.models.ErrorResponse>
-variables:
-- description: The error details.
- name: error
- types:
- - <xref:azure.synapse.artifacts.models.ErrorResponse>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ErrorResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ErrorResponse.yml
deleted file mode 100644
index b9b44882b02f..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ErrorResponse.yml
+++ /dev/null
@@ -1,37 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ErrorResponse
-name: ErrorResponse
-fullName: azure.synapse.artifacts.models.ErrorResponse
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-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: Any)'
-variables:
-- description: The error code.
- name: code
- types:
- - <xref:str>
-- description: The error message.
- name: message
- types:
- - <xref:str>
-- description: The error target.
- name: target
- types:
- - <xref:str>
-- description: The error details.
- name: details
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ErrorResponse>]
-- description: The error additional info.
- name: additional_info
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ErrorAdditionalInfo>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest.yml
index f7baa87e974b..557c195cdc1d 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest.yml
@@ -4,51 +4,35 @@ name: EvaluateDataFlowExpressionRequest
fullName: azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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: Any)'
+ expression: str | None = None, **kwargs)'
parameters:
- name: session_id
description: The ID of data flow debug session.
+ isRequired: true
types:
- <xref:str>
- name: data_flow_name
description: The data flow which contains the debug session.
+ isRequired: true
types:
- <xref:str>
- name: stream_name
description: The output stream name.
+ isRequired: true
types:
- <xref:str>
- name: row_limits
description: The row limit for preview request.
+ isRequired: true
types:
- <xref:int>
- name: expression
description: The expression for preview.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: The ID of data flow debug session.
- name: session_id
- types:
- - <xref:str>
-- description: The data flow which contains the debug session.
- name: data_flow_name
- types:
- - <xref:str>
-- description: The output stream name.
- name: stream_name
- types:
- - <xref:str>
-- description: The row limit for preview request.
- name: row_limits
- types:
- - <xref:int>
-- description: The expression for preview.
- name: expression
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EventSubscriptionStatus.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EventSubscriptionStatus.yml
index 6afa79e9d22e..dfa5d1722cb3 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EventSubscriptionStatus.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EventSubscriptionStatus.yml
@@ -11,13 +11,13 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExcelDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExcelDataset.yml
deleted file mode 100644
index 4b87982da7f9..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExcelDataset.yml
+++ /dev/null
@@ -1,197 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ExcelDataset
-name: ExcelDataset
-fullName: azure.synapse.artifacts.models.ExcelDataset
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.Dataset
-summary: 'Excel dataset.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ExcelDataset(*, linked_service_name: _models.LinkedServiceReference, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None,
- structure: MutableMapping[str, Any] | None = None, schema: MutableMapping[str,
- Any] | None = None, parameters: Dict[str, _models.ParameterSpecification] | None
- = None, annotations: List[MutableMapping[str, Any]] | None = None, folder: _models.DatasetFolder
- | None = None, location: _models.DatasetLocation | None = None, sheet_name: MutableMapping[str,
- Any] | None = None, sheet_index: MutableMapping[str, Any] | None = None, range:
- MutableMapping[str, Any] | None = None, first_row_as_header: MutableMapping[str,
- Any] | None = None, compression: _models.DatasetCompression | None = None, null_value:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Dataset description.
- types:
- - <xref:str>
- - name: structure
- description: 'Columns that define the structure of the dataset. Type: array (or
-
- Expression with resultType array), itemType: DatasetDataElement.'
- types:
- - <xref:JSON>
- - name: schema
- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- types:
- - <xref:JSON>
- - name: linked_service_name
- description: Linked service reference. Required.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: parameters
- description: Parameters for dataset.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the Dataset.
- types:
- - <xref:list>[<xref:JSON>]
- - name: folder
- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
-
- the root level.'
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
- - name: location
- description: The location of the excel storage.
- types:
- - <xref:azure.synapse.artifacts.models.DatasetLocation>
- - name: sheet_name
- description: 'The sheet name of excel file. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: sheet_index
- description: 'The sheet index of excel file and default value is 0. Type: integer
- (or
-
- Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: range
- description: 'The partial data of one sheet. Type: string (or Expression with
- resultType
-
- string).'
- types:
- - <xref:JSON>
- - 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).'
- types:
- - <xref:JSON>
- - name: compression
- description: The data compression method used for the json dataset.
- types:
- - <xref:azure.synapse.artifacts.models.DatasetCompression>
- - name: null_value
- description: 'The null value string. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: The location of the excel storage.
- name: location
- types:
- - <xref:azure.synapse.artifacts.models.DatasetLocation>
-- description: 'The sheet name of excel file. Type: string (or Expression with resultType
-
- string).'
- name: sheet_name
- types:
- - <xref:JSON>
-- description: 'The sheet index of excel file and default value is 0. Type: integer
- (or
-
- Expression with resultType integer).'
- name: sheet_index
- types:
- - <xref:JSON>
-- description: 'The partial data of one sheet. Type: string (or Expression with resultType
-
- string).'
- name: range
- types:
- - <xref:JSON>
-- 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).'
- name: first_row_as_header
- types:
- - <xref:JSON>
-- description: The data compression method used for the json dataset.
- name: compression
- types:
- - <xref:azure.synapse.artifacts.models.DatasetCompression>
-- description: 'The null value string. Type: string (or Expression with resultType
- string).'
- name: null_value
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExcelSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExcelSource.yml
deleted file mode 100644
index 0968f1f16cd0..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExcelSource.yml
+++ /dev/null
@@ -1,92 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ExcelSource
-name: ExcelSource
-fullName: azure.synapse.artifacts.models.ExcelSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity excel source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ExcelSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, store_settings: _models.StoreReadSettings | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: store_settings
- description: Excel store settings.
- types:
- - <xref:azure.synapse.artifacts.models.StoreReadSettings>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: Excel store settings.
- name: store_settings
- types:
- - <xref:azure.synapse.artifacts.models.StoreReadSettings>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivity.yml
index e21391c5df70..b56d2acda93f 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivity.yml
@@ -10,209 +10,73 @@ summary: 'Execute data flow activity.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'ExecuteDataFlowActivity(*, name: str, dataflow: _models.DataFlowReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, state: str | _models.ActivityState | None = None, on_inactive_mark_as:
- str | _models.ActivityOnInactiveMarkAs | None = None, depends_on: List[_models.ActivityDependency]
- | None = None, user_properties: List[_models.UserProperty] | None = None, linked_service_name:
- _models.LinkedServiceReference | None = None, policy: _models.ActivityPolicy |
- None = None, staging: _models.DataFlowStagingInfo | None = None, integration_runtime:
- _models.IntegrationRuntimeReference | None = None, compute: _models.ExecuteDataFlowActivityTypePropertiesCompute
- | None = None, trace_level: MutableMapping[str, Any] | None = None, continue_on_error:
- MutableMapping[str, Any] | None = None, run_concurrently: MutableMapping[str,
- Any] | None = None, source_staging_concurrency: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
- - name: dataflow
- description: Data flow reference. Required.
+ - name: data_flow
+ description: Required. Data flow reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DataFlowReference>
- name: staging
description: Staging info for execute data flow activity.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DataFlowStagingInfo>
- name: integration_runtime
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: compute
description: Compute properties for data flow activity.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute>
- - name: trace_level
- description: 'Trace level setting used for data flow monitoring output. Supported
-
- values are: ''coarse'', ''fine'', and ''none''. Type: string (or Expression
- with resultType string).'
- types:
- - <xref:JSON>
- - name: continue_on_error
- description: 'Continue on error setting used for data flow execution. Enables
-
- processing to continue if a sink fails. Type: boolean (or Expression with resultType
- boolean).'
- types:
- - <xref:JSON>
- - name: run_concurrently
- description: 'Concurrent run setting used for data flow execution. Allows sinks
-
- with the same save order to be processed concurrently. Type: boolean (or Expression
- with
-
- resultType boolean).'
- types:
- - <xref:JSON>
- - name: source_staging_concurrency
- description: 'Specify number of parallel staging for sources applicable
-
- to the sink. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: Data flow reference. Required.
- name: dataflow
- types:
- - <xref:azure.synapse.artifacts.models.DataFlowReference>
-- description: Staging info for execute data flow activity.
- name: staging
- types:
- - <xref:azure.synapse.artifacts.models.DataFlowStagingInfo>
-- description: The integration runtime reference.
- name: integration_runtime
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Compute properties for data flow activity.
- name: compute
- types:
- - <xref:azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute>
-- description: 'Trace level setting used for data flow monitoring output. Supported
- values
-
- are: ''coarse'', ''fine'', and ''none''. Type: string (or Expression with resultType
- string).'
- name: trace_level
- types:
- - <xref:JSON>
-- description: 'Continue on error setting used for data flow execution. Enables
-
- processing to continue if a sink fails. Type: boolean (or Expression with resultType
- boolean).'
- name: continue_on_error
- types:
- - <xref:JSON>
-- description: 'Concurrent run setting used for data flow execution. Allows sinks
- with
-
- the same save order to be processed concurrently. Type: boolean (or Expression
- with resultType
-
- boolean).'
- name: run_concurrently
- types:
- - <xref:JSON>
-- description: 'Specify number of parallel staging for sources applicable to
-
- the sink. Type: integer (or Expression with resultType integer).'
- name: source_staging_concurrency
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute.yml
index 6c2f6c5fd391..866799115310 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute.yml
@@ -4,38 +4,25 @@ name: ExecuteDataFlowActivityTypePropertiesCompute
fullName: azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: Compute properties for data flow activity.
constructor:
- syntax: 'ExecuteDataFlowActivityTypePropertiesCompute(*, compute_type: str | _models.DataFlowComputeType
- | None = None, core_count: int | None = None, **kwargs: Any)'
+ 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. Known
+ description: 'Compute type of the cluster which will execute data flow job. Possible
- values are: "General", "MemoryOptimized", and "ComputeOptimized".'
+ values include: "General", "MemoryOptimized", "ComputeOptimized".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.DataFlowComputeType>
- name: core_count
description: 'Core count of the cluster which will execute data flow job. Supported
+ values
- values are: 8, 16, 32, 48, 80, 144 and 272.'
+ are: 8, 16, 32, 48, 80, 144 and 272.'
+ isRequired: true
types:
- <xref:int>
-variables:
-- description: 'Compute type of the cluster which will execute data flow job. Known
- values
-
- are: "General", "MemoryOptimized", and "ComputeOptimized".'
- name: compute_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.DataFlowComputeType>
-- description: 'Core count of the cluster which will execute data flow job. Supported
- values
-
- are: 8, 16, 32, 48, 80, 144 and 272.'
- name: core_count
- types:
- - <xref:int>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutePipelineActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutePipelineActivity.yml
index 1045ade72db9..97cd2585149d 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutePipelineActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutePipelineActivity.yml
@@ -4,130 +4,63 @@ name: ExecutePipelineActivity
fullName: azure.synapse.artifacts.models.ExecutePipelineActivity
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts.models._models_py3.ControlActivity
+- azure.synapse.artifacts.models._models_py3.Activity
summary: 'Execute pipeline activity.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'ExecutePipelineActivity(*, name: str, pipeline: _models.PipelineReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, state: str | _models.ActivityState | None = None, on_inactive_mark_as:
- str | _models.ActivityOnInactiveMarkAs | None = None, depends_on: List[_models.ActivityDependency]
- | None = None, user_properties: List[_models.UserProperty] | None = None, parameters:
- Dict[str, MutableMapping[str, Any]] | None = None, wait_on_completion: bool |
- None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: pipeline
- description: Pipeline reference. Required.
+ description: Required. Pipeline reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.PipelineReference>
- name: parameters
description: Pipeline parameters.
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: wait_on_completion
description: 'Defines whether activity execution will wait for the dependent
pipeline execution to finish. Default is false.'
+ isRequired: true
types:
- <xref:bool>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Pipeline reference. Required.
- name: pipeline
- types:
- - <xref:azure.synapse.artifacts.models.PipelineReference>
-- description: Pipeline parameters.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: 'Defines whether activity execution will wait for the dependent
-
- pipeline execution to finish. Default is false.'
- name: wait_on_completion
- types:
- - <xref:bool>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteSSISPackageActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteSSISPackageActivity.yml
index ef0e4cab24db..dcd18487d3f4 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteSSISPackageActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteSSISPackageActivity.yml
@@ -10,72 +10,64 @@ summary: 'Execute SSIS package activity.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'ExecuteSSISPackageActivity(*, name: str, package_location: _models.SSISPackageLocation,
- connect_via: _models.IntegrationRuntimeReference, additional_properties: Dict[str,
- MutableMapping[str, Any]] | None = None, description: str | None = None, state:
- str | _models.ActivityState | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs
- | None = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, linked_service_name: _models.LinkedServiceReference
- | None = None, policy: _models.ActivityPolicy | None = None, runtime: MutableMapping[str,
- Any] | None = None, logging_level: MutableMapping[str, Any] | None = None, environment_path:
- MutableMapping[str, Any] | None = None, execution_credential: _models.SSISExecutionCredential
- | None = None, project_parameters: Dict[str, _models.SSISExecutionParameter] |
- None = None, package_parameters: Dict[str, _models.SSISExecutionParameter] | None
- = None, project_connection_managers: Dict[str, Dict[str, _models.SSISExecutionParameter]]
- | None = None, package_connection_managers: Dict[str, Dict[str, _models.SSISExecutionParameter]]
- | None = None, property_overrides: Dict[str, _models.SSISPropertyOverride] | None
- = None, log_location: _models.SSISLogLocation | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
- name: package_location
- description: SSIS package location. Required.
+ description: Required. SSIS package location.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SSISPackageLocation>
- name: runtime
@@ -83,165 +75,64 @@ constructor:
be "x86" or
"x64". Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: logging_level
- description: 'The logging level of SSIS package execution. Type: string (or
+ description: 'The logging level of SSIS package execution. Type: string (or Expression
- Expression with resultType string).'
+ with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: environment_path
description: 'The environment path to execute the SSIS package. Type: string (or
Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: execution_credential
description: The package execution credential.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SSISExecutionCredential>
- name: connect_via
- description: The integration runtime reference. Required.
+ description: Required. The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: project_parameters
description: The project level parameters to execute the SSIS package.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.SSISExecutionParameter>]
- name: package_parameters
description: The package level parameters to execute the SSIS package.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.SSISExecutionParameter>]
- name: project_connection_managers
description: 'The project level connection managers to execute the SSIS
package.'
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.SSISExecutionParameter>]]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: package_connection_managers
description: 'The package level connection managers to execute the SSIS
package.'
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.SSISExecutionParameter>]]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: property_overrides
description: The property overrides to execute the SSIS package.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.SSISPropertyOverride>]
- name: log_location
description: SSIS package execution log location.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SSISLogLocation>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: SSIS package location. Required.
- name: package_location
- types:
- - <xref:azure.synapse.artifacts.models.SSISPackageLocation>
-- description: 'Specifies the runtime to execute SSIS package. The value should be
- "x86" or
-
- "x64". Type: string (or Expression with resultType string).'
- name: runtime
- types:
- - <xref:JSON>
-- description: 'The logging level of SSIS package execution. Type: string (or Expression
-
- with resultType string).'
- name: logging_level
- types:
- - <xref:JSON>
-- description: 'The environment path to execute the SSIS package. Type: string (or
-
- Expression with resultType string).'
- name: environment_path
- types:
- - <xref:JSON>
-- description: The package execution credential.
- name: execution_credential
- types:
- - <xref:azure.synapse.artifacts.models.SSISExecutionCredential>
-- description: The integration runtime reference. Required.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: The project level parameters to execute the SSIS package.
- name: project_parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.SSISExecutionParameter>]
-- description: The package level parameters to execute the SSIS package.
- name: package_parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.SSISExecutionParameter>]
-- description: 'The project level connection managers to execute the SSIS
-
- package.'
- name: project_connection_managers
- types:
- - <xref:dict>[<xref:str>, <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.SSISExecutionParameter>]]
-- description: 'The package level connection managers to execute the SSIS
-
- package.'
- name: package_connection_managers
- types:
- - <xref:dict>[<xref:str>, <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.SSISExecutionParameter>]]
-- description: The property overrides to execute the SSIS package.
- name: property_overrides
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.SSISPropertyOverride>]
-- description: SSIS package execution log location.
- name: log_location
- types:
- - <xref:azure.synapse.artifacts.models.SSISLogLocation>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutionActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutionActivity.yml
index 7a114052449e..292d06afa868 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutionActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutionActivity.yml
@@ -8,133 +8,63 @@ inheritances:
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,
+ 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, ScriptActivity, SynapseSparkJobDefinitionActivity,
-
- SqlServerStoredProcedureActivity, SynapseNotebookActivity, WebActivity
+ 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, MutableMapping[str,
- Any]] | None = None, description: str | None = None, state: str | _models.ActivityState
- | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None
- = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, linked_service_name: _models.LinkedServiceReference
- | None = None, policy: _models.ActivityPolicy | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
- types:
- - <xref:str>
- - name: description
- description: Activity description.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExportSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExportSettings.yml
deleted file mode 100644
index 41d9fccba614..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExportSettings.yml
+++ /dev/null
@@ -1,38 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ExportSettings
-name: ExportSettings
-fullName: azure.synapse.artifacts.models.ExportSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Export command settings.
-
-
- You probably want to use the sub-classes and not this class directly. Known sub-classes
- are:
-
- AzureDatabricksDeltaLakeExportCommand, SnowflakeExportCopyCommand
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ExportSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The export setting type. Required.
- name: type
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExposureControlRequest.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExposureControlRequest.yml
index bd529641050f..4d4552300e88 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExposureControlRequest.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExposureControlRequest.yml
@@ -4,26 +4,19 @@ name: ExposureControlRequest
fullName: azure.synapse.artifacts.models.ExposureControlRequest
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: The exposure control request.
constructor:
syntax: 'ExposureControlRequest(*, feature_name: str | None = None, feature_type:
- str | None = None, **kwargs: Any)'
+ str | None = None, **kwargs)'
parameters:
- name: feature_name
description: The feature name.
+ isRequired: true
types:
- <xref:str>
- name: feature_type
description: The feature type.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: The feature name.
- name: feature_name
- types:
- - <xref:str>
-- description: The feature type.
- name: feature_type
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExposureControlResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExposureControlResponse.yml
index eaee19a92d56..e4d1e070faa5 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExposureControlResponse.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExposureControlResponse.yml
@@ -4,13 +4,13 @@ name: ExposureControlResponse
fullName: azure.synapse.artifacts.models.ExposureControlResponse
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'The exposure control response.
Variables are only populated by the server, and will be ignored when sending a request.'
constructor:
- syntax: 'ExposureControlResponse(**kwargs: Any)'
+ syntax: ExposureControlResponse(**kwargs)
variables:
- description: The feature name.
name: feature_name
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Expression.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Expression.yml
index bec9d90fb5bb..8c74f8af5402 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Expression.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Expression.yml
@@ -4,31 +4,28 @@ name: Expression
fullName: azure.synapse.artifacts.models.Expression
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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(*, type: str | _models.ExpressionType, value: str, **kwargs:
- Any)'
+ syntax: 'Expression(*, value: str, **kwargs)'
parameters:
- - name: type
- description: Expression type. Required. "Expression"
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ExpressionType>
- name: value
- description: Expression value. Required.
+ description: Required. Expression value.
+ isRequired: true
types:
- <xref:str>
variables:
-- description: Expression type. Required. "Expression"
+- description: 'Required. Expression type. Default value: "Expression".'
name: type
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ExpressionType>
-- description: Expression value. Required.
- name: value
- types:
- - <xref:str>
+attributes:
+- uid: azure.synapse.artifacts.models.Expression.type
+ name: type
+ signature: type = 'Expression'
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExpressionType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExpressionType.yml
deleted file mode 100644
index 1540452036de..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExpressionType.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.ExpressionType
-name: ExpressionType
-fullName: azure.synapse.artifacts.models.ExpressionType
-summary: Expression type.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: ExpressionType(value, names=None, *, module=None, qualname=None, type=None,
- start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: EXPRESSION
- uid: azure.synapse.artifacts.models.ExpressionType.EXPRESSION
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FailActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FailActivity.yml
deleted file mode 100644
index 4dc8307cda9a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FailActivity.yml
+++ /dev/null
@@ -1,153 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.FailActivity
-name: FailActivity
-fullName: azure.synapse.artifacts.models.FailActivity
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.ControlActivity
-summary: 'This activity will fail within its own scope and output a custom error message
- and error code.
-
- The error message and code can provided either as a string literal or as an expression
- that can
-
- be evaluated to a string at runtime. The activity scope can be the whole pipeline
- or a control
-
- activity (e.g. foreach, switch, until), if the fail activity is contained in it.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'FailActivity(*, name: str, message: MutableMapping[str, Any], error_code:
- MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, state: str | _models.ActivityState
- | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None
- = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: name
- description: Activity name. Required.
- types:
- - <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- - name: depends_on
- description: Activity depends on condition.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- - name: user_properties
- description: Activity user properties.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- - name: message
- description: 'The error message that surfaced in the Fail activity. It can be
- dynamic
-
- content that''s evaluated to a non empty/blank string at runtime. Type: string
- (or Expression
-
- with resultType string). Required.'
- types:
- - <xref:JSON>
- - name: error_code
- description: 'The error code that categorizes the error type of the Fail activity.
- It
-
- can be dynamic content that''s evaluated to a non empty/blank string at runtime.
- Type: string
-
- (or Expression with resultType string). Required.'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: 'The error message that surfaced in the Fail activity. It can be dynamic
- content
-
- that''s evaluated to a non empty/blank string at runtime. Type: string (or Expression
- with
-
- resultType string). Required.'
- name: message
- types:
- - <xref:JSON>
-- description: 'The error code that categorizes the error type of the Fail activity.
- It can
-
- be dynamic content that''s evaluated to a non empty/blank string at runtime. Type:
- string (or
-
- Expression with resultType string). Required.'
- name: error_code
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileServerLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileServerLinkedService.yml
index 94e1eae89d75..3141d5a36063 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileServerLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileServerLinkedService.yml
@@ -10,112 +10,72 @@ summary: 'File system linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'FileServerLinkedService(*, host: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, user_id:
- MutableMapping[str, Any] | None = None, password: _models.SecretBase | None =
- None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: host
- description: 'Host name of the server. Type: string (or Expression with resultType
- string).
+ description: 'Required. Host name of the server. Type: string (or Expression with
+ resultType
- Required.'
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: user_id
description: 'User ID to logon the server. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: Password to logon the server.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Host name of the server. Type: string (or Expression with resultType
- string).
-
- Required.'
- name: host
- types:
- - <xref:JSON>
-- description: 'User ID to logon the server. Type: string (or Expression with resultType
-
- string).'
- name: user_id
- types:
- - <xref:JSON>
-- description: Password to logon the server.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileServerLocation.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileServerLocation.yml
deleted file mode 100644
index 6237d0d3a4a6..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileServerLocation.yml
+++ /dev/null
@@ -1,59 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.FileServerLocation
-name: FileServerLocation
-fullName: azure.synapse.artifacts.models.FileServerLocation
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.DatasetLocation
-summary: 'The location of file server dataset.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'FileServerLocation(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, folder_path: MutableMapping[str, Any] | None = None, file_name:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: folder_path
- description: 'Specify the folder path of dataset. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: file_name
- description: 'Specify the file name of dataset. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset storage location. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Specify the folder path of dataset. Type: string (or Expression with
-
- resultType string).'
- name: folder_path
- types:
- - <xref:JSON>
-- description: 'Specify the file name of dataset. Type: string (or Expression with
- resultType
-
- string).'
- name: file_name
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileServerReadSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileServerReadSettings.yml
deleted file mode 100644
index a103a028c822..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileServerReadSettings.yml
+++ /dev/null
@@ -1,179 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.FileServerReadSettings
-name: FileServerReadSettings
-fullName: azure.synapse.artifacts.models.FileServerReadSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.StoreReadSettings
-summary: 'File server read settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'FileServerReadSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None
- = None, recursive: MutableMapping[str, Any] | None = None, wildcard_folder_path:
- MutableMapping[str, Any] | None = None, wildcard_file_name: MutableMapping[str,
- Any] | None = None, file_list_path: MutableMapping[str, Any] | None = None, enable_partition_discovery:
- bool | None = None, partition_root_path: MutableMapping[str, Any] | None = None,
- delete_files_after_completion: MutableMapping[str, Any] | None = None, modified_datetime_start:
- MutableMapping[str, Any] | None = None, modified_datetime_end: MutableMapping[str,
- Any] | None = None, file_filter: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: recursive
- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: wildcard_folder_path
- description: 'FileServer wildcardFolderPath. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: wildcard_file_name
- description: 'FileServer wildcardFileName. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: file_list_path
- description: 'Point to a text file that lists each file (relative path to the
- path
-
- configured in the dataset) that you want to copy. Type: string (or Expression
- with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: enable_partition_discovery
- description: Indicates whether to enable partition discovery.
- types:
- - <xref:bool>
- - name: partition_root_path
- description: 'Specify the root path where partition discovery starts from.
-
- Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: delete_files_after_completion
- description: 'Indicates whether the source files need to be deleted
-
- after copy completion. Default is false. Type: boolean (or Expression with resultType
- boolean).'
- types:
- - <xref:JSON>
- - name: modified_datetime_start
- description: 'The start of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: modified_datetime_end
- description: 'The end of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: file_filter
- description: 'Specify a filter to be used to select a subset of files in the folderPath
-
- rather than all files. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The read setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- name: recursive
- types:
- - <xref:JSON>
-- description: 'FileServer wildcardFolderPath. Type: string (or Expression with
-
- resultType string).'
- name: wildcard_folder_path
- types:
- - <xref:JSON>
-- description: 'FileServer wildcardFileName. Type: string (or Expression with
-
- resultType string).'
- name: wildcard_file_name
- types:
- - <xref:JSON>
-- description: 'Point to a text file that lists each file (relative path to the path
-
- configured in the dataset) that you want to copy. Type: string (or Expression
- with resultType
-
- string).'
- name: file_list_path
- types:
- - <xref:JSON>
-- description: Indicates whether to enable partition discovery.
- name: enable_partition_discovery
- types:
- - <xref:bool>
-- description: 'Specify the root path where partition discovery starts from. Type:
-
- string (or Expression with resultType string).'
- name: partition_root_path
- types:
- - <xref:JSON>
-- description: 'Indicates whether the source files need to be deleted
-
- after copy completion. Default is false. Type: boolean (or Expression with resultType
- boolean).'
- name: delete_files_after_completion
- types:
- - <xref:JSON>
-- description: 'The start of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- name: modified_datetime_start
- types:
- - <xref:JSON>
-- description: 'The end of file''s modified datetime. Type: string (or Expression
-
- with resultType string).'
- name: modified_datetime_end
- types:
- - <xref:JSON>
-- description: 'Specify a filter to be used to select a subset of files in the folderPath
-
- rather than all files. Type: string (or Expression with resultType string).'
- name: file_filter
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileServerWriteSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileServerWriteSettings.yml
deleted file mode 100644
index 4fbfd39c7029..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileServerWriteSettings.yml
+++ /dev/null
@@ -1,53 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.FileServerWriteSettings
-name: FileServerWriteSettings
-fullName: azure.synapse.artifacts.models.FileServerWriteSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.StoreWriteSettings
-summary: 'File server write settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'FileServerWriteSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None
- = None, copy_behavior: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: copy_behavior
- description: The type of copy behavior for copy sink.
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The write setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: The type of copy behavior for copy sink.
- name: copy_behavior
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileShareDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileShareDataset.yml
deleted file mode 100644
index b8f8a4186f8f..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileShareDataset.yml
+++ /dev/null
@@ -1,194 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.FileShareDataset
-name: FileShareDataset
-fullName: azure.synapse.artifacts.models.FileShareDataset
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.Dataset
-summary: 'An on-premises file system dataset.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'FileShareDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, folder_path: MutableMapping[str, Any] | None
- = None, file_name: MutableMapping[str, Any] | None = None, modified_datetime_start:
- MutableMapping[str, Any] | None = None, modified_datetime_end: MutableMapping[str,
- Any] | None = None, format: _models.DatasetStorageFormat | None = None, file_filter:
- MutableMapping[str, Any] | None = None, compression: _models.DatasetCompression
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Dataset description.
- types:
- - <xref:str>
- - name: structure
- description: 'Columns that define the structure of the dataset. Type: array (or
-
- Expression with resultType array), itemType: DatasetDataElement.'
- types:
- - <xref:JSON>
- - name: schema
- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- types:
- - <xref:JSON>
- - name: linked_service_name
- description: Linked service reference. Required.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: parameters
- description: Parameters for dataset.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the Dataset.
- types:
- - <xref:list>[<xref:JSON>]
- - name: folder
- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
-
- the root level.'
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
- - name: folder_path
- description: 'The path of the on-premises file system. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: file_name
- description: 'The name of the on-premises file system. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: modified_datetime_start
- description: 'The start of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: modified_datetime_end
- description: 'The end of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: format
- description: The format of the files.
- types:
- - <xref:azure.synapse.artifacts.models.DatasetStorageFormat>
- - name: file_filter
- description: 'Specify a filter to be used to select a subset of files in the folderPath
-
- rather than all files. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: compression
- description: The data compression method used for the file system.
- types:
- - <xref:azure.synapse.artifacts.models.DatasetCompression>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The path of the on-premises file system. Type: string (or Expression
- with
-
- resultType string).'
- name: folder_path
- types:
- - <xref:JSON>
-- description: 'The name of the on-premises file system. Type: string (or Expression
- with
-
- resultType string).'
- name: file_name
- types:
- - <xref:JSON>
-- description: 'The start of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- name: modified_datetime_start
- types:
- - <xref:JSON>
-- description: 'The end of file''s modified datetime. Type: string (or Expression
-
- with resultType string).'
- name: modified_datetime_end
- types:
- - <xref:JSON>
-- description: The format of the files.
- name: format
- types:
- - <xref:azure.synapse.artifacts.models.DatasetStorageFormat>
-- description: 'Specify a filter to be used to select a subset of files in the folderPath
-
- rather than all files. Type: string (or Expression with resultType string).'
- name: file_filter
- types:
- - <xref:JSON>
-- description: The data compression method used for the file system.
- name: compression
- types:
- - <xref:azure.synapse.artifacts.models.DatasetCompression>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileSystemSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileSystemSink.yml
deleted file mode 100644
index 560236bb9b64..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileSystemSink.yml
+++ /dev/null
@@ -1,104 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.FileSystemSink
-name: FileSystemSink
-fullName: azure.synapse.artifacts.models.FileSystemSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity file system sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'FileSystemSink(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, write_batch_size: MutableMapping[str, Any] | None = None,
- write_batch_timeout: MutableMapping[str, Any] | None = None, sink_retry_count:
- MutableMapping[str, Any] | None = None, sink_retry_wait: MutableMapping[str, Any]
- | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None,
- copy_behavior: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: copy_behavior
- description: The type of copy behavior for copy sink.
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: The type of copy behavior for copy sink.
- name: copy_behavior
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileSystemSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileSystemSource.yml
deleted file mode 100644
index f3cc66f33969..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileSystemSource.yml
+++ /dev/null
@@ -1,99 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.FileSystemSource
-name: FileSystemSource
-fullName: azure.synapse.artifacts.models.FileSystemSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity file system source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'FileSystemSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, recursive: MutableMapping[str, Any] |
- None = None, additional_columns: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: recursive
- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- name: recursive
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FilterActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FilterActivity.yml
index 1047a050432f..0557c50cc80f 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FilterActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FilterActivity.yml
@@ -4,117 +4,56 @@ name: FilterActivity
fullName: azure.synapse.artifacts.models.FilterActivity
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts.models._models_py3.ControlActivity
+- azure.synapse.artifacts.models._models_py3.Activity
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: _models.Expression, condition: _models.Expression,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, state: str | _models.ActivityState | None = None, on_inactive_mark_as:
- str | _models.ActivityOnInactiveMarkAs | None = None, depends_on: List[_models.ActivityDependency]
- | None = None, user_properties: List[_models.UserProperty] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: items
- description: Input array on which filter should be applied. Required.
+ description: Required. Input array on which filter should be applied.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.Expression>
- name: condition
- description: Condition to be used for filtering the input. Required.
+ description: Required. Condition to be used for filtering the input.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.Expression>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Input array on which filter should be applied. Required.
- name: items
- types:
- - <xref:azure.synapse.artifacts.models.Expression>
-- description: Condition to be used for filtering the input. Required.
- name: condition
- types:
- - <xref:azure.synapse.artifacts.models.Expression>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Flowlet.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Flowlet.yml
deleted file mode 100644
index 823fc1bc31a0..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Flowlet.yml
+++ /dev/null
@@ -1,93 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.Flowlet
-name: Flowlet
-fullName: azure.synapse.artifacts.models.Flowlet
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.DataFlow
-summary: 'Data flow flowlet.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'Flowlet(*, description: str | None = None, annotations: List[MutableMapping[str,
- Any]] | None = None, folder: _models.DataFlowFolder | None = None, sources: List[_models.DataFlowSource]
- | None = None, sinks: List[_models.DataFlowSink] | None = None, transformations:
- List[_models.Transformation] | None = None, script: str | None = None, script_lines:
- List[str] | None = None, **kwargs: Any)'
- parameters:
- - name: description
- description: The description of the data flow.
- types:
- - <xref:str>
- - name: annotations
- description: List of tags that can be used for describing the data flow.
- types:
- - <xref:list>[<xref:JSON>]
- - name: folder
- description: 'The folder that this data flow is in. If not specified, Data flow
- will appear
-
- at the root level.'
- types:
- - <xref:azure.synapse.artifacts.models.DataFlowFolder>
- - name: sources
- description: List of sources in Flowlet.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DataFlowSource>]
- - name: sinks
- description: List of sinks in Flowlet.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DataFlowSink>]
- - name: transformations
- description: List of transformations in Flowlet.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.Transformation>]
- - name: script
- description: Flowlet script.
- types:
- - <xref:str>
- - name: script_lines
- description: Flowlet script lines.
- types:
- - <xref:list>[<xref:str>]
-variables:
-- description: Type of data flow. Required.
- name: type
- types:
- - <xref:str>
-- description: The description of the data flow.
- name: description
- types:
- - <xref:str>
-- description: List of tags that can be used for describing the data flow.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this data flow is in. If not specified, Data flow
- will appear at
-
- the root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DataFlowFolder>
-- description: List of sources in Flowlet.
- name: sources
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DataFlowSource>]
-- description: List of sinks in Flowlet.
- name: sinks
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DataFlowSink>]
-- description: List of transformations in Flowlet.
- name: transformations
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.Transformation>]
-- description: Flowlet script.
- name: script
- types:
- - <xref:str>
-- description: Flowlet script lines.
- name: script_lines
- types:
- - <xref:list>[<xref:str>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ForEachActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ForEachActivity.yml
index 7820d39979fe..42895acd27b3 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ForEachActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ForEachActivity.yml
@@ -4,138 +4,70 @@ name: ForEachActivity
fullName: azure.synapse.artifacts.models.ForEachActivity
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts.models._models_py3.ControlActivity
+- azure.synapse.artifacts.models._models_py3.Activity
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: _models.Expression, activities: List[_models.Activity],
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, state: str | _models.ActivityState | None = None, on_inactive_mark_as:
- str | _models.ActivityOnInactiveMarkAs | None = None, depends_on: List[_models.ActivityDependency]
- | None = None, user_properties: List[_models.UserProperty] | None = None, is_sequential:
- bool | None = None, batch_count: int | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: is_sequential
description: Should the loop be executed in sequence or in parallel (max 50).
+ isRequired: true
types:
- <xref:bool>
- 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:
- <xref:int>
- name: items
- description: Collection to iterate. Required.
+ description: Required. Collection to iterate.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.Expression>
- name: activities
- description: List of activities to execute . Required.
+ description: Required. List of activities to execute .
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.Activity>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Should the loop be executed in sequence or in parallel (max 50).
- name: is_sequential
- types:
- - <xref:bool>
-- description: 'Batch count to be used for controlling the number of parallel execution
-
- (when isSequential is set to false).'
- name: batch_count
- types:
- - <xref:int>
-- description: Collection to iterate. Required.
- name: items
- types:
- - <xref:azure.synapse.artifacts.models.Expression>
-- description: List of activities to execute . Required.
- name: activities
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.Activity>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FormatReadSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FormatReadSettings.yml
deleted file mode 100644
index 7431759a15ef..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FormatReadSettings.yml
+++ /dev/null
@@ -1,38 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.FormatReadSettings
-name: FormatReadSettings
-fullName: azure.synapse.artifacts.models.FormatReadSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Format read settings.
-
-
- You probably want to use the sub-classes and not this class directly. Known sub-classes
- are:
-
- BinaryReadSettings, DelimitedTextReadSettings, JsonReadSettings, XmlReadSettings
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'FormatReadSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The read setting type. Required.
- name: type
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FormatWriteSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FormatWriteSettings.yml
deleted file mode 100644
index 8ddcd75e584e..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FormatWriteSettings.yml
+++ /dev/null
@@ -1,40 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.FormatWriteSettings
-name: FormatWriteSettings
-fullName: azure.synapse.artifacts.models.FormatWriteSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Format write settings.
-
-
- You probably want to use the sub-classes and not this class directly. Known sub-classes
- are:
-
- AvroWriteSettings, DelimitedTextWriteSettings, JsonWriteSettings, OrcWriteSettings,
-
- ParquetWriteSettings
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'FormatWriteSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The write setting type. Required.
- name: type
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpAuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpAuthenticationType.yml
index 1dbe43a1e22c..78640a66de32 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpAuthenticationType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpAuthenticationType.yml
@@ -11,7 +11,7 @@ inheritances:
- builtins.str
- enum.Enum
fields:
-- name: ANONYMOUS
- uid: azure.synapse.artifacts.models.FtpAuthenticationType.ANONYMOUS
-- name: BASIC
- uid: azure.synapse.artifacts.models.FtpAuthenticationType.BASIC
+- name: anonymous
+ uid: azure.synapse.artifacts.models.FtpAuthenticationType.anonymous
+- name: basic
+ uid: azure.synapse.artifacts.models.FtpAuthenticationType.basic
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpReadSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpReadSettings.yml
deleted file mode 100644
index 26965bbe9234..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpReadSettings.yml
+++ /dev/null
@@ -1,162 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.FtpReadSettings
-name: FtpReadSettings
-fullName: azure.synapse.artifacts.models.FtpReadSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.StoreReadSettings
-summary: 'Ftp read settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'FtpReadSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None
- = None, recursive: MutableMapping[str, Any] | None = None, wildcard_folder_path:
- MutableMapping[str, Any] | None = None, wildcard_file_name: MutableMapping[str,
- Any] | None = None, enable_partition_discovery: bool | None = None, partition_root_path:
- MutableMapping[str, Any] | None = None, delete_files_after_completion: MutableMapping[str,
- Any] | None = None, file_list_path: MutableMapping[str, Any] | None = None, use_binary_transfer:
- bool | None = None, disable_chunking: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: recursive
- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: wildcard_folder_path
- description: 'Ftp wildcardFolderPath. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: wildcard_file_name
- description: 'Ftp wildcardFileName. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: enable_partition_discovery
- description: Indicates whether to enable partition discovery.
- types:
- - <xref:bool>
- - name: partition_root_path
- description: 'Specify the root path where partition discovery starts from.
-
- Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: delete_files_after_completion
- description: 'Indicates whether the source files need to be deleted
-
- after copy completion. Default is false. Type: boolean (or Expression with resultType
- boolean).'
- types:
- - <xref:JSON>
- - name: file_list_path
- description: 'Point to a text file that lists each file (relative path to the
- path
-
- configured in the dataset) that you want to copy. Type: string (or Expression
- with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: use_binary_transfer
- description: Specify whether to use binary transfer mode for FTP stores.
- types:
- - <xref:bool>
- - name: disable_chunking
- description: 'If true, disable parallel reading within each file. Default is
-
- false. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The read setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- name: recursive
- types:
- - <xref:JSON>
-- description: 'Ftp wildcardFolderPath. Type: string (or Expression with resultType
-
- string).'
- name: wildcard_folder_path
- types:
- - <xref:JSON>
-- description: 'Ftp wildcardFileName. Type: string (or Expression with resultType
-
- string).'
- name: wildcard_file_name
- types:
- - <xref:JSON>
-- description: Indicates whether to enable partition discovery.
- name: enable_partition_discovery
- types:
- - <xref:bool>
-- description: 'Specify the root path where partition discovery starts from. Type:
-
- string (or Expression with resultType string).'
- name: partition_root_path
- types:
- - <xref:JSON>
-- description: 'Indicates whether the source files need to be deleted
-
- after copy completion. Default is false. Type: boolean (or Expression with resultType
- boolean).'
- name: delete_files_after_completion
- types:
- - <xref:JSON>
-- description: 'Point to a text file that lists each file (relative path to the path
-
- configured in the dataset) that you want to copy. Type: string (or Expression
- with resultType
-
- string).'
- name: file_list_path
- types:
- - <xref:JSON>
-- description: Specify whether to use binary transfer mode for FTP stores.
- name: use_binary_transfer
- types:
- - <xref:bool>
-- description: 'If true, disable parallel reading within each file. Default is false.
-
- Type: boolean (or Expression with resultType boolean).'
- name: disable_chunking
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpServerLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpServerLinkedService.yml
index d117afaae503..a4a4092f747d 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpServerLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpServerLinkedService.yml
@@ -10,85 +10,103 @@ summary: 'A FTP server Linked Service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'FtpServerLinkedService(*, host: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, port:
- MutableMapping[str, Any] | None = None, authentication_type: str | _models.FtpAuthenticationType
- | None = None, user_name: MutableMapping[str, Any] | None = None, password: _models.SecretBase
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, enable_ssl:
- MutableMapping[str, Any] | None = None, enable_server_certificate_validation:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: host
- description: 'Host name of the FTP server. Type: string (or Expression with resultType
+ description: 'Required. Host name of the FTP server. Type: string (or Expression
+ with resultType
- string). Required.'
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: authentication_type
description: 'The authentication type to be used to connect to the FTP server.
- Known values are: "Basic" and "Anonymous".'
+ Possible values include: "Basic", "Anonymous".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.FtpAuthenticationType>
- name: user_name
description: 'Username to logon the FTP server. Type: string (or Expression with
+ resultType
- resultType string).'
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: Password to logon the FTP server.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: enable_server_certificate_validation
description: 'If true, validate the FTP server SSL certificate
@@ -96,90 +114,6 @@ constructor:
Expression with
resultType boolean).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Host name of the FTP server. Type: string (or Expression with resultType
- string).
-
- Required.'
- name: host
- types:
- - <xref:JSON>
-- 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.'
- name: port
- types:
- - <xref:JSON>
-- description: 'The authentication type to be used to connect to the FTP server.
-
- Known values are: "Basic" and "Anonymous".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.FtpAuthenticationType>
-- description: 'Username to logon the FTP server. Type: string (or Expression with
- resultType
-
- string).'
- name: user_name
- types:
- - <xref:JSON>
-- description: Password to logon the FTP server.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
-- description: 'If true, connect to the FTP server over SSL/TLS channel. Default value
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- name: enable_ssl
- types:
- - <xref:JSON>
-- 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).'
- name: enable_server_certificate_validation
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpServerLocation.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpServerLocation.yml
deleted file mode 100644
index bb7049c99644..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpServerLocation.yml
+++ /dev/null
@@ -1,59 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.FtpServerLocation
-name: FtpServerLocation
-fullName: azure.synapse.artifacts.models.FtpServerLocation
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.DatasetLocation
-summary: 'The location of ftp server dataset.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'FtpServerLocation(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, folder_path: MutableMapping[str, Any] | None = None, file_name:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: folder_path
- description: 'Specify the folder path of dataset. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: file_name
- description: 'Specify the file name of dataset. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset storage location. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Specify the folder path of dataset. Type: string (or Expression with
-
- resultType string).'
- name: folder_path
- types:
- - <xref:JSON>
-- description: 'Specify the file name of dataset. Type: string (or Expression with
- resultType
-
- string).'
- name: file_name
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetMetadataActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetMetadataActivity.yml
index 7b2e61e8c4fc..ef0403d74a5a 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetMetadataActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetMetadataActivity.yml
@@ -10,145 +10,61 @@ 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: _models.DatasetReference, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None,
- state: str | _models.ActivityState | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs
- | None = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, linked_service_name: _models.LinkedServiceReference
- | None = None, policy: _models.ActivityPolicy | None = None, field_list: List[MutableMapping[str,
- Any]] | None = None, store_settings: _models.StoreReadSettings | None = None,
- format_settings: _models.FormatReadSettings | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
- name: dataset
- description: GetMetadata activity dataset reference. Required.
+ description: Required. GetMetadata activity dataset reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetReference>
- name: field_list
description: Fields of metadata to get from dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
- - name: store_settings
- description: GetMetadata activity store settings.
- types:
- - <xref:azure.synapse.artifacts.models.StoreReadSettings>
- - name: format_settings
- description: GetMetadata activity format settings.
- types:
- - <xref:azure.synapse.artifacts.models.FormatReadSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: GetMetadata activity dataset reference. Required.
- name: dataset
- types:
- - <xref:azure.synapse.artifacts.models.DatasetReference>
-- description: Fields of metadata to get from dataset.
- name: field_list
- types:
- - <xref:list>[<xref:JSON>]
-- description: GetMetadata activity store settings.
- name: store_settings
- types:
- - <xref:azure.synapse.artifacts.models.StoreReadSettings>
-- description: GetMetadata activity format settings.
- name: format_settings
- types:
- - <xref:azure.synapse.artifacts.models.FormatReadSettings>
+ - <xref:list>[<xref:object>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetSsisObjectMetadataRequest.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetSsisObjectMetadataRequest.yml
index 52cc167696a9..e8101b0932dc 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetSsisObjectMetadataRequest.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetSsisObjectMetadataRequest.yml
@@ -4,18 +4,13 @@ name: GetSsisObjectMetadataRequest
fullName: azure.synapse.artifacts.models.GetSsisObjectMetadataRequest
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: The request payload of get SSIS object metadata.
constructor:
- syntax: 'GetSsisObjectMetadataRequest(*, metadata_path: str | None = None, **kwargs:
- Any)'
+ syntax: 'GetSsisObjectMetadataRequest(*, metadata_path: str | None = None, **kwargs)'
parameters:
- name: metadata_path
description: Metadata path.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: Metadata path.
- name: metadata_path
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GitHubAccessTokenRequest.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GitHubAccessTokenRequest.yml
deleted file mode 100644
index 607b2de2f035..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GitHubAccessTokenRequest.yml
+++ /dev/null
@@ -1,40 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.GitHubAccessTokenRequest
-name: GitHubAccessTokenRequest
-fullName: azure.synapse.artifacts.models.GitHubAccessTokenRequest
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'GitHubAccessTokenRequest.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'GitHubAccessTokenRequest(*, git_hub_client_id: str, git_hub_access_code:
- str, git_hub_access_token_base_url: str, **kwargs: Any)'
- parameters:
- - name: git_hub_client_id
- description: The GitHub Client Id. Required.
- types:
- - <xref:str>
- - name: git_hub_access_code
- description: The GitHub Access code. Required.
- types:
- - <xref:str>
- - name: git_hub_access_token_base_url
- description: The GitHub access token base URL. Required.
- types:
- - <xref:str>
-variables:
-- description: The GitHub Client Id. Required.
- name: git_hub_client_id
- types:
- - <xref:str>
-- description: The GitHub Access code. Required.
- name: git_hub_access_code
- types:
- - <xref:str>
-- description: The GitHub access token base URL. Required.
- name: git_hub_access_token_base_url
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GitHubAccessTokenResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GitHubAccessTokenResponse.yml
deleted file mode 100644
index 6cb013c695be..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GitHubAccessTokenResponse.yml
+++ /dev/null
@@ -1,19 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.GitHubAccessTokenResponse
-name: GitHubAccessTokenResponse
-fullName: azure.synapse.artifacts.models.GitHubAccessTokenResponse
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: GitHubAccessTokenResponse.
-constructor:
- syntax: 'GitHubAccessTokenResponse(*, git_hub_access_token: str | None = None, **kwargs:
- Any)'
- parameters:
- - name: git_hub_access_token
- types:
- - <xref:str>
-variables:
-- name: git_hub_access_token
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GitHubClientSecret.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GitHubClientSecret.yml
deleted file mode 100644
index ae390ac328f7..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GitHubClientSecret.yml
+++ /dev/null
@@ -1,29 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.GitHubClientSecret
-name: GitHubClientSecret
-fullName: azure.synapse.artifacts.models.GitHubClientSecret
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Client secret information for factory's bring your own app repository configuration.
-constructor:
- syntax: 'GitHubClientSecret(*, byoa_secret_akv_url: str | None = None, byoa_secret_name:
- str | None = None, **kwargs: Any)'
- parameters:
- - name: byoa_secret_akv_url
- description: Bring your own app client secret AKV URL.
- types:
- - <xref:str>
- - name: byoa_secret_name
- description: Bring your own app client secret name in AKV.
- types:
- - <xref:str>
-variables:
-- description: Bring your own app client secret AKV URL.
- name: byoa_secret_akv_url
- types:
- - <xref:str>
-- description: Bring your own app client secret name in AKV.
- name: byoa_secret_name
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsAuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsAuthenticationType.yml
index c106141c4c98..06590a40105a 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsAuthenticationType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsAuthenticationType.yml
@@ -14,7 +14,7 @@ inheritances:
- builtins.str
- enum.Enum
fields:
-- name: SERVICE_AUTHENTICATION
- uid: azure.synapse.artifacts.models.GoogleAdWordsAuthenticationType.SERVICE_AUTHENTICATION
-- name: USER_AUTHENTICATION
- uid: azure.synapse.artifacts.models.GoogleAdWordsAuthenticationType.USER_AUTHENTICATION
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsLinkedService.yml
index 4b7764b04d03..c585c651827b 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsLinkedService.yml
@@ -10,74 +10,80 @@ summary: 'Google AdWords service linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'GoogleAdWordsLinkedService(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, connection_properties:
- MutableMapping[str, Any] | None = None, client_customer_id: MutableMapping[str,
- Any] | None = None, developer_token: _models.SecretBase | None = None, authentication_type:
- str | _models.GoogleAdWordsAuthenticationType | None = None, refresh_token: _models.SecretBase
- | None = None, client_id: MutableMapping[str, Any] | None = None, client_secret:
- _models.SecretBase | None = None, email: MutableMapping[str, Any] | None = None,
- key_file_path: MutableMapping[str, Any] | None = None, trusted_cert_path: MutableMapping[str,
- Any] | None = None, use_system_trust_store: MutableMapping[str, Any] | None =
- None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
- - name: connection_properties
- description: 'Properties used to connect to GoogleAds. It is mutually
-
- exclusive with any other properties in the linked service. Type: object.'
- types:
- - <xref:JSON>
+ - <xref:list>[<xref:object>]
- name: client_customer_id
- description: 'The Client customer ID of the AdWords account that you want to
+ description: 'Required. The Client customer ID of the AdWords account that you
- fetch report data for.'
+ want to fetch report data for.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: developer_token
- description: 'The developer token associated with the manager account that you
- use
+ description: 'Required. The developer token associated with the manager account
+ that
- to grant access to the AdWords API.'
+ you use to grant access to the AdWords API.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: authentication_type
- description: 'The OAuth 2.0 authentication mechanism used for authentication.
+ description: 'Required. The OAuth 2.0 authentication mechanism used for
- ServiceAuthentication can only be used on self-hosted IR. Known values are:
+ authentication. ServiceAuthentication can only be used on self-hosted IR. Possible
+ values
- "ServiceAuthentication" and "UserAuthentication".'
+ include: "ServiceAuthentication", "UserAuthentication".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.GoogleAdWordsAuthenticationType>
- name: refresh_token
description: 'The refresh token obtained from Google for authorizing access to
+ AdWords
- AdWords for UserAuthentication.'
+ for UserAuthentication.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: client_id
@@ -85,163 +91,59 @@ constructor:
token.
Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: client_secret
description: 'The client secret of the google application used to acquire the
refresh
token.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: email
description: 'The service account email ID that is used for ServiceAuthentication
- and can
+ and can only
- only be used on self-hosted IR.'
+ be used on self-hosted IR.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: trusted_cert_path
description: 'The full path of the .pem file containing trusted CA certificates
+ for
- for verifying the server when connecting over SSL. This property can only be
- set when using SSL
+ verifying the server when connecting over SSL. This property can only be set
+ when using SSL on
- on self-hosted IR. The default value is the cacerts.pem file installed with
- the IR.'
+ self-hosted IR. The default value is the cacerts.pem file installed with the
+ IR.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_system_trust_store
- description: 'Specifies whether to use a CA certificate from the system
+ description: 'Specifies whether to use a CA certificate from the system trust
- trust store or from a specified PEM file. The default value is false.'
+ store or from a specified PEM file. The default value is false.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Properties used to connect to GoogleAds. It is mutually exclusive
-
- with any other properties in the linked service. Type: object.'
- name: connection_properties
- types:
- - <xref:JSON>
-- description: 'The Client customer ID of the AdWords account that you want to fetch
-
- report data for.'
- name: client_customer_id
- types:
- - <xref:JSON>
-- description: 'The developer token associated with the manager account that you use
- to
-
- grant access to the AdWords API.'
- name: developer_token
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The OAuth 2.0 authentication mechanism used for authentication.
-
- ServiceAuthentication can only be used on self-hosted IR. Known values are:
-
- "ServiceAuthentication" and "UserAuthentication".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.GoogleAdWordsAuthenticationType>
-- description: 'The refresh token obtained from Google for authorizing access to AdWords
-
- for UserAuthentication.'
- name: refresh_token
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The client id of the google application used to acquire the refresh
- token.
-
- Type: string (or Expression with resultType string).'
- name: client_id
- types:
- - <xref:JSON>
-- description: 'The client secret of the google application used to acquire the refresh
-
- token.'
- name: client_secret
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The service account email ID that is used for ServiceAuthentication
- and can only
-
- be used on self-hosted IR.'
- name: email
- types:
- - <xref:JSON>
-- 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.'
- name: key_file_path
- types:
- - <xref:JSON>
-- 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.'
- name: trusted_cert_path
- types:
- - <xref:JSON>
-- description: 'Specifies whether to use a CA certificate from the system trust
-
- store or from a specified PEM file. The default value is false.'
- name: use_system_trust_store
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ 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:
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsObjectDataset.yml
index 3cf844a13a72..2d558bf42267 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsObjectDataset.yml
@@ -10,109 +10,71 @@ summary: 'Google AdWords service dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'GoogleAdWordsObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The table name. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsSource.yml
deleted file mode 100644
index c1b46dd31e21..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.GoogleAdWordsSource
-name: GoogleAdWordsSource
-fullName: azure.synapse.artifacts.models.GoogleAdWordsSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Google AdWords service source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'GoogleAdWordsSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, query:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryAuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryAuthenticationType.yml
index 71fbcaec2dc6..9bd47c906aac 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryAuthenticationType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryAuthenticationType.yml
@@ -14,7 +14,7 @@ inheritances:
- builtins.str
- enum.Enum
fields:
-- name: SERVICE_AUTHENTICATION
- uid: azure.synapse.artifacts.models.GoogleBigQueryAuthenticationType.SERVICE_AUTHENTICATION
-- name: USER_AUTHENTICATION
- uid: azure.synapse.artifacts.models.GoogleBigQueryAuthenticationType.USER_AUTHENTICATION
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryLinkedService.yml
index 33532d70ce6f..f835b7a6102c 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryLinkedService.yml
@@ -10,49 +10,59 @@ summary: 'Google BigQuery service linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'GoogleBigQueryLinkedService(*, project: MutableMapping[str, Any], authentication_type:
- str | _models.GoogleBigQueryAuthenticationType, additional_properties: Dict[str,
- MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, additional_projects:
- MutableMapping[str, Any] | None = None, request_google_drive_scope: MutableMapping[str,
- Any] | None = None, refresh_token: _models.SecretBase | None = None, client_id:
- MutableMapping[str, Any] | None = None, client_secret: _models.SecretBase | None
- = None, email: MutableMapping[str, Any] | None = None, key_file_path: MutableMapping[str,
- Any] | None = None, trusted_cert_path: MutableMapping[str, Any] | None = None,
- use_system_trust_store: MutableMapping[str, Any] | None = None, encrypted_credential:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: project
- description: The default BigQuery project to query against. Required.
+ description: Required. The default BigQuery project to query against.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: additional_projects
description: A comma-separated list of public BigQuery projects to access.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: request_google_drive_scope
description: 'Whether to request access to Google Drive. Allowing Google
@@ -60,22 +70,26 @@ constructor:
with data from
Google Drive. The default value is false.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: authentication_type
- description: 'The OAuth 2.0 authentication mechanism used for authentication.
+ description: 'Required. The OAuth 2.0 authentication mechanism used for
- ServiceAuthentication can only be used on self-hosted IR. Required. Known values
- are:
+ authentication. ServiceAuthentication can only be used on self-hosted IR. Possible
+ values
- "ServiceAuthentication" and "UserAuthentication".'
+ include: "ServiceAuthentication", "UserAuthentication".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.GoogleBigQueryAuthenticationType>
- name: refresh_token
description: 'The refresh token obtained from Google for authorizing access to
+ BigQuery
- BigQuery for UserAuthentication.'
+ for UserAuthentication.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: client_id
@@ -83,162 +97,59 @@ constructor:
token.
Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: client_secret
description: 'The client secret of the google application used to acquire the
refresh
token.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: email
description: 'The service account email ID that is used for ServiceAuthentication
- and can
+ and can only
- only be used on self-hosted IR.'
+ be used on self-hosted IR.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: trusted_cert_path
description: 'The full path of the .pem file containing trusted CA certificates
+ for
- for verifying the server when connecting over SSL. This property can only be
- set when using SSL
+ verifying the server when connecting over SSL. This property can only be set
+ when using SSL on
- on self-hosted IR. The default value is the cacerts.pem file installed with
- the IR.'
+ self-hosted IR. The default value is the cacerts.pem file installed with the
+ IR.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_system_trust_store
- description: 'Specifies whether to use a CA certificate from the system
+ description: 'Specifies whether to use a CA certificate from the system trust
- trust store or from a specified PEM file. The default value is false.'
+ store or from a specified PEM file. The default value is false.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The default BigQuery project to query against. Required.
- name: project
- types:
- - <xref:JSON>
-- description: A comma-separated list of public BigQuery projects to access.
- name: additional_projects
- types:
- - <xref:JSON>
-- 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.'
- name: request_google_drive_scope
- types:
- - <xref:JSON>
-- description: 'The OAuth 2.0 authentication mechanism used for authentication.
-
- ServiceAuthentication can only be used on self-hosted IR. Required. Known values
- are:
-
- "ServiceAuthentication" and "UserAuthentication".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.GoogleBigQueryAuthenticationType>
-- description: 'The refresh token obtained from Google for authorizing access to BigQuery
-
- for UserAuthentication.'
- name: refresh_token
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The client id of the google application used to acquire the refresh
- token.
-
- Type: string (or Expression with resultType string).'
- name: client_id
- types:
- - <xref:JSON>
-- description: 'The client secret of the google application used to acquire the refresh
-
- token.'
- name: client_secret
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The service account email ID that is used for ServiceAuthentication
- and can only
-
- be used on self-hosted IR.'
- name: email
- types:
- - <xref:JSON>
-- 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.'
- name: key_file_path
- types:
- - <xref:JSON>
-- 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.'
- name: trusted_cert_path
- types:
- - <xref:JSON>
-- description: 'Specifies whether to use a CA certificate from the system trust
-
- store or from a specified PEM file. The default value is false.'
- name: use_system_trust_store
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ 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:
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryObjectDataset.yml
index b68c370dacd1..dc55d4191ae3 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryObjectDataset.yml
@@ -10,55 +10,67 @@ summary: 'Google BigQuery service dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'GoogleBigQueryObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, table: MutableMapping[str, Any] | None = None, dataset: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
@@ -66,87 +78,22 @@ constructor:
table
properties instead.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: table
description: 'The table name of the Google BigQuery. Type: string (or Expression
with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: dataset
description: 'The database name of the Google BigQuery. Type: string (or Expression
with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'This property will be retired. Please consider using database + table
-
- properties instead.'
- name: table_name
- types:
- - <xref:JSON>
-- description: 'The table name of the Google BigQuery. Type: string (or Expression
- with resultType
-
- string).'
- name: table
- types:
- - <xref:JSON>
-- description: 'The database name of the Google BigQuery. Type: string (or Expression
- with
-
- resultType string).'
- name: dataset
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQuerySource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQuerySource.yml
deleted file mode 100644
index e20cb97ae7a2..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQuerySource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.GoogleBigQuerySource
-name: GoogleBigQuerySource
-fullName: azure.synapse.artifacts.models.GoogleBigQuerySource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Google BigQuery service source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'GoogleBigQuerySource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, query:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleCloudStorageLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleCloudStorageLinkedService.yml
index 8900948d1697..4e263ab16723 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleCloudStorageLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleCloudStorageLinkedService.yml
@@ -10,46 +10,58 @@ 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, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, access_key_id:
- MutableMapping[str, Any] | None = None, secret_access_key: _models.SecretBase
- | None = None, service_url: MutableMapping[str, Any] | None = None, encrypted_credential:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: access_key_id
description: 'The access key identifier of the Google Cloud Storage Identity and
+ Access
- Access Management (IAM) user. Type: string (or Expression with resultType string).'
+ Management (IAM) user. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: secret_access_key
- description: 'The secret access key of the Google Cloud Storage Identity and
+ description: 'The secret access key of the Google Cloud Storage Identity and Access
- Access Management (IAM) user.'
+ Management (IAM) user.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: service_url
@@ -63,76 +75,16 @@ constructor:
with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The access key identifier of the Google Cloud Storage Identity and
- Access
-
- Management (IAM) user. Type: string (or Expression with resultType string).'
- name: access_key_id
- types:
- - <xref:JSON>
-- description: 'The secret access key of the Google Cloud Storage Identity and Access
-
- Management (IAM) user.'
- name: secret_access_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- 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).'
- name: service_url
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleCloudStorageLocation.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleCloudStorageLocation.yml
deleted file mode 100644
index 47378bb7f204..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleCloudStorageLocation.yml
+++ /dev/null
@@ -1,86 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.GoogleCloudStorageLocation
-name: GoogleCloudStorageLocation
-fullName: azure.synapse.artifacts.models.GoogleCloudStorageLocation
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.DatasetLocation
-summary: 'The location of Google Cloud Storage dataset.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'GoogleCloudStorageLocation(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, folder_path: MutableMapping[str, Any] | None = None, file_name:
- MutableMapping[str, Any] | None = None, bucket_name: MutableMapping[str, Any]
- | None = None, version: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: folder_path
- description: 'Specify the folder path of dataset. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: file_name
- description: 'Specify the file name of dataset. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: bucket_name
- description: 'Specify the bucketName of Google Cloud Storage. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: version
- description: 'Specify the version of Google Cloud Storage. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset storage location. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Specify the folder path of dataset. Type: string (or Expression with
-
- resultType string).'
- name: folder_path
- types:
- - <xref:JSON>
-- description: 'Specify the file name of dataset. Type: string (or Expression with
- resultType
-
- string).'
- name: file_name
- types:
- - <xref:JSON>
-- description: 'Specify the bucketName of Google Cloud Storage. Type: string (or Expression
-
- with resultType string).'
- name: bucket_name
- types:
- - <xref:JSON>
-- description: 'Specify the version of Google Cloud Storage. Type: string (or Expression
- with
-
- resultType string).'
- name: version
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleCloudStorageReadSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleCloudStorageReadSettings.yml
deleted file mode 100644
index 1ba1bf94a1d0..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleCloudStorageReadSettings.yml
+++ /dev/null
@@ -1,181 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.GoogleCloudStorageReadSettings
-name: GoogleCloudStorageReadSettings
-fullName: azure.synapse.artifacts.models.GoogleCloudStorageReadSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.StoreReadSettings
-summary: 'Google Cloud Storage read settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'GoogleCloudStorageReadSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None
- = None, recursive: MutableMapping[str, Any] | None = None, wildcard_folder_path:
- MutableMapping[str, Any] | None = None, wildcard_file_name: MutableMapping[str,
- Any] | None = None, prefix: MutableMapping[str, Any] | None = None, file_list_path:
- MutableMapping[str, Any] | None = None, enable_partition_discovery: bool | None
- = None, partition_root_path: MutableMapping[str, Any] | None = None, delete_files_after_completion:
- MutableMapping[str, Any] | None = None, modified_datetime_start: MutableMapping[str,
- Any] | None = None, modified_datetime_end: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: recursive
- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: wildcard_folder_path
- description: 'Google Cloud Storage wildcardFolderPath. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: wildcard_file_name
- description: 'Google Cloud Storage wildcardFileName. Type: string (or Expression
-
- with resultType string).'
- types:
- - <xref:JSON>
- - name: prefix
- description: 'The prefix filter for the Google Cloud Storage object name. Type:
- string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: file_list_path
- description: 'Point to a text file that lists each file (relative path to the
- path
-
- configured in the dataset) that you want to copy. Type: string (or Expression
- with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: enable_partition_discovery
- description: Indicates whether to enable partition discovery.
- types:
- - <xref:bool>
- - name: partition_root_path
- description: 'Specify the root path where partition discovery starts from.
-
- Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: delete_files_after_completion
- description: 'Indicates whether the source files need to be deleted
-
- after copy completion. Default is false. Type: boolean (or Expression with resultType
- boolean).'
- types:
- - <xref:JSON>
- - name: modified_datetime_start
- description: 'The start of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: modified_datetime_end
- description: 'The end of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The read setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- name: recursive
- types:
- - <xref:JSON>
-- description: 'Google Cloud Storage wildcardFolderPath. Type: string (or
-
- Expression with resultType string).'
- name: wildcard_folder_path
- types:
- - <xref:JSON>
-- description: 'Google Cloud Storage wildcardFileName. Type: string (or Expression
-
- with resultType string).'
- name: wildcard_file_name
- types:
- - <xref:JSON>
-- description: 'The prefix filter for the Google Cloud Storage object name. Type:
- string (or
-
- Expression with resultType string).'
- name: prefix
- types:
- - <xref:JSON>
-- description: 'Point to a text file that lists each file (relative path to the path
-
- configured in the dataset) that you want to copy. Type: string (or Expression
- with resultType
-
- string).'
- name: file_list_path
- types:
- - <xref:JSON>
-- description: Indicates whether to enable partition discovery.
- name: enable_partition_discovery
- types:
- - <xref:bool>
-- description: 'Specify the root path where partition discovery starts from. Type:
-
- string (or Expression with resultType string).'
- name: partition_root_path
- types:
- - <xref:JSON>
-- description: 'Indicates whether the source files need to be deleted
-
- after copy completion. Default is false. Type: boolean (or Expression with resultType
- boolean).'
- name: delete_files_after_completion
- types:
- - <xref:JSON>
-- description: 'The start of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- name: modified_datetime_start
- types:
- - <xref:JSON>
-- description: 'The end of file''s modified datetime. Type: string (or Expression
-
- with resultType string).'
- name: modified_datetime_end
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleSheetsLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleSheetsLinkedService.yml
deleted file mode 100644
index d5355a471c9e..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleSheetsLinkedService.yml
+++ /dev/null
@@ -1,93 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.GoogleSheetsLinkedService
-name: GoogleSheetsLinkedService
-fullName: azure.synapse.artifacts.models.GoogleSheetsLinkedService
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.LinkedService
-summary: 'Linked service for GoogleSheets.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'GoogleSheetsLinkedService(*, api_token: _models.SecretBase, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, encrypted_credential:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: connect_via
- description: The integration runtime reference.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- - name: description
- description: Linked service description.
- types:
- - <xref:str>
- - name: parameters
- description: Parameters for linked service.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the linked service.
- types:
- - <xref:list>[<xref:JSON>]
- - name: api_token
- description: The api token for the GoogleSheets source. Required.
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
- - 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).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The api token for the GoogleSheets source. Required.
- name: api_token
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumLinkedService.yml
index 861609d55319..cf40af7b2c7e 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumLinkedService.yml
@@ -10,98 +10,63 @@ summary: 'Greenplum Database linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'GreenplumLinkedService(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, connection_string:
- MutableMapping[str, Any] | None = None, pwd: _models.AzureKeyVaultSecretReference
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
description: 'An ODBC connection string. Type: string, SecureString or
AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: pwd
description: The Azure key vault secret reference of password in connection string.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'An ODBC connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of password in connection string.
- name: pwd
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumSource.yml
deleted file mode 100644
index 4e1455dce83a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.GreenplumSource
-name: GreenplumSource
-fullName: azure.synapse.artifacts.models.GreenplumSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Greenplum Database source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'GreenplumSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, query:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumTableDataset.yml
index 9230812c15b4..10f018e169ef 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumTableDataset.yml
@@ -10,137 +10,86 @@ summary: 'Greenplum Database dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'GreenplumTableDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, table: MutableMapping[str, Any] | None = None, schema_type_properties_schema:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'This property will be retired. Please consider using schema + table
properties instead.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: table
description: 'The table name of Greenplum. Type: string (or Expression with resultType
-
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: schema_type_properties_schema
- description: 'The schema name of Greenplum. Type: string (or
+ description: 'The schema name of Greenplum. Type: string (or Expression
- Expression with resultType string).'
+ with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'This property will be retired. Please consider using schema + table
-
- properties instead.'
- name: table_name
- types:
- - <xref:JSON>
-- description: 'The table name of Greenplum. Type: string (or Expression with resultType
- string).'
- name: table
- types:
- - <xref:JSON>
-- description: 'The schema name of Greenplum. Type: string (or Expression
-
- with resultType string).'
- name: schema_type_properties_schema
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseAuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseAuthenticationType.yml
index 106567cddf73..11747ae7ced0 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseAuthenticationType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseAuthenticationType.yml
@@ -11,7 +11,7 @@ inheritances:
- builtins.str
- enum.Enum
fields:
-- name: ANONYMOUS
- uid: azure.synapse.artifacts.models.HBaseAuthenticationType.ANONYMOUS
-- name: BASIC
- uid: azure.synapse.artifacts.models.HBaseAuthenticationType.BASIC
+- name: anonymous
+ uid: azure.synapse.artifacts.models.HBaseAuthenticationType.anonymous
+- name: basic
+ uid: azure.synapse.artifacts.models.HBaseAuthenticationType.basic
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseLinkedService.yml
index e49a9fdf7ad2..906bb1babd87 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseLinkedService.yml
@@ -10,210 +10,128 @@ summary: 'HBase server linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'HBaseLinkedService(*, host: MutableMapping[str, Any], authentication_type:
- str | _models.HBaseAuthenticationType, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, port:
- MutableMapping[str, Any] | None = None, http_path: MutableMapping[str, Any] |
- None = None, username: MutableMapping[str, Any] | None = None, password: _models.SecretBase
- | None = None, enable_ssl: MutableMapping[str, Any] | None = None, trusted_cert_path:
- MutableMapping[str, Any] | None = None, allow_host_name_cn_mismatch: MutableMapping[str,
- Any] | None = None, allow_self_signed_server_cert: MutableMapping[str, Any] |
- None = None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: host
- description: 'The IP address or host name of the HBase server. (i.e. 192.168.222.160).
-
- Required.'
+ description: Required. The IP address or host name of the HBase server. (i.e.
+ 192.168.222.160).
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: port
description: 'The TCP port that the HBase instance uses to listen for client connections.
The
default value is 9090.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: http_path
description: 'The partial URL corresponding to the HBase server. (i.e.
/gateway/sandbox/hbase/version).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: authentication_type
- description: 'The authentication mechanism to use to connect to the HBase
+ description: 'Required. The authentication mechanism to use to connect to the
- server. Required. Known values are: "Anonymous" and "Basic".'
+ HBase server. Possible values include: "Anonymous", "Basic".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.HBaseAuthenticationType>
- name: username
description: The user name used to connect to the HBase instance.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: The password corresponding to the user name.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: enable_ssl
description: 'Specifies whether the connections to the server are encrypted using
- SSL.
+ SSL. The
- The default value is false.'
+ default value is false.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: trusted_cert_path
description: 'The full path of the .pem file containing trusted CA certificates
+ for
- for verifying the server when connecting over SSL. This property can only be
- set when using SSL
+ verifying the server when connecting over SSL. This property can only be set
+ when using SSL on
- on self-hosted IR. The default value is the cacerts.pem file installed with
- the IR.'
+ self-hosted IR. The default value is the cacerts.pem file installed with the
+ IR.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: allow_self_signed_server_cert
- description: 'Specifies whether to allow self-signed certificates
+ description: 'Specifies whether to allow self-signed certificates from
- from the server. The default value is false.'
+ the server. The default value is false.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The IP address or host name of the HBase server. (i.e. 192.168.222.160).
- Required.
- name: host
- types:
- - <xref:JSON>
-- description: 'The TCP port that the HBase instance uses to listen for client connections.
- The
-
- default value is 9090.'
- name: port
- types:
- - <xref:JSON>
-- description: 'The partial URL corresponding to the HBase server. (i.e.
-
- /gateway/sandbox/hbase/version).'
- name: http_path
- types:
- - <xref:JSON>
-- description: 'The authentication mechanism to use to connect to the HBase server.
-
- Required. Known values are: "Anonymous" and "Basic".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.HBaseAuthenticationType>
-- description: The user name used to connect to the HBase instance.
- name: username
- types:
- - <xref:JSON>
-- description: The password corresponding to the user name.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Specifies whether the connections to the server are encrypted using
- SSL. The
-
- default value is false.'
- name: enable_ssl
- types:
- - <xref:JSON>
-- 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.'
- name: trusted_cert_path
- types:
- - <xref:JSON>
-- 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.'
- name: allow_host_name_cn_mismatch
- types:
- - <xref:JSON>
-- description: 'Specifies whether to allow self-signed certificates from
-
- the server. The default value is false.'
- name: allow_self_signed_server_cert
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseObjectDataset.yml
index 4f458aaada22..d975b298ede5 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseObjectDataset.yml
@@ -10,109 +10,70 @@ summary: 'HBase server dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'HBaseObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The table name. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseSource.yml
deleted file mode 100644
index 6c111bea5a0f..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.HBaseSource
-name: HBaseSource
-fullName: azure.synapse.artifacts.models.HBaseSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity HBase server source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'HBaseSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption.yml
index 490ec77451b3..a9784d89990b 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption.yml
@@ -11,9 +11,9 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightHiveActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightHiveActivity.yml
index 1923b11860a5..c021cbf082db 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightHiveActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightHiveActivity.yml
@@ -10,189 +10,99 @@ 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, MutableMapping[str,
- Any]] | None = None, description: str | None = None, state: str | _models.ActivityState
- | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None
- = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, linked_service_name: _models.LinkedServiceReference
- | None = None, policy: _models.ActivityPolicy | None = None, storage_linked_services:
- List[_models.LinkedServiceReference] | None = None, arguments: List[MutableMapping[str,
- Any]] | None = None, get_debug_info: str | _models.HDInsightActivityDebugInfoOption
- | None = None, script_path: MutableMapping[str, Any] | None = None, script_linked_service:
- _models.LinkedServiceReference | None = None, defines: Dict[str, MutableMapping[str,
- Any]] | None = None, variables: List[MutableMapping[str, Any]] | None = None,
- query_timeout: int | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
- name: storage_linked_services
description: Storage linked service references.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.LinkedServiceReference>]
- name: arguments
description: User specified arguments to HDInsightActivity.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: get_debug_info
- description: 'Debug info option. Known values are: "None", "Always", and "Failure".'
+ description: 'Debug info option. Possible values include: "None", "Always", "Failure".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption>
- name: script_path
description: 'Script path. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: script_linked_service
description: Script linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: defines
description: Allows user to specify defines for Hive job request.
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: variables
description: User specified arguments under hivevar namespace.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: query_timeout
description: 'Query timeout value (in minutes). Effective when the HDInsight
cluster
is with ESP (Enterprise Security Package).'
+ isRequired: true
types:
- <xref:int>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: Storage linked service references.
- name: storage_linked_services
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.LinkedServiceReference>]
-- description: User specified arguments to HDInsightActivity.
- name: arguments
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Debug info option. Known values are: "None", "Always", and "Failure".'
- name: get_debug_info
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption>
-- description: 'Script path. Type: string (or Expression with resultType string).'
- name: script_path
- types:
- - <xref:JSON>
-- description: Script linked service reference.
- name: script_linked_service
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Allows user to specify defines for Hive job request.
- name: defines
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: User specified arguments under hivevar namespace.
- name: variables
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Query timeout value (in minutes). Effective when the HDInsight cluster
- is
-
- with ESP (Enterprise Security Package).'
- name: query_timeout
- types:
- - <xref:int>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightLinkedService.yml
index 5db1373f22b1..abcef60f4cf5 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightLinkedService.yml
@@ -10,159 +10,100 @@ summary: 'HDInsight linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'HDInsightLinkedService(*, cluster_uri: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, user_name:
- MutableMapping[str, Any] | None = None, password: _models.SecretBase | None =
- None, linked_service_name: _models.LinkedServiceReference | None = None, hcatalog_linked_service_name:
- _models.LinkedServiceReference | None = None, encrypted_credential: MutableMapping[str,
- Any] | None = None, is_esp_enabled: MutableMapping[str, Any] | None = None, file_system:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: cluster_uri
- description: 'HDInsight cluster URI. Type: string (or Expression with resultType
+ description: 'Required. HDInsight cluster URI. Type: string (or Expression with
- string). Required.'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: user_name
description: 'HDInsight cluster user name. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: HDInsight cluster password.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: linked_service_name
description: The Azure Storage linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: hcatalog_linked_service_name
- description: 'A reference to the Azure SQL linked service that points
+ description: 'A reference to the Azure SQL linked service that points to
- to the HCatalog database.'
+ the HCatalog database.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: is_esp_enabled
description: 'Specify if the HDInsight is created with ESP (Enterprise Security
Package). Type: Boolean.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: file_system
description: 'Specify the FileSystem if the main storage for the HDInsight is
- ADLS
+ ADLS Gen2.
- Gen2. Type: string (or Expression with resultType string).'
+ Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'HDInsight cluster URI. Type: string (or Expression with resultType
- string).
-
- Required.'
- name: cluster_uri
- types:
- - <xref:JSON>
-- description: 'HDInsight cluster user name. Type: string (or Expression with resultType
-
- string).'
- name: user_name
- types:
- - <xref:JSON>
-- description: HDInsight cluster password.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: The Azure Storage linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: 'A reference to the Azure SQL linked service that points to
-
- the HCatalog database.'
- name: hcatalog_linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
-- description: 'Specify if the HDInsight is created with ESP (Enterprise Security
-
- Package). Type: Boolean.'
- name: is_esp_enabled
- types:
- - <xref:JSON>
-- description: 'Specify the FileSystem if the main storage for the HDInsight is ADLS
- Gen2.
-
- Type: string (or Expression with resultType string).'
- name: file_system
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightMapReduceActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightMapReduceActivity.yml
index fc52434845f4..5e1cac632cfb 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightMapReduceActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightMapReduceActivity.yml
@@ -10,186 +10,98 @@ summary: 'HDInsight MapReduce activity type.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'HDInsightMapReduceActivity(*, name: str, class_name: MutableMapping[str,
- Any], jar_file_path: MutableMapping[str, Any], additional_properties: Dict[str,
- MutableMapping[str, Any]] | None = None, description: str | None = None, state:
- str | _models.ActivityState | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs
- | None = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, linked_service_name: _models.LinkedServiceReference
- | None = None, policy: _models.ActivityPolicy | None = None, storage_linked_services:
- List[_models.LinkedServiceReference] | None = None, arguments: List[MutableMapping[str,
- Any]] | None = None, get_debug_info: str | _models.HDInsightActivityDebugInfoOption
- | None = None, jar_linked_service: _models.LinkedServiceReference | None = None,
- jar_libs: List[MutableMapping[str, Any]] | None = None, defines: Dict[str, MutableMapping[str,
- Any]] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
- name: storage_linked_services
description: Storage linked service references.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.LinkedServiceReference>]
- name: arguments
description: User specified arguments to HDInsightActivity.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: get_debug_info
- description: 'Debug info option. Known values are: "None", "Always", and "Failure".'
+ description: 'Debug info option. Possible values include: "None", "Always", "Failure".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption>
- name: class_name
- description: 'Class name. Type: string (or Expression with resultType string).
- Required.'
+ description: 'Required. Class name. Type: string (or Expression with resultType
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: jar_file_path
- description: 'Jar path. Type: string (or Expression with resultType string).
-
- Required.'
+ description: 'Required. Jar path. Type: string (or Expression with resultType
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: jar_linked_service
description: Jar linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: jar_libs
description: Jar libs.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: defines
description: Allows user to specify defines for the MapReduce job request.
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: Storage linked service references.
- name: storage_linked_services
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.LinkedServiceReference>]
-- description: User specified arguments to HDInsightActivity.
- name: arguments
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Debug info option. Known values are: "None", "Always", and "Failure".'
- name: get_debug_info
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption>
-- description: 'Class name. Type: string (or Expression with resultType string). Required.'
- name: class_name
- types:
- - <xref:JSON>
-- description: 'Jar path. Type: string (or Expression with resultType string). Required.'
- name: jar_file_path
- types:
- - <xref:JSON>
-- description: Jar linked service reference.
- name: jar_linked_service
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Jar libs.
- name: jar_libs
- types:
- - <xref:list>[<xref:JSON>]
-- description: Allows user to specify defines for the MapReduce job request.
- name: defines
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightOnDemandLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightOnDemandLinkedService.yml
index 55a8977efb54..b33c3c106793 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightOnDemandLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightOnDemandLinkedService.yml
@@ -10,148 +10,164 @@ summary: 'HDInsight ondemand linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'HDInsightOnDemandLinkedService(*, cluster_size: MutableMapping[str, Any],
- time_to_live: MutableMapping[str, Any], version: MutableMapping[str, Any], linked_service_name:
- _models.LinkedServiceReference, host_subscription_id: MutableMapping[str, Any],
- tenant: MutableMapping[str, Any], cluster_resource_group: MutableMapping[str,
- Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- connect_via: _models.IntegrationRuntimeReference | None = None, description: str
- | None = None, parameters: Dict[str, _models.ParameterSpecification] | None =
- None, annotations: List[MutableMapping[str, Any]] | None = None, service_principal_id:
- MutableMapping[str, Any] | None = None, service_principal_key: _models.SecretBase
- | None = None, cluster_name_prefix: MutableMapping[str, Any] | None = None, cluster_user_name:
- MutableMapping[str, Any] | None = None, cluster_password: _models.SecretBase |
- None = None, cluster_ssh_user_name: MutableMapping[str, Any] | None = None, cluster_ssh_password:
- _models.SecretBase | None = None, additional_linked_service_names: List[_models.LinkedServiceReference]
- | None = None, hcatalog_linked_service_name: _models.LinkedServiceReference |
- None = None, cluster_type: MutableMapping[str, Any] | None = None, spark_version:
- MutableMapping[str, Any] | None = None, core_configuration: MutableMapping[str,
- Any] | None = None, h_base_configuration: MutableMapping[str, Any] | None = None,
- hdfs_configuration: MutableMapping[str, Any] | None = None, hive_configuration:
- MutableMapping[str, Any] | None = None, map_reduce_configuration: MutableMapping[str,
- Any] | None = None, oozie_configuration: MutableMapping[str, Any] | None = None,
- storm_configuration: MutableMapping[str, Any] | None = None, yarn_configuration:
- MutableMapping[str, Any] | None = None, encrypted_credential: MutableMapping[str,
- Any] | None = None, head_node_size: MutableMapping[str, Any] | None = None, data_node_size:
- MutableMapping[str, Any] | None = None, zookeeper_node_size: MutableMapping[str,
- Any] | None = None, script_actions: List[_models.ScriptAction] | None = None,
- virtual_network_id: MutableMapping[str, Any] | None = None, subnet_name: MutableMapping[str,
- Any] | None = None, credential: _models.CredentialReference | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: cluster_size
- description: 'Number of worker/data nodes in the cluster. Suggestion value: 4.
- Type:
+ description: 'Required. Number of worker/data nodes in the cluster. Suggestion
+ value: 4.
- string (or Expression with resultType string). Required.'
+ Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: time_to_live
- description: 'The allowed idle time for the on-demand HDInsight cluster. Specifies
- how
+ description: 'Required. The allowed idle time for the on-demand HDInsight cluster.
- long the on-demand HDInsight cluster stays alive after completion of an activity
- run if there
+ Specifies how long the on-demand HDInsight cluster stays alive after completion
+ of an activity
- are no other active jobs in the cluster. The minimum value is 5 mins. Type:
- string (or
+ run if there are no other active jobs in the cluster. The minimum value is 5
+ mins. Type: string
- Expression with resultType string). Required.'
+ (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: version
- description: "Version of the HDInsight cluster.\_ Type: string (or Expression\
- \ with\nresultType string). Required."
+ description: "Required. Version of the HDInsight cluster.\_ Type: string (or Expression\
+ \ with\nresultType string)."
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: 'Azure Storage linked service to be used by the on-demand cluster
+ description: 'Required. Azure Storage linked service to be used by the on-demand
- for storing and processing data. Required.'
+ cluster for storing and processing data.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: host_subscription_id
- description: 'The customer''s subscription to host the cluster. Type: string
+ description: 'Required. The customer''s subscription to host the cluster. Type:
- (or Expression with resultType string). Required.'
+ string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_id
- description: 'The service principal id for the hostSubscriptionId. Type:
+ description: 'The service principal id for the hostSubscriptionId. Type: string
- string (or Expression with resultType string).'
+ (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_key
description: The key for the service principal id.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: tenant
- description: 'The Tenant id/name to which the service principal belongs. Type:
- string (or
+ description: 'Required. The Tenant id/name to which the service principal belongs.
+ Type:
- Expression with resultType string). Required.'
+ string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: cluster_resource_group
- description: 'The resource group where the cluster belongs. Type: string (or
+ description: 'Required. The resource group where the cluster belongs. Type:
- Expression with resultType string). Required.'
+ string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: cluster_user_name
description: 'The username to access the cluster. Type: string (or Expression
+ with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: cluster_password
description: The password to access the cluster.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: cluster_ssh_password
description: The password to SSH remotely connect cluster's node (for Linux).
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: additional_linked_service_names
- description: 'Specifies additional storage accounts for the
+ description: 'Specifies additional storage accounts for the HDInsight
- HDInsight linked service so that the Data Factory service can register them
- on your behalf.'
+ linked service so that the Data Factory service can register them on your behalf.'
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.LinkedServiceReference>]
- name: hcatalog_linked_service_name
@@ -161,349 +177,133 @@ constructor:
SQL database
as the metastore.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: cluster_type
description: 'The cluster type. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: spark_version
description: 'The version of spark if the cluster type is ''spark''. Type: string
(or
Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: core_configuration
description: 'Specifies the core configuration parameters (as in core-site.xml)
for the HDInsight cluster to be created.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: h_base_configuration
- description: 'Specifies the HBase configuration parameters (hbase-site.xml)
+ description: 'Specifies the HBase configuration parameters (hbase-site.xml) for
- for the HDInsight cluster.'
+ the HDInsight cluster.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: hdfs_configuration
description: 'Specifies the HDFS configuration parameters (hdfs-site.xml) for
+ the
- the HDInsight cluster.'
+ HDInsight cluster.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: hive_configuration
description: 'Specifies the hive configuration parameters (hive-site.xml) for
+ the
- the HDInsight cluster.'
+ HDInsight cluster.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: map_reduce_configuration
- description: 'Specifies the MapReduce configuration parameters
+ description: 'Specifies the MapReduce configuration parameters (mapred-
- (mapred-site.xml) for the HDInsight cluster.'
+ site.xml) for the HDInsight cluster.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: oozie_configuration
description: 'Specifies the Oozie configuration parameters (oozie-site.xml) for
the HDInsight cluster.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: storm_configuration
description: 'Specifies the Storm configuration parameters (storm-site.xml) for
the HDInsight cluster.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: yarn_configuration
description: 'Specifies the Yarn configuration parameters (yarn-site.xml) for
+ the
- the HDInsight cluster.'
+ HDInsight cluster.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: head_node_size
description: Specifies the size of the head node for the HDInsight cluster.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: data_node_size
description: Specifies the size of the data node for the HDInsight cluster.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: zookeeper_node_size
description: 'Specifies the size of the Zoo Keeper node for the HDInsight
cluster.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: script_actions
description: 'Custom script actions to run on HDI ondemand cluster once it''s
up.
- Please refer to
+ 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-
- [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](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).'
+ us%2Fazure%2Fbread%2Ftoc.json#understanding-script-actions.'
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ScriptAction>]
- 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:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
- - name: credential
- description: The credential reference containing authentication information.
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Number of worker/data nodes in the cluster. Suggestion value: 4. Type:
-
- string (or Expression with resultType string). Required.'
- name: cluster_size
- types:
- - <xref:JSON>
-- description: '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). Required.'
- name: time_to_live
- types:
- - <xref:JSON>
-- description: "Version of the HDInsight cluster.\_ Type: string (or Expression with\
- \ resultType\nstring). Required."
- name: version
- types:
- - <xref:JSON>
-- description: 'Azure Storage linked service to be used by the on-demand cluster for
-
- storing and processing data. Required.'
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: 'The customer''s subscription to host the cluster. Type: string (or
-
- Expression with resultType string). Required.'
- name: host_subscription_id
- types:
- - <xref:JSON>
-- description: 'The service principal id for the hostSubscriptionId. Type: string
-
- (or Expression with resultType string).'
- name: service_principal_id
- types:
- - <xref:JSON>
-- description: The key for the service principal id.
- name: service_principal_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The Tenant id/name to which the service principal belongs. Type: string
- (or
-
- Expression with resultType string). Required.'
- name: tenant
- types:
- - <xref:JSON>
-- description: 'The resource group where the cluster belongs. Type: string (or
-
- Expression with resultType string). Required.'
- name: cluster_resource_group
- types:
- - <xref:JSON>
-- description: 'The prefix of cluster name, postfix will be distinct with timestamp.
-
- Type: string (or Expression with resultType string).'
- name: cluster_name_prefix
- types:
- - <xref:JSON>
-- description: 'The username to access the cluster. Type: string (or Expression with
-
- resultType string).'
- name: cluster_user_name
- types:
- - <xref:JSON>
-- description: The password to access the cluster.
- name: cluster_password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The username to SSH remotely connect to cluster''s node (for
-
- Linux). Type: string (or Expression with resultType string).'
- name: cluster_ssh_user_name
- types:
- - <xref:JSON>
-- description: The password to SSH remotely connect cluster's node (for Linux).
- name: cluster_ssh_password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Specifies additional storage accounts for the HDInsight
-
- linked service so that the Data Factory service can register them on your behalf.'
- name: additional_linked_service_names
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.LinkedServiceReference>]
-- 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.'
- name: hcatalog_linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: 'The cluster type. Type: string (or Expression with resultType string).'
- name: cluster_type
- types:
- - <xref:JSON>
-- description: 'The version of spark if the cluster type is ''spark''. Type: string
- (or
-
- Expression with resultType string).'
- name: spark_version
- types:
- - <xref:JSON>
-- description: 'Specifies the core configuration parameters (as in core-site.xml)
- for
-
- the HDInsight cluster to be created.'
- name: core_configuration
- types:
- - <xref:JSON>
-- description: 'Specifies the HBase configuration parameters (hbase-site.xml) for
-
- the HDInsight cluster.'
- name: h_base_configuration
- types:
- - <xref:JSON>
-- description: 'Specifies the HDFS configuration parameters (hdfs-site.xml) for the
-
- HDInsight cluster.'
- name: hdfs_configuration
- types:
- - <xref:JSON>
-- description: 'Specifies the hive configuration parameters (hive-site.xml) for the
-
- HDInsight cluster.'
- name: hive_configuration
- types:
- - <xref:JSON>
-- description: 'Specifies the MapReduce configuration parameters
-
- (mapred-site.xml) for the HDInsight cluster.'
- name: map_reduce_configuration
- types:
- - <xref:JSON>
-- description: 'Specifies the Oozie configuration parameters (oozie-site.xml) for
-
- the HDInsight cluster.'
- name: oozie_configuration
- types:
- - <xref:JSON>
-- description: 'Specifies the Storm configuration parameters (storm-site.xml) for
-
- the HDInsight cluster.'
- name: storm_configuration
- types:
- - <xref:JSON>
-- description: 'Specifies the Yarn configuration parameters (yarn-site.xml) for the
-
- HDInsight cluster.'
- name: yarn_configuration
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
-- description: Specifies the size of the head node for the HDInsight cluster.
- name: head_node_size
- types:
- - <xref:JSON>
-- description: Specifies the size of the data node for the HDInsight cluster.
- name: data_node_size
- types:
- - <xref:JSON>
-- description: Specifies the size of the Zoo Keeper node for the HDInsight cluster.
- name: zookeeper_node_size
- types:
- - <xref:JSON>
-- 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-cluster-linux?toc=%2Fen-us%2Fazure%2Fhdinsight%2Fr-server%2FTOC.json&bc=%2Fen-us%2Fazure%2Fbread%2Ftoc.json#understanding-script-actions](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).'
- name: script_actions
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ScriptAction>]
-- description: 'The ARM resource ID for the vNet to which the cluster should be
-
- joined after creation. Type: string (or Expression with resultType string).'
- name: virtual_network_id
- types:
- - <xref:JSON>
-- 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).'
- name: subnet_name
- types:
- - <xref:JSON>
-- description: The credential reference containing authentication information.
- name: credential
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightPigActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightPigActivity.yml
index 03aa0bc2460e..d307a3d6ec44 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightPigActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightPigActivity.yml
@@ -10,171 +10,87 @@ 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, MutableMapping[str,
- Any]] | None = None, description: str | None = None, state: str | _models.ActivityState
- | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None
- = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, linked_service_name: _models.LinkedServiceReference
- | None = None, policy: _models.ActivityPolicy | None = None, storage_linked_services:
- List[_models.LinkedServiceReference] | None = None, arguments: MutableMapping[str,
- Any] | None = None, get_debug_info: str | _models.HDInsightActivityDebugInfoOption
- | None = None, script_path: MutableMapping[str, Any] | None = None, script_linked_service:
- _models.LinkedServiceReference | None = None, defines: Dict[str, MutableMapping[str,
- Any]] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
- name: storage_linked_services
description: Storage linked service references.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.LinkedServiceReference>]
- name: arguments
description: 'User specified arguments to HDInsightActivity. Type: array (or Expression
with resultType array).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: get_debug_info
- description: 'Debug info option. Known values are: "None", "Always", and "Failure".'
+ description: 'Debug info option. Possible values include: "None", "Always", "Failure".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption>
- name: script_path
description: 'Script path. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: script_linked_service
description: Script linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: defines
description: Allows user to specify defines for Pig job request.
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: Storage linked service references.
- name: storage_linked_services
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.LinkedServiceReference>]
-- description: 'User specified arguments to HDInsightActivity. Type: array (or Expression
- with
-
- resultType array).'
- name: arguments
- types:
- - <xref:JSON>
-- description: 'Debug info option. Known values are: "None", "Always", and "Failure".'
- name: get_debug_info
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption>
-- description: 'Script path. Type: string (or Expression with resultType string).'
- name: script_path
- types:
- - <xref:JSON>
-- description: Script linked service reference.
- name: script_linked_service
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Allows user to specify defines for Pig job request.
- name: defines
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightSparkActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightSparkActivity.yml
index 4ca980cee316..8d2b4291f4e1 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightSparkActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightSparkActivity.yml
@@ -10,86 +10,82 @@ summary: 'HDInsight Spark activity.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'HDInsightSparkActivity(*, name: str, root_path: MutableMapping[str, Any],
- entry_file_path: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, state: str | _models.ActivityState
- | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None
- = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, linked_service_name: _models.LinkedServiceReference
- | None = None, policy: _models.ActivityPolicy | None = None, arguments: List[MutableMapping[str,
- Any]] | None = None, get_debug_info: str | _models.HDInsightActivityDebugInfoOption
- | None = None, spark_job_linked_service: _models.LinkedServiceReference | None
- = None, class_name: str | None = None, proxy_user: MutableMapping[str, Any] |
- None = None, spark_config: Dict[str, MutableMapping[str, Any]] | None = None,
- **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
- name: root_path
- description: 'The root path in ''sparkJobLinkedService'' for all the job''s files.
- Type:
+ description: 'Required. The root path in ''sparkJobLinkedService'' for all the
+ job''s files.
- string (or Expression with resultType string). Required.'
+ Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: entry_file_path
- description: 'The relative path to the root folder of the code/package to be
+ description: 'Required. The relative path to the root folder of the code/package
+ to
- executed. Type: string (or Expression with resultType string). Required.'
+ be executed. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: arguments
description: The user-specified arguments to HDInsightSparkActivity.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: get_debug_info
- description: 'Debug info option. Known values are: "None", "Always", and "Failure".'
+ description: 'Debug info option. Possible values include: "None", "Always", "Failure".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption>
@@ -97,10 +93,12 @@ constructor:
description: 'The storage linked service for uploading the entry file and
dependencies, and for receiving logs.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: class_name
description: The application's Java/Spark main class.
+ isRequired: true
types:
- <xref:str>
- name: proxy_user
@@ -108,104 +106,11 @@ constructor:
(or
Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: spark_config
description: Spark configuration property.
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: 'The root path in ''sparkJobLinkedService'' for all the job''s files.
- Type: string
-
- (or Expression with resultType string). Required.'
- name: root_path
- types:
- - <xref:JSON>
-- description: 'The relative path to the root folder of the code/package to be executed.
-
- Type: string (or Expression with resultType string). Required.'
- name: entry_file_path
- types:
- - <xref:JSON>
-- description: The user-specified arguments to HDInsightSparkActivity.
- name: arguments
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Debug info option. Known values are: "None", "Always", and "Failure".'
- name: get_debug_info
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption>
-- description: 'The storage linked service for uploading the entry file and
-
- dependencies, and for receiving logs.'
- name: spark_job_linked_service
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: The application's Java/Spark main class.
- name: class_name
- types:
- - <xref:str>
-- description: 'The user to impersonate that will execute the job. Type: string (or
-
- Expression with resultType string).'
- name: proxy_user
- types:
- - <xref:JSON>
-- description: Spark configuration property.
- name: spark_config
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightStreamingActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightStreamingActivity.yml
index 1e2249e77e36..c3ed4df503a8 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightStreamingActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightStreamingActivity.yml
@@ -10,237 +10,125 @@ summary: 'HDInsight streaming activity type.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'HDInsightStreamingActivity(*, name: str, mapper: MutableMapping[str, Any],
- reducer: MutableMapping[str, Any], input: MutableMapping[str, Any], output: MutableMapping[str,
- Any], file_paths: List[MutableMapping[str, Any]], additional_properties: Dict[str,
- MutableMapping[str, Any]] | None = None, description: str | None = None, state:
- str | _models.ActivityState | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs
- | None = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, linked_service_name: _models.LinkedServiceReference
- | None = None, policy: _models.ActivityPolicy | None = None, storage_linked_services:
- List[_models.LinkedServiceReference] | None = None, arguments: List[MutableMapping[str,
- Any]] | None = None, get_debug_info: str | _models.HDInsightActivityDebugInfoOption
- | None = None, file_linked_service: _models.LinkedServiceReference | None = None,
- combiner: MutableMapping[str, Any] | None = None, command_environment: List[MutableMapping[str,
- Any]] | None = None, defines: Dict[str, MutableMapping[str, Any]] | None = None,
- **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
- name: storage_linked_services
description: Storage linked service references.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.LinkedServiceReference>]
- name: arguments
description: User specified arguments to HDInsightActivity.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: get_debug_info
- description: 'Debug info option. Known values are: "None", "Always", and "Failure".'
+ description: 'Debug info option. Possible values include: "None", "Always", "Failure".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption>
- name: mapper
- description: 'Mapper executable name. Type: string (or Expression with resultType
- string).
+ description: 'Required. Mapper executable name. Type: string (or Expression with
+ resultType
- Required.'
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: reducer
- description: 'Reducer executable name. Type: string (or Expression with resultType
- string).
+ description: 'Required. Reducer executable name. Type: string (or Expression with
+ resultType
- Required.'
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: input
- description: 'Input blob path. Type: string (or Expression with resultType string).
- Required.'
+ description: 'Required. Input blob path. Type: string (or Expression with resultType
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: output
- description: 'Output blob path. Type: string (or Expression with resultType string).
-
- Required.'
+ description: 'Required. Output blob path. Type: string (or Expression with resultType
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: file_paths
- description: Paths to streaming job files. Can be directories. Required.
+ description: Required. Paths to streaming job files. Can be directories.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: file_linked_service
description: Linked service reference where the files are located.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: combiner
description: 'Combiner executable name. Type: string (or Expression with resultType
-
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: command_environment
description: Command line environment values.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: defines
description: Allows user to specify defines for streaming job request.
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: Storage linked service references.
- name: storage_linked_services
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.LinkedServiceReference>]
-- description: User specified arguments to HDInsightActivity.
- name: arguments
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Debug info option. Known values are: "None", "Always", and "Failure".'
- name: get_debug_info
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption>
-- description: 'Mapper executable name. Type: string (or Expression with resultType
- string).
-
- Required.'
- name: mapper
- types:
- - <xref:JSON>
-- description: 'Reducer executable name. Type: string (or Expression with resultType
- string).
-
- Required.'
- name: reducer
- types:
- - <xref:JSON>
-- description: 'Input blob path. Type: string (or Expression with resultType string).
- Required.'
- name: input
- types:
- - <xref:JSON>
-- description: 'Output blob path. Type: string (or Expression with resultType string).
- Required.'
- name: output
- types:
- - <xref:JSON>
-- description: Paths to streaming job files. Can be directories. Required.
- name: file_paths
- types:
- - <xref:list>[<xref:JSON>]
-- description: Linked service reference where the files are located.
- name: file_linked_service
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: 'Combiner executable name. Type: string (or Expression with resultType
- string).'
- name: combiner
- types:
- - <xref:JSON>
-- description: Command line environment values.
- name: command_environment
- types:
- - <xref:list>[<xref:JSON>]
-- description: Allows user to specify defines for streaming job request.
- name: defines
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdfsLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdfsLinkedService.yml
index 803f4bdde8d6..44281a5ad324 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdfsLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdfsLinkedService.yml
@@ -10,127 +10,80 @@ summary: 'Hadoop Distributed File System (HDFS) linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'HdfsLinkedService(*, url: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, authentication_type:
- MutableMapping[str, Any] | None = None, encrypted_credential: MutableMapping[str,
- Any] | None = None, user_name: MutableMapping[str, Any] | None = None, password:
- _models.SecretBase | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: url
- description: 'The URL of the HDFS service endpoint, e.g. [http://myhostname:50070/webhdfs/v1](http://myhostname:50070/webhdfs/v1)
- .
+ description: 'Required. The URL of the HDFS service endpoint, e.g.
- Type: string (or Expression with resultType string). Required.'
+ [http://myhostname:50070/webhdfs/v1](http://myhostname:50070/webhdfs/v1) . Type:
+ string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: authentication_type
- description: 'Type of authentication used to connect to the HDFS. Possible
+ description: 'Type of authentication used to connect to the HDFS. Possible values
- values are: Anonymous and Windows. Type: string (or Expression with resultType
- string).'
+ are: Anonymous and Windows. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: user_name
description: 'User name for Windows authentication. Type: string (or Expression
with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: Password for Windows authentication.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: '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). Required.'
- name: url
- types:
- - <xref:JSON>
-- description: 'Type of authentication used to connect to the HDFS. Possible values
-
- are: Anonymous and Windows. Type: string (or Expression with resultType string).'
- name: authentication_type
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
-- description: 'User name for Windows authentication. Type: string (or Expression
- with
-
- resultType string).'
- name: user_name
- types:
- - <xref:JSON>
-- description: Password for Windows authentication.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdfsLocation.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdfsLocation.yml
deleted file mode 100644
index c8274a4caf30..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdfsLocation.yml
+++ /dev/null
@@ -1,59 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.HdfsLocation
-name: HdfsLocation
-fullName: azure.synapse.artifacts.models.HdfsLocation
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.DatasetLocation
-summary: 'The location of HDFS.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'HdfsLocation(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, folder_path: MutableMapping[str, Any] | None = None, file_name:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: folder_path
- description: 'Specify the folder path of dataset. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: file_name
- description: 'Specify the file name of dataset. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset storage location. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Specify the folder path of dataset. Type: string (or Expression with
-
- resultType string).'
- name: folder_path
- types:
- - <xref:JSON>
-- description: 'Specify the file name of dataset. Type: string (or Expression with
- resultType
-
- string).'
- name: file_name
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdfsReadSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdfsReadSettings.yml
deleted file mode 100644
index eb53fa763237..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdfsReadSettings.yml
+++ /dev/null
@@ -1,175 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.HdfsReadSettings
-name: HdfsReadSettings
-fullName: azure.synapse.artifacts.models.HdfsReadSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.StoreReadSettings
-summary: 'HDFS read settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'HdfsReadSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None
- = None, recursive: MutableMapping[str, Any] | None = None, wildcard_folder_path:
- MutableMapping[str, Any] | None = None, wildcard_file_name: MutableMapping[str,
- Any] | None = None, file_list_path: MutableMapping[str, Any] | None = None, enable_partition_discovery:
- bool | None = None, partition_root_path: MutableMapping[str, Any] | None = None,
- modified_datetime_start: MutableMapping[str, Any] | None = None, modified_datetime_end:
- MutableMapping[str, Any] | None = None, distcp_settings: _models.DistcpSettings
- | None = None, delete_files_after_completion: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: recursive
- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: wildcard_folder_path
- description: 'HDFS wildcardFolderPath. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: wildcard_file_name
- description: 'HDFS wildcardFileName. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: file_list_path
- description: 'Point to a text file that lists each file (relative path to the
- path
-
- configured in the dataset) that you want to copy. Type: string (or Expression
- with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: enable_partition_discovery
- description: Indicates whether to enable partition discovery.
- types:
- - <xref:bool>
- - name: partition_root_path
- description: 'Specify the root path where partition discovery starts from.
-
- Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: modified_datetime_start
- description: 'The start of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: modified_datetime_end
- description: 'The end of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: distcp_settings
- description: Specifies Distcp-related settings.
- types:
- - <xref:azure.synapse.artifacts.models.DistcpSettings>
- - name: delete_files_after_completion
- description: 'Indicates whether the source files need to be deleted
-
- after copy completion. Default is false. Type: boolean (or Expression with resultType
- boolean).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The read setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- name: recursive
- types:
- - <xref:JSON>
-- description: 'HDFS wildcardFolderPath. Type: string (or Expression with
-
- resultType string).'
- name: wildcard_folder_path
- types:
- - <xref:JSON>
-- description: 'HDFS wildcardFileName. Type: string (or Expression with resultType
-
- string).'
- name: wildcard_file_name
- types:
- - <xref:JSON>
-- description: 'Point to a text file that lists each file (relative path to the path
-
- configured in the dataset) that you want to copy. Type: string (or Expression
- with resultType
-
- string).'
- name: file_list_path
- types:
- - <xref:JSON>
-- description: Indicates whether to enable partition discovery.
- name: enable_partition_discovery
- types:
- - <xref:bool>
-- description: 'Specify the root path where partition discovery starts from. Type:
-
- string (or Expression with resultType string).'
- name: partition_root_path
- types:
- - <xref:JSON>
-- description: 'The start of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- name: modified_datetime_start
- types:
- - <xref:JSON>
-- description: 'The end of file''s modified datetime. Type: string (or Expression
-
- with resultType string).'
- name: modified_datetime_end
- types:
- - <xref:JSON>
-- description: Specifies Distcp-related settings.
- name: distcp_settings
- types:
- - <xref:azure.synapse.artifacts.models.DistcpSettings>
-- description: 'Indicates whether the source files need to be deleted
-
- after copy completion. Default is false. Type: boolean (or Expression with resultType
- boolean).'
- name: delete_files_after_completion
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdfsSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdfsSource.yml
deleted file mode 100644
index dc72d5886eb5..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdfsSource.yml
+++ /dev/null
@@ -1,93 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.HdfsSource
-name: HdfsSource
-fullName: azure.synapse.artifacts.models.HdfsSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity HDFS source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'HdfsSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, recursive: MutableMapping[str, Any] | None = None, distcp_settings:
- _models.DistcpSettings | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: recursive
- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: distcp_settings
- description: Specifies Distcp-related settings.
- types:
- - <xref:azure.synapse.artifacts.models.DistcpSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- name: recursive
- types:
- - <xref:JSON>
-- description: Specifies Distcp-related settings.
- name: distcp_settings
- types:
- - <xref:azure.synapse.artifacts.models.DistcpSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdiNodeTypes.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdiNodeTypes.yml
index 38b35b24030b..8e7b1c4d57b6 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdiNodeTypes.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdiNodeTypes.yml
@@ -2,7 +2,7 @@
uid: azure.synapse.artifacts.models.HdiNodeTypes
name: HdiNodeTypes
fullName: azure.synapse.artifacts.models.HdiNodeTypes
-summary: All available HdiNodeTypes values.
+summary: The node types on which the script action should be executed.
module: azure.synapse.artifacts.models
constructor:
syntax: HdiNodeTypes(value, names=None, *, module=None, qualname=None, type=None,
@@ -11,9 +11,9 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveAuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveAuthenticationType.yml
index a7333a46637d..dfa349e87604 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveAuthenticationType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveAuthenticationType.yml
@@ -11,11 +11,11 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveLinkedService.yml
index fae9c139d89d..91b2f20caf0d 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveLinkedService.yml
@@ -10,291 +10,176 @@ summary: 'Hive Server linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'HiveLinkedService(*, host: MutableMapping[str, Any], authentication_type:
- str | _models.HiveAuthenticationType, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, port:
- MutableMapping[str, Any] | None = None, server_type: str | _models.HiveServerType
- | None = None, thrift_transport_protocol: str | _models.HiveThriftTransportProtocol
- | None = None, service_discovery_mode: MutableMapping[str, Any] | None = None,
- zoo_keeper_name_space: MutableMapping[str, Any] | None = None, use_native_query:
- MutableMapping[str, Any] | None = None, username: MutableMapping[str, Any] | None
- = None, password: _models.SecretBase | None = None, http_path: MutableMapping[str,
- Any] | None = None, enable_ssl: MutableMapping[str, Any] | None = None, trusted_cert_path:
- MutableMapping[str, Any] | None = None, use_system_trust_store: MutableMapping[str,
- Any] | None = None, allow_host_name_cn_mismatch: MutableMapping[str, Any] | None
- = None, allow_self_signed_server_cert: MutableMapping[str, Any] | None = None,
- encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: host
- description: 'IP address or host name of the Hive server, separated by '';'' for
- multiple hosts
+ description: 'Required. IP address or host name of the Hive server, separated
+ by '';'' for
- (only when serviceDiscoveryMode is enable). Required.'
+ multiple hosts (only when serviceDiscoveryMode is enable).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: port
description: The TCP port that the Hive server uses to listen for client connections.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: server_type
- description: 'The type of Hive server. Known values are: "HiveServer1", "HiveServer2",
+ description: 'The type of Hive server. Possible values include: "HiveServer1",
- and "HiveThriftServer".'
+ "HiveServer2", "HiveThriftServer".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.HiveServerType>
- name: thrift_transport_protocol
- description: 'The transport protocol to use in the Thrift layer. Known
+ description: 'The transport protocol to use in the Thrift layer. Possible
- values are: "Binary", "SASL", and "HTTP ".'
+ values include: "Binary", "SASL", "HTTP ".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.HiveThriftTransportProtocol>
- name: authentication_type
- description: 'The authentication method used to access the Hive server.
+ description: 'Required. The authentication method used to access the Hive server.
- Required. Known values are: "Anonymous", "Username", "UsernameAndPassword",
- and
+ Possible values include: "Anonymous", "Username", "UsernameAndPassword",
"WindowsAzureHDInsightService".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.HiveAuthenticationType>
- name: service_discovery_mode
description: true to indicate using the ZooKeeper service, false not.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: zoo_keeper_name_space
description: 'The namespace on ZooKeeper under which Hive Server 2 nodes are
added.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: username
description: The user name that you use to access Hive Server.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: 'The password corresponding to the user name that you provided in
- the
+ the Username
- Username field.'
+ field.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: http_path
description: The partial URL corresponding to the Hive server.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: enable_ssl
description: 'Specifies whether the connections to the server are encrypted using
- SSL.
+ SSL. The
- The default value is false.'
+ default value is false.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: trusted_cert_path
description: 'The full path of the .pem file containing trusted CA certificates
+ for
- for verifying the server when connecting over SSL. This property can only be
- set when using SSL
+ verifying the server when connecting over SSL. This property can only be set
+ when using SSL on
- on self-hosted IR. The default value is the cacerts.pem file installed with
- the IR.'
+ self-hosted IR. The default value is the cacerts.pem file installed with the
+ IR.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_system_trust_store
- description: 'Specifies whether to use a CA certificate from the system
+ description: 'Specifies whether to use a CA certificate from the system trust
- trust store or from a specified PEM file. The default value is false.'
+ store or from a specified PEM file. The default value is false.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: allow_self_signed_server_cert
- description: 'Specifies whether to allow self-signed certificates
+ description: 'Specifies whether to allow self-signed certificates from
- from the server. The default value is false.'
+ the server. The default value is false.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'IP address or host name of the Hive server, separated by '';'' for
- multiple hosts
-
- (only when serviceDiscoveryMode is enable). Required.'
- name: host
- types:
- - <xref:JSON>
-- description: The TCP port that the Hive server uses to listen for client connections.
- name: port
- types:
- - <xref:JSON>
-- description: 'The type of Hive server. Known values are: "HiveServer1", "HiveServer2",
- and
-
- "HiveThriftServer".'
- name: server_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.HiveServerType>
-- description: 'The transport protocol to use in the Thrift layer. Known
-
- values are: "Binary", "SASL", and "HTTP ".'
- name: thrift_transport_protocol
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.HiveThriftTransportProtocol>
-- description: 'The authentication method used to access the Hive server. Required.
-
- Known values are: "Anonymous", "Username", "UsernameAndPassword", and
-
- "WindowsAzureHDInsightService".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.HiveAuthenticationType>
-- description: true to indicate using the ZooKeeper service, false not.
- name: service_discovery_mode
- types:
- - <xref:JSON>
-- description: 'The namespace on ZooKeeper under which Hive Server 2 nodes are
-
- added.'
- name: zoo_keeper_name_space
- types:
- - <xref:JSON>
-- description: 'Specifies whether the driver uses native HiveQL queries,or converts
-
- them into an equivalent form in HiveQL.'
- name: use_native_query
- types:
- - <xref:JSON>
-- description: The user name that you use to access Hive Server.
- name: username
- types:
- - <xref:JSON>
-- description: 'The password corresponding to the user name that you provided in the
- Username
-
- field.'
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: The partial URL corresponding to the Hive server.
- name: http_path
- types:
- - <xref:JSON>
-- description: 'Specifies whether the connections to the server are encrypted using
- SSL. The
-
- default value is false.'
- name: enable_ssl
- types:
- - <xref:JSON>
-- 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.'
- name: trusted_cert_path
- types:
- - <xref:JSON>
-- description: 'Specifies whether to use a CA certificate from the system trust
-
- store or from a specified PEM file. The default value is false.'
- name: use_system_trust_store
- types:
- - <xref:JSON>
-- 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.'
- name: allow_host_name_cn_mismatch
- types:
- - <xref:JSON>
-- description: 'Specifies whether to allow self-signed certificates from
-
- the server. The default value is false.'
- name: allow_self_signed_server_cert
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveObjectDataset.yml
index bceb983b623a..c59363664c94 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveObjectDataset.yml
@@ -10,137 +10,86 @@ summary: 'Hive Server dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'HiveObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, table: MutableMapping[str, Any] | None = None, schema_type_properties_schema:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'This property will be retired. Please consider using schema + table
properties instead.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: table
description: 'The table name of the Hive. Type: string (or Expression with resultType
-
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: schema_type_properties_schema
- description: 'The schema name of the Hive. Type: string (or
+ description: 'The schema name of the Hive. Type: string (or Expression
- Expression with resultType string).'
+ with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'This property will be retired. Please consider using schema + table
-
- properties instead.'
- name: table_name
- types:
- - <xref:JSON>
-- description: 'The table name of the Hive. Type: string (or Expression with resultType
- string).'
- name: table
- types:
- - <xref:JSON>
-- description: 'The schema name of the Hive. Type: string (or Expression
-
- with resultType string).'
- name: schema_type_properties_schema
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveServerType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveServerType.yml
index b14cea24a2ca..cc2bb344e7a1 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveServerType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveServerType.yml
@@ -11,9 +11,9 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveSource.yml
deleted file mode 100644
index 49271d1d6f6f..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.HiveSource
-name: HiveSource
-fullName: azure.synapse.artifacts.models.HiveSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Hive Server source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'HiveSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveThriftTransportProtocol.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveThriftTransportProtocol.yml
index eba6a4543f4c..a9864768f304 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveThriftTransportProtocol.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveThriftTransportProtocol.yml
@@ -11,9 +11,9 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpAuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpAuthenticationType.yml
index 50f4a6434631..8ceb9498d881 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpAuthenticationType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpAuthenticationType.yml
@@ -11,13 +11,13 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpDataset.yml
deleted file mode 100644
index f6b50e376085..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpDataset.yml
+++ /dev/null
@@ -1,195 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.HttpDataset
-name: HttpDataset
-fullName: azure.synapse.artifacts.models.HttpDataset
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.Dataset
-summary: 'A file in an HTTP web server.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'HttpDataset(*, linked_service_name: _models.LinkedServiceReference, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None,
- structure: MutableMapping[str, Any] | None = None, schema: MutableMapping[str,
- Any] | None = None, parameters: Dict[str, _models.ParameterSpecification] | None
- = None, annotations: List[MutableMapping[str, Any]] | None = None, folder: _models.DatasetFolder
- | None = None, relative_url: MutableMapping[str, Any] | None = None, request_method:
- MutableMapping[str, Any] | None = None, request_body: MutableMapping[str, Any]
- | None = None, additional_headers: MutableMapping[str, Any] | None = None, format:
- _models.DatasetStorageFormat | None = None, compression: _models.DatasetCompression
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Dataset description.
- types:
- - <xref:str>
- - name: structure
- description: 'Columns that define the structure of the dataset. Type: array (or
-
- Expression with resultType array), itemType: DatasetDataElement.'
- types:
- - <xref:JSON>
- - name: schema
- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- types:
- - <xref:JSON>
- - name: linked_service_name
- description: Linked service reference. Required.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: parameters
- description: Parameters for dataset.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the Dataset.
- types:
- - <xref:list>[<xref:JSON>]
- - name: folder
- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
-
- the root level.'
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
- - name: relative_url
- description: 'The relative URL based on the URL in the HttpLinkedService refers
- to an
-
- HTTP file Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: request_method
- description: 'The HTTP method for the HTTP request. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: request_body
- description: 'The body for the HTTP request. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: additional_headers
- description: 'The headers for the HTTP Request. e.g.
-
- request-header-name-1:request-header-value-1
-
- ...
-
- request-header-name-n:request-header-value-n Type: string (or Expression with
- resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: format
- description: The format of files.
- types:
- - <xref:azure.synapse.artifacts.models.DatasetStorageFormat>
- - name: compression
- description: The data compression method used on files.
- types:
- - <xref:azure.synapse.artifacts.models.DatasetCompression>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The relative URL based on the URL in the HttpLinkedService refers
- to an
-
- HTTP file Type: string (or Expression with resultType string).'
- name: relative_url
- types:
- - <xref:JSON>
-- description: 'The HTTP method for the HTTP request. Type: string (or Expression
- with
-
- resultType string).'
- name: request_method
- types:
- - <xref:JSON>
-- description: 'The body for the HTTP request. Type: string (or Expression with resultType
-
- string).'
- name: request_body
- types:
- - <xref:JSON>
-- description: 'The headers for the HTTP Request. e.g.
-
- request-header-name-1:request-header-value-1
-
- ...
-
- request-header-name-n:request-header-value-n Type: string (or Expression with
- resultType
-
- string).'
- name: additional_headers
- types:
- - <xref:JSON>
-- description: The format of files.
- name: format
- types:
- - <xref:azure.synapse.artifacts.models.DatasetStorageFormat>
-- description: The data compression method used on files.
- name: compression
- types:
- - <xref:azure.synapse.artifacts.models.DatasetCompression>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpLinkedService.yml
index f2bcdf834d9d..2923c0cf8ffe 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpLinkedService.yml
@@ -10,49 +10,60 @@ summary: 'Linked service for an HTTP source.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'HttpLinkedService(*, url: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, authentication_type:
- str | _models.HttpAuthenticationType | None = None, user_name: MutableMapping[str,
- Any] | None = None, password: _models.SecretBase | None = None, embedded_cert_data:
- MutableMapping[str, Any] | None = None, cert_thumbprint: MutableMapping[str, Any]
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, enable_server_certificate_validation:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: url
- description: 'The base URL of the HTTP endpoint, e.g. [http://www.microsoft.com](http://www.microsoft.com).
- Type: string
+ description: 'Required. The base URL of the HTTP endpoint, e.g. [http://www.microsoft.com](http://www.microsoft.com).
+ Type:
- (or Expression with resultType string). Required.'
+ string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: authentication_type
description: 'The authentication type to be used to connect to the HTTP server.
- Known values are: "Basic", "Anonymous", "Digest", "Windows", and "ClientCertificate".'
+ Possible values include: "Basic", "Anonymous", "Digest", "Windows", "ClientCertificate".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.HttpAuthenticationType>
@@ -61,12 +72,14 @@ constructor:
(or
Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: 'Password for Basic, Digest, Windows, or ClientCertificate with
EmbeddedCertData authentication.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: embedded_cert_data
@@ -79,8 +92,9 @@ constructor:
(or Expression
with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: cert_thumbprint
description: 'Thumbprint of certificate for ClientCertificate authentication.
Only
@@ -92,114 +106,24 @@ constructor:
(or Expression
with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The base URL of the HTTP endpoint, e.g. [http://www.microsoft.com](http://www.microsoft.com).
- Type: string (or
-
- Expression with resultType string). Required.'
- name: url
- types:
- - <xref:JSON>
-- description: 'The authentication type to be used to connect to the HTTP server.
-
- Known values are: "Basic", "Anonymous", "Digest", "Windows", and "ClientCertificate".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.HttpAuthenticationType>
-- description: 'User name for Basic, Digest, or Windows authentication. Type: string
- (or
-
- Expression with resultType string).'
- name: user_name
- types:
- - <xref:JSON>
-- description: 'Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData
-
- authentication.'
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- 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).'
- name: embedded_cert_data
- types:
- - <xref:JSON>
-- 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).'
- name: cert_thumbprint
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
-- description: 'If true, validate the HTTPS server SSL certificate.
-
- Default value is true. Type: boolean (or Expression with resultType boolean).'
- name: enable_server_certificate_validation
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpReadSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpReadSettings.yml
deleted file mode 100644
index a8c8d9996a7c..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpReadSettings.yml
+++ /dev/null
@@ -1,121 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.HttpReadSettings
-name: HttpReadSettings
-fullName: azure.synapse.artifacts.models.HttpReadSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.StoreReadSettings
-summary: 'Sftp read settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'HttpReadSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None
- = None, request_method: MutableMapping[str, Any] | None = None, request_body:
- MutableMapping[str, Any] | None = None, additional_headers: MutableMapping[str,
- Any] | None = None, request_timeout: MutableMapping[str, Any] | None = None, enable_partition_discovery:
- bool | None = None, partition_root_path: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: request_method
- description: 'The HTTP method used to call the RESTful API. The default is GET.
-
- Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: request_body
- description: 'The HTTP request body to the RESTful API if requestMethod is POST.
- Type:
-
- string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: additional_headers
- description: 'The additional HTTP headers in the request to the RESTful API.
-
- Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: request_timeout
- description: 'Specifies the timeout for a HTTP client to get HTTP response from
-
- HTTP server.'
- types:
- - <xref:JSON>
- - name: enable_partition_discovery
- description: Indicates whether to enable partition discovery.
- types:
- - <xref:bool>
- - name: partition_root_path
- description: 'Specify the root path where partition discovery starts from.
-
- Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The read setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'The HTTP method used to call the RESTful API. The default is GET.
- Type:
-
- string (or Expression with resultType string).'
- name: request_method
- types:
- - <xref:JSON>
-- description: 'The HTTP request body to the RESTful API if requestMethod is POST.
- Type:
-
- string (or Expression with resultType string).'
- name: request_body
- types:
- - <xref:JSON>
-- description: 'The additional HTTP headers in the request to the RESTful API. Type:
-
- string (or Expression with resultType string).'
- name: additional_headers
- types:
- - <xref:JSON>
-- description: 'Specifies the timeout for a HTTP client to get HTTP response from
- HTTP
-
- server.'
- name: request_timeout
- types:
- - <xref:JSON>
-- description: Indicates whether to enable partition discovery.
- name: enable_partition_discovery
- types:
- - <xref:bool>
-- description: 'Specify the root path where partition discovery starts from. Type:
-
- string (or Expression with resultType string).'
- name: partition_root_path
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpServerLocation.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpServerLocation.yml
deleted file mode 100644
index 2eada4d00b52..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpServerLocation.yml
+++ /dev/null
@@ -1,74 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.HttpServerLocation
-name: HttpServerLocation
-fullName: azure.synapse.artifacts.models.HttpServerLocation
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.DatasetLocation
-summary: 'The location of http server.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'HttpServerLocation(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, folder_path: MutableMapping[str, Any] | None = None, file_name:
- MutableMapping[str, Any] | None = None, relative_url: MutableMapping[str, Any]
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: folder_path
- description: 'Specify the folder path of dataset. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: file_name
- description: 'Specify the file name of dataset. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: relative_url
- description: 'Specify the relativeUrl of http server. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset storage location. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Specify the folder path of dataset. Type: string (or Expression with
-
- resultType string).'
- name: folder_path
- types:
- - <xref:JSON>
-- description: 'Specify the file name of dataset. Type: string (or Expression with
- resultType
-
- string).'
- name: file_name
- types:
- - <xref:JSON>
-- description: 'Specify the relativeUrl of http server. Type: string (or Expression
- with
-
- resultType string).'
- name: relative_url
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpSource.yml
deleted file mode 100644
index 86e1d98aca34..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpSource.yml
+++ /dev/null
@@ -1,93 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.HttpSource
-name: HttpSource
-fullName: azure.synapse.artifacts.models.HttpSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity source for an HTTP file.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'HttpSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, http_request_timeout: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: http_request_timeout
- description: 'Specifies the timeout for a HTTP client to get HTTP response
-
- from HTTP server. The default value is equivalent to System.Net.HttpWebRequest.Timeout.
- Type:
-
- string (or Expression with resultType string), pattern:
-
- ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Specifies the timeout for a HTTP client to get HTTP response from
-
- HTTP server. The default value is equivalent to System.Net.HttpWebRequest.Timeout.
- Type: string
-
- (or Expression with resultType string), pattern:
-
- ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: http_request_timeout
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotLinkedService.yml
index 0feb50a749e5..8ecc7cdda706 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotLinkedService.yml
@@ -10,62 +10,76 @@ summary: 'Hubspot Service linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'HubspotLinkedService(*, client_id: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, client_secret:
- _models.SecretBase | None = None, access_token: _models.SecretBase | None = None,
- refresh_token: _models.SecretBase | None = None, use_encrypted_endpoints: MutableMapping[str,
- Any] | None = None, use_host_verification: MutableMapping[str, Any] | None = None,
- use_peer_verification: MutableMapping[str, Any] | None = None, encrypted_credential:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: client_id
- description: The client ID associated with your Hubspot application. Required.
+ description: Required. The client ID associated with your Hubspot application.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: client_secret
description: The client secret associated with your Hubspot application.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: access_token
description: "The access token obtained when initially\_authenticating\_your\_\
OAuth\nintegration."
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: refresh_token
description: "The refresh token obtained when initially\_authenticating\_your\_\
OAuth\nintegration."
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: use_encrypted_endpoints
- description: 'Specifies whether the data source endpoints are encrypted
+ description: 'Specifies whether the data source endpoints are encrypted using
- using HTTPS. The default value is true.'
+ HTTPS. The default value is true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_host_verification
description: 'Specifies whether to require the host name in the server''s
@@ -73,95 +87,23 @@ constructor:
default value is
true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The client ID associated with your Hubspot application. Required.
- name: client_id
- types:
- - <xref:JSON>
-- description: The client secret associated with your Hubspot application.
- name: client_secret
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: "The access token obtained when initially\_authenticating\_your\_OAuth\n\
- integration."
- name: access_token
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: "The refresh token obtained when initially\_authenticating\_your\_\
- OAuth\nintegration."
- name: refresh_token
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Specifies whether the data source endpoints are encrypted using
-
- HTTPS. The default value is true.'
- name: use_encrypted_endpoints
- types:
- - <xref:JSON>
-- 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.'
- name: use_host_verification
- types:
- - <xref:JSON>
-- description: 'Specifies whether to verify the identity of the server when
-
- connecting over SSL. The default value is true.'
- name: use_peer_verification
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotObjectDataset.yml
index b1074894a513..89df1fc3abed 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotObjectDataset.yml
@@ -10,109 +10,70 @@ summary: 'Hubspot Service dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'HubspotObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The table name. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotSource.yml
deleted file mode 100644
index be830bf0d425..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.HubspotSource
-name: HubspotSource
-fullName: azure.synapse.artifacts.models.HubspotSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Hubspot Service source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'HubspotSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IfConditionActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IfConditionActivity.yml
index de430d331af2..c0bb374ad2ba 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IfConditionActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IfConditionActivity.yml
@@ -4,73 +4,61 @@ name: IfConditionActivity
fullName: azure.synapse.artifacts.models.IfConditionActivity
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts.models._models_py3.ControlActivity
+- azure.synapse.artifacts.models._models_py3.Activity
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.
+ 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: _models.Expression, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None,
- state: str | _models.ActivityState | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs
- | None = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, if_true_activities: List[_models.Activity]
- | None = None, if_false_activities: List[_models.Activity] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: expression
- description: 'An expression that would evaluate to Boolean. This is used to determine
+ description: 'Required. An expression that would evaluate to Boolean. This is
+ used to
- the block of activities (ifTrueActivities or ifFalseActivities) that will be
- executed.
+ determine the block of activities (ifTrueActivities or ifFalseActivities) that
+ will be
- Required.'
+ executed.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.Expression>
- name: if_true_activities
@@ -78,81 +66,14 @@ constructor:
This is an optional property and if not provided, the activity will exit without
any action.'
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.Activity>]
- name: if_false_activities
- description: 'List of activities to execute if expression is evaluated to
+ description: 'List of activities to execute if expression is evaluated to false.
- false. This is an optional property and if not provided, the activity will exit
- without any
-
- action.'
+ This is an optional property and if not provided, the activity will exit without
+ any action.'
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.Activity>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: 'An expression that would evaluate to Boolean. This is used to determine
- the
-
- block of activities (ifTrueActivities or ifFalseActivities) that will be executed.
- Required.'
- name: expression
- types:
- - <xref:azure.synapse.artifacts.models.Expression>
-- 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.'
- name: if_true_activities
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.Activity>]
-- 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.'
- name: if_false_activities
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.Activity>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaAuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaAuthenticationType.yml
index e7a21b5ad285..c8f84f087dca 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaAuthenticationType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaAuthenticationType.yml
@@ -11,9 +11,9 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaLinkedService.yml
index b687bec4257d..69ae92689372 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaLinkedService.yml
@@ -10,216 +10,132 @@ summary: 'Impala server linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'ImpalaLinkedService(*, host: MutableMapping[str, Any], authentication_type:
- str | _models.ImpalaAuthenticationType, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, port:
- MutableMapping[str, Any] | None = None, username: MutableMapping[str, Any] | None
- = None, password: _models.SecretBase | None = None, enable_ssl: MutableMapping[str,
- Any] | None = None, trusted_cert_path: MutableMapping[str, Any] | None = None,
- use_system_trust_store: MutableMapping[str, Any] | None = None, allow_host_name_cn_mismatch:
- MutableMapping[str, Any] | None = None, allow_self_signed_server_cert: MutableMapping[str,
- Any] | None = None, encrypted_credential: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: host
- description: 'The IP address or host name of the Impala server. (i.e. 192.168.222.160).
+ description: 'Required. The IP address or host name of the Impala server. (i.e.
- Required.'
+ 192.168.222.160).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: port
description: 'The TCP port that the Impala server uses to listen for client connections.
The
default value is 21050.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: authentication_type
- description: 'The authentication type to use. Required. Known values are:
+ description: 'Required. The authentication type to use. Possible values include:
- "Anonymous", "SASLUsername", and "UsernameAndPassword".'
+ "Anonymous", "SASLUsername", "UsernameAndPassword".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.ImpalaAuthenticationType>
- name: username
description: 'The user name used to access the Impala server. The default value
- is
+ is anonymous
- anonymous when using SASLUsername.'
+ when using SASLUsername.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: The password corresponding to the user name when using UsernameAndPassword.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: enable_ssl
description: 'Specifies whether the connections to the server are encrypted using
- SSL.
+ SSL. The
- The default value is false.'
+ default value is false.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: trusted_cert_path
description: 'The full path of the .pem file containing trusted CA certificates
+ for
- for verifying the server when connecting over SSL. This property can only be
- set when using SSL
+ verifying the server when connecting over SSL. This property can only be set
+ when using SSL on
- on self-hosted IR. The default value is the cacerts.pem file installed with
- the IR.'
+ self-hosted IR. The default value is the cacerts.pem file installed with the
+ IR.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_system_trust_store
- description: 'Specifies whether to use a CA certificate from the system
+ description: 'Specifies whether to use a CA certificate from the system trust
- trust store or from a specified PEM file. The default value is false.'
+ store or from a specified PEM file. The default value is false.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: allow_self_signed_server_cert
- description: 'Specifies whether to allow self-signed certificates
+ description: 'Specifies whether to allow self-signed certificates from
- from the server. The default value is false.'
+ the server. The default value is false.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The IP address or host name of the Impala server. (i.e. 192.168.222.160).
- Required.
- name: host
- types:
- - <xref:JSON>
-- description: 'The TCP port that the Impala server uses to listen for client connections.
- The
-
- default value is 21050.'
- name: port
- types:
- - <xref:JSON>
-- description: 'The authentication type to use. Required. Known values are:
-
- "Anonymous", "SASLUsername", and "UsernameAndPassword".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ImpalaAuthenticationType>
-- description: 'The user name used to access the Impala server. The default value
- is anonymous
-
- when using SASLUsername.'
- name: username
- types:
- - <xref:JSON>
-- description: The password corresponding to the user name when using UsernameAndPassword.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Specifies whether the connections to the server are encrypted using
- SSL. The
-
- default value is false.'
- name: enable_ssl
- types:
- - <xref:JSON>
-- 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.'
- name: trusted_cert_path
- types:
- - <xref:JSON>
-- description: 'Specifies whether to use a CA certificate from the system trust
-
- store or from a specified PEM file. The default value is false.'
- name: use_system_trust_store
- types:
- - <xref:JSON>
-- 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.'
- name: allow_host_name_cn_mismatch
- types:
- - <xref:JSON>
-- description: 'Specifies whether to allow self-signed certificates from
-
- the server. The default value is false.'
- name: allow_self_signed_server_cert
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaObjectDataset.yml
index a5d13ff0a413..d14ba0202e7d 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaObjectDataset.yml
@@ -10,137 +10,87 @@ summary: 'Impala server dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'ImpalaObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, table: MutableMapping[str, Any] | None = None, schema_type_properties_schema:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'This property will be retired. Please consider using schema + table
properties instead.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: table
description: 'The table name of the Impala. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: schema_type_properties_schema
description: 'The schema name of the Impala. Type: string (or
Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'This property will be retired. Please consider using schema + table
-
- properties instead.'
- name: table_name
- types:
- - <xref:JSON>
-- description: 'The table name of the Impala. Type: string (or Expression with resultType
- string).'
- name: table
- types:
- - <xref:JSON>
-- description: 'The schema name of the Impala. Type: string (or Expression
-
- with resultType string).'
- name: schema_type_properties_schema
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaSource.yml
deleted file mode 100644
index ef94b78ef9a7..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ImpalaSource
-name: ImpalaSource
-fullName: azure.synapse.artifacts.models.ImpalaSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Impala server source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ImpalaSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImportSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImportSettings.yml
deleted file mode 100644
index 03c91a5d4d75..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImportSettings.yml
+++ /dev/null
@@ -1,38 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ImportSettings
-name: ImportSettings
-fullName: azure.synapse.artifacts.models.ImportSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Import command settings.
-
-
- You probably want to use the sub-classes and not this class directly. Known sub-classes
- are:
-
- AzureDatabricksDeltaLakeImportCommand, SnowflakeImportCopyCommand
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ImportSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The import setting type. Required.
- name: type
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixLinkedService.yml
index e0cc67c2c1c2..3591b0061513 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixLinkedService.yml
@@ -10,59 +10,71 @@ summary: 'Informix linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'InformixLinkedService(*, connection_string: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, authentication_type:
- MutableMapping[str, Any] | None = None, credential: _models.SecretBase | None
- = None, user_name: MutableMapping[str, Any] | None = None, password: _models.SecretBase
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
- description: 'The non-access credential portion of the connection string as well
+ description: 'Required. The non-access credential portion of the connection string
- as an optional encrypted credential. Type: string, SecureString or
+ as well as an optional encrypted credential. Type: string, SecureString or
- AzureKeyVaultSecretReference. Required.'
+ AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: authentication_type
- description: 'Type of authentication used to connect to the Informix as ODBC
+ description: 'Type of authentication used to connect to the Informix as ODBC data
- data store. Possible values are: Anonymous and Basic. Type: string (or Expression
- with
+ store. Possible values are: Anonymous and Basic. Type: string (or Expression
+ with resultType
- resultType string).'
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: credential
description: 'The access credential portion of the connection string specified
- in
+ in driver-
- driver-specific property-value format.'
+ specific property-value format.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: user_name
@@ -70,88 +82,21 @@ constructor:
with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: Password for Basic authentication.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The non-access credential portion of the connection string as well
- as
-
- an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.
-
- Required.'
- name: connection_string
- types:
- - <xref:JSON>
-- 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).'
- name: authentication_type
- types:
- - <xref:JSON>
-- description: 'The access credential portion of the connection string specified in
-
- driver-specific property-value format.'
- name: credential
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'User name for Basic authentication. Type: string (or Expression with
-
- resultType string).'
- name: user_name
- types:
- - <xref:JSON>
-- description: Password for Basic authentication.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixSink.yml
deleted file mode 100644
index 64f3063a38ad..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixSink.yml
+++ /dev/null
@@ -1,108 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.InformixSink
-name: InformixSink
-fullName: azure.synapse.artifacts.models.InformixSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Informix sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'InformixSink(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, write_batch_size: MutableMapping[str, Any] | None = None, write_batch_timeout:
- MutableMapping[str, Any] | None = None, sink_retry_count: MutableMapping[str,
- Any] | None = None, sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, pre_copy_script: MutableMapping[str, Any]
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: pre_copy_script
- description: 'A query to execute before starting the copy. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'A query to execute before starting the copy. Type: string (or Expression
-
- with resultType string).'
- name: pre_copy_script
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixSource.yml
deleted file mode 100644
index 4cfc35aab5c1..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixSource.yml
+++ /dev/null
@@ -1,105 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.InformixSource
-name: InformixSource
-fullName: azure.synapse.artifacts.models.InformixSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity source for Informix.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'InformixSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, query:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'Database query. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'Database query. Type: string (or Expression with resultType string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixTableDataset.yml
index f52327c8be20..dd7aee8350ab 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixTableDataset.yml
@@ -10,112 +10,72 @@ summary: 'The Informix table dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'InformixTableDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The Informix table name. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The Informix table name. Type: string (or Expression with resultType
- string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntime.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntime.yml
deleted file mode 100644
index d28e1267fe77..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntime.yml
+++ /dev/null
@@ -1,50 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.IntegrationRuntime
-name: IntegrationRuntime
-fullName: azure.synapse.artifacts.models.IntegrationRuntime
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Azure Synapse nested object which serves as a compute resource for activities.
-
-
- You probably want to use the sub-classes and not this class directly. Known sub-classes
- are:
-
- ManagedIntegrationRuntime, SelfHostedIntegrationRuntime
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'IntegrationRuntime(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Integration runtime description.
- types:
- - <xref:str>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: 'Type of integration runtime. Required. Known values are: "Managed"
- and
-
- "SelfHosted".'
- name: type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeType>
-- description: Integration runtime description.
- name: description
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeComputeProperties.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeComputeProperties.yml
deleted file mode 100644
index 68ccd22f52cc..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeComputeProperties.yml
+++ /dev/null
@@ -1,91 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.IntegrationRuntimeComputeProperties
-name: IntegrationRuntimeComputeProperties
-fullName: azure.synapse.artifacts.models.IntegrationRuntimeComputeProperties
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: The compute resource properties for managed integration runtime.
-constructor:
- syntax: 'IntegrationRuntimeComputeProperties(*, additional_properties: Dict[str,
- MutableMapping[str, Any]] | None = None, location: str | None = None, node_size:
- str | None = None, number_of_nodes: int | None = None, max_parallel_executions_per_node:
- int | None = None, data_flow_properties: _models.IntegrationRuntimeDataFlowProperties
- | None = None, v_net_properties: _models.IntegrationRuntimeVNetProperties | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: location
- description: 'The location for managed integration runtime. The supported regions
- could be
-
- found on
-
- [https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities](https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities).'
- types:
- - <xref:str>
- - name: node_size
- description: The node size requirement to managed integration runtime.
- types:
- - <xref:str>
- - name: number_of_nodes
- description: The required number of nodes for managed integration runtime.
- types:
- - <xref:int>
- - name: max_parallel_executions_per_node
- description: 'Maximum parallel executions count per node for
-
- managed integration runtime.'
- types:
- - <xref:int>
- - name: data_flow_properties
- description: Data flow properties for managed integration runtime.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeDataFlowProperties>
- - name: v_net_properties
- description: VNet properties for managed integration runtime.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeVNetProperties>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: 'The location for managed integration runtime. The supported regions
- could be
-
- found on
-
- [https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities](https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities).'
- name: location
- types:
- - <xref:str>
-- description: The node size requirement to managed integration runtime.
- name: node_size
- types:
- - <xref:str>
-- description: The required number of nodes for managed integration runtime.
- name: number_of_nodes
- types:
- - <xref:int>
-- description: 'Maximum parallel executions count per node for managed
-
- integration runtime.'
- name: max_parallel_executions_per_node
- types:
- - <xref:int>
-- description: Data flow properties for managed integration runtime.
- name: data_flow_properties
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeDataFlowProperties>
-- description: VNet properties for managed integration runtime.
- name: v_net_properties
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeVNetProperties>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeCustomSetupScriptProperties.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeCustomSetupScriptProperties.yml
deleted file mode 100644
index e9710cbdcaa4..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeCustomSetupScriptProperties.yml
+++ /dev/null
@@ -1,33 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.IntegrationRuntimeCustomSetupScriptProperties
-name: IntegrationRuntimeCustomSetupScriptProperties
-fullName: azure.synapse.artifacts.models.IntegrationRuntimeCustomSetupScriptProperties
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Custom setup script properties for a managed dedicated integration runtime.
-constructor:
- syntax: 'IntegrationRuntimeCustomSetupScriptProperties(*, blob_container_uri: str
- | None = None, sas_token: _models.SecureString | None = None, **kwargs: Any)'
- parameters:
- - name: blob_container_uri
- description: 'The URI of the Azure blob container that contains the custom setup
-
- script.'
- types:
- - <xref:str>
- - name: sas_token
- description: The SAS token of the Azure blob container.
- types:
- - <xref:azure.synapse.artifacts.models.SecureString>
-variables:
-- description: 'The URI of the Azure blob container that contains the custom setup
-
- script.'
- name: blob_container_uri
- types:
- - <xref:str>
-- description: The SAS token of the Azure blob container.
- name: sas_token
- types:
- - <xref:azure.synapse.artifacts.models.SecureString>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeDataFlowProperties.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeDataFlowProperties.yml
deleted file mode 100644
index e5c68fbe596a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeDataFlowProperties.yml
+++ /dev/null
@@ -1,84 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.IntegrationRuntimeDataFlowProperties
-name: IntegrationRuntimeDataFlowProperties
-fullName: azure.synapse.artifacts.models.IntegrationRuntimeDataFlowProperties
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Data flow properties for managed integration runtime.
-constructor:
- syntax: 'IntegrationRuntimeDataFlowProperties(*, additional_properties: Dict[str,
- MutableMapping[str, Any]] | None = None, compute_type: str | _models.DataFlowComputeType
- | None = None, core_count: int | None = None, time_to_live: int | None = None,
- cleanup: bool | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: compute_type
- description: 'Compute type of the cluster which will execute data flow job. Known
-
- values are: "General", "MemoryOptimized", and "ComputeOptimized".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.DataFlowComputeType>
- - 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.'
- types:
- - <xref:int>
- - name: time_to_live
- description: 'Time to live (in minutes) setting of the cluster which will execute
- data
-
- flow job.'
- types:
- - <xref:int>
- - name: cleanup
- description: 'Cluster will not be recycled and it will be used in next data flow
- activity
-
- run until TTL (time to live) is reached if this is set as false. Default is
- true.'
- types:
- - <xref:bool>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: 'Compute type of the cluster which will execute data flow job. Known
- values
-
- are: "General", "MemoryOptimized", and "ComputeOptimized".'
- name: compute_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.DataFlowComputeType>
-- description: 'Core count of the cluster which will execute data flow job. Supported
- values
-
- are: 8, 16, 32, 48, 80, 144 and 272.'
- name: core_count
- types:
- - <xref:int>
-- description: 'Time to live (in minutes) setting of the cluster which will execute
- data
-
- flow job.'
- name: time_to_live
- types:
- - <xref:int>
-- description: 'Cluster will not be recycled and it will be used in next data flow
- activity run
-
- until TTL (time to live) is reached if this is set as false. Default is true.'
- name: cleanup
- types:
- - <xref:bool>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeDataProxyProperties.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeDataProxyProperties.yml
deleted file mode 100644
index eb582a07e142..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeDataProxyProperties.yml
+++ /dev/null
@@ -1,38 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.IntegrationRuntimeDataProxyProperties
-name: IntegrationRuntimeDataProxyProperties
-fullName: azure.synapse.artifacts.models.IntegrationRuntimeDataProxyProperties
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Data proxy properties for a managed dedicated integration runtime.
-constructor:
- syntax: 'IntegrationRuntimeDataProxyProperties(*, connect_via: _models.EntityReference
- | None = None, staging_linked_service: _models.EntityReference | None = None,
- path: str | None = None, **kwargs: Any)'
- parameters:
- - name: connect_via
- description: The self-hosted integration runtime reference.
- types:
- - <xref:azure.synapse.artifacts.models.EntityReference>
- - name: staging_linked_service
- description: The staging linked service reference.
- types:
- - <xref:azure.synapse.artifacts.models.EntityReference>
- - name: path
- description: The path to contain the staged data in the Blob storage.
- types:
- - <xref:str>
-variables:
-- description: The self-hosted integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.EntityReference>
-- description: The staging linked service reference.
- name: staging_linked_service
- types:
- - <xref:azure.synapse.artifacts.models.EntityReference>
-- description: The path to contain the staged data in the Blob storage.
- name: path
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeDebugResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeDebugResource.yml
deleted file mode 100644
index 6e80701db78f..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeDebugResource.yml
+++ /dev/null
@@ -1,32 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.IntegrationRuntimeDebugResource
-name: IntegrationRuntimeDebugResource
-fullName: azure.synapse.artifacts.models.IntegrationRuntimeDebugResource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.SubResourceDebugResource
-summary: 'Integration runtime debug resource.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'IntegrationRuntimeDebugResource(*, properties: _models.IntegrationRuntime,
- name: str | None = None, **kwargs: Any)'
- parameters:
- - name: name
- description: The resource name.
- types:
- - <xref:str>
- - name: properties
- description: Integration runtime properties. Required.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntime>
-variables:
-- description: The resource name.
- name: name
- types:
- - <xref:str>
-- description: Integration runtime properties. Required.
- name: properties
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntime>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeEdition.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeEdition.yml
deleted file mode 100644
index 5b53cd06c308..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeEdition.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.IntegrationRuntimeEdition
-name: IntegrationRuntimeEdition
-fullName: azure.synapse.artifacts.models.IntegrationRuntimeEdition
-summary: The edition for the SSIS Integration Runtime.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: IntegrationRuntimeEdition(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: ENTERPRISE
- uid: azure.synapse.artifacts.models.IntegrationRuntimeEdition.ENTERPRISE
-- name: STANDARD
- uid: azure.synapse.artifacts.models.IntegrationRuntimeEdition.STANDARD
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeEntityReferenceType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeEntityReferenceType.yml
deleted file mode 100644
index 9824f67b3586..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeEntityReferenceType.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.IntegrationRuntimeEntityReferenceType
-name: IntegrationRuntimeEntityReferenceType
-fullName: azure.synapse.artifacts.models.IntegrationRuntimeEntityReferenceType
-summary: The type of this referenced entity.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: IntegrationRuntimeEntityReferenceType(value, names=None, *, module=None,
- qualname=None, type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: INTEGRATION_RUNTIME_REFERENCE
- uid: azure.synapse.artifacts.models.IntegrationRuntimeEntityReferenceType.INTEGRATION_RUNTIME_REFERENCE
-- name: LINKED_SERVICE_REFERENCE
- uid: azure.synapse.artifacts.models.IntegrationRuntimeEntityReferenceType.LINKED_SERVICE_REFERENCE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeLicenseType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeLicenseType.yml
deleted file mode 100644
index 5512c3f875ce..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeLicenseType.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.IntegrationRuntimeLicenseType
-name: IntegrationRuntimeLicenseType
-fullName: azure.synapse.artifacts.models.IntegrationRuntimeLicenseType
-summary: License type for bringing your own license scenario.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: IntegrationRuntimeLicenseType(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: BASE_PRICE
- uid: azure.synapse.artifacts.models.IntegrationRuntimeLicenseType.BASE_PRICE
-- name: LICENSE_INCLUDED
- uid: azure.synapse.artifacts.models.IntegrationRuntimeLicenseType.LICENSE_INCLUDED
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeListResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeListResponse.yml
deleted file mode 100644
index 4ce6c7ef6205..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeListResponse.yml
+++ /dev/null
@@ -1,32 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.IntegrationRuntimeListResponse
-name: IntegrationRuntimeListResponse
-fullName: azure.synapse.artifacts.models.IntegrationRuntimeListResponse
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'A list of integration runtime resources.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'IntegrationRuntimeListResponse(*, value: List[_models.IntegrationRuntimeResource],
- next_link: str | None = None, **kwargs: Any)'
- parameters:
- - name: value
- description: List of integration runtimes. Required.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.IntegrationRuntimeResource>]
- - name: next_link
- description: The link to the next page of results, if any remaining results exist.
- types:
- - <xref:str>
-variables:
-- description: List of integration runtimes. Required.
- name: value
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.IntegrationRuntimeResource>]
-- description: The link to the next page of results, if any remaining results exist.
- name: next_link
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeReference.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeReference.yml
index 2bd575e531d9..3897be04da75 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeReference.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeReference.yml
@@ -4,40 +4,36 @@ name: IntegrationRuntimeReference
fullName: azure.synapse.artifacts.models.IntegrationRuntimeReference
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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(*, type: str | _models.IntegrationRuntimeReferenceType,
- reference_name: str, parameters: Dict[str, MutableMapping[str, Any]] | None =
- None, **kwargs: Any)'
+ syntax: 'IntegrationRuntimeReference(*, reference_name: str, parameters: Dict[str,
+ object] | None = None, **kwargs)'
parameters:
- - name: type
- description: Type of integration runtime. Required. "IntegrationRuntimeReference"
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReferenceType>
- name: reference_name
- description: Reference integration runtime name. Required.
+ description: Required. Reference integration runtime name.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Arguments for integration runtime.
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
variables:
-- description: Type of integration runtime. Required. "IntegrationRuntimeReference"
+- description: 'Required. Type of integration runtime. Default value:
+
+ "IntegrationRuntimeReference".'
name: type
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReferenceType>
-- description: Reference integration runtime name. Required.
- name: reference_name
- types:
- - <xref:str>
-- description: Arguments for integration runtime.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+attributes:
+- uid: azure.synapse.artifacts.models.IntegrationRuntimeReference.type
+ name: type
+ signature: type = 'IntegrationRuntimeReference'
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeReferenceType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeReferenceType.yml
deleted file mode 100644
index 7d974ea4593d..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeReferenceType.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.IntegrationRuntimeReferenceType
-name: IntegrationRuntimeReferenceType
-fullName: azure.synapse.artifacts.models.IntegrationRuntimeReferenceType
-summary: Type of integration runtime.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: IntegrationRuntimeReferenceType(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: INTEGRATION_RUNTIME_REFERENCE
- uid: azure.synapse.artifacts.models.IntegrationRuntimeReferenceType.INTEGRATION_RUNTIME_REFERENCE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeResource.yml
deleted file mode 100644
index 2808d8706a56..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeResource.yml
+++ /dev/null
@@ -1,48 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.IntegrationRuntimeResource
-name: IntegrationRuntimeResource
-fullName: azure.synapse.artifacts.models.IntegrationRuntimeResource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.SubResource
-summary: 'Integration runtime 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: 'IntegrationRuntimeResource(*, properties: _models.IntegrationRuntime, **kwargs:
- Any)'
- parameters:
- - name: properties
- description: Integration runtime properties. Required.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntime>
-variables:
-- description: 'Fully qualified resource ID for the resource. Ex -
-
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.'
- name: id
- types:
- - <xref:str>
-- description: The name of the resource.
- name: name
- types:
- - <xref:str>
-- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines"
- or
-
- "Microsoft.Storage/storageAccounts".'
- name: type
- types:
- - <xref:str>
-- description: Resource Etag.
- name: etag
- types:
- - <xref:str>
-- description: Integration runtime properties. Required.
- name: properties
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntime>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogInfo.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogInfo.yml
deleted file mode 100644
index b594df00fa8e..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogInfo.yml
+++ /dev/null
@@ -1,76 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogInfo
-name: IntegrationRuntimeSsisCatalogInfo
-fullName: azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogInfo
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Catalog information for managed dedicated integration runtime.
-constructor:
- syntax: 'IntegrationRuntimeSsisCatalogInfo(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, catalog_server_endpoint: str | None = None, catalog_admin_user_name:
- str | None = None, catalog_admin_password: _models.SecureString | None = None,
- catalog_pricing_tier: str | _models.IntegrationRuntimeSsisCatalogPricingTier |
- None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: catalog_server_endpoint
- description: The catalog database server URL.
- types:
- - <xref:str>
- - name: catalog_admin_user_name
- description: The administrator user name of catalog database.
- types:
- - <xref:str>
- - name: catalog_admin_password
- description: 'The password of the administrator user account of the catalog
-
- database.'
- types:
- - <xref:azure.synapse.artifacts.models.SecureString>
- - name: catalog_pricing_tier
- description: 'The pricing tier for the catalog database. The valid values
-
- could be found in [https://azure.microsoft.com/en-us/pricing/details/sql-database/](https://azure.microsoft.com/en-us/pricing/details/sql-database/).
- Known values
-
- are: "Basic", "Standard", "Premium", and "PremiumRS".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogPricingTier>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The catalog database server URL.
- name: catalog_server_endpoint
- types:
- - <xref:str>
-- description: The administrator user name of catalog database.
- name: catalog_admin_user_name
- types:
- - <xref:str>
-- description: 'The password of the administrator user account of the catalog
-
- database.'
- name: catalog_admin_password
- types:
- - <xref:azure.synapse.artifacts.models.SecureString>
-- description: 'The pricing tier for the catalog database. The valid values could
-
- be found in [https://azure.microsoft.com/en-us/pricing/details/sql-database/](https://azure.microsoft.com/en-us/pricing/details/sql-database/).
- Known values are:
-
- "Basic", "Standard", "Premium", and "PremiumRS".'
- name: catalog_pricing_tier
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogPricingTier>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogPricingTier.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogPricingTier.yml
deleted file mode 100644
index b8f7518bb9c1..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogPricingTier.yml
+++ /dev/null
@@ -1,24 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogPricingTier
-name: IntegrationRuntimeSsisCatalogPricingTier
-fullName: azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogPricingTier
-summary: 'The pricing tier for the catalog database. The valid values could be found
- in
-
- [https://azure.microsoft.com/en-us/pricing/details/sql-database/](https://azure.microsoft.com/en-us/pricing/details/sql-database/).'
-module: azure.synapse.artifacts.models
-constructor:
- syntax: IntegrationRuntimeSsisCatalogPricingTier(value, names=None, *, module=None,
- qualname=None, type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: BASIC
- uid: azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogPricingTier.BASIC
-- name: PREMIUM
- uid: azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogPricingTier.PREMIUM
-- name: PREMIUM_RS
- uid: azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogPricingTier.PREMIUM_RS
-- name: STANDARD
- uid: azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogPricingTier.STANDARD
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeSsisProperties.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeSsisProperties.yml
deleted file mode 100644
index 55e5a3f70d46..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeSsisProperties.yml
+++ /dev/null
@@ -1,105 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.IntegrationRuntimeSsisProperties
-name: IntegrationRuntimeSsisProperties
-fullName: azure.synapse.artifacts.models.IntegrationRuntimeSsisProperties
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: SSIS properties for managed integration runtime.
-constructor:
- syntax: 'IntegrationRuntimeSsisProperties(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, catalog_info: _models.IntegrationRuntimeSsisCatalogInfo |
- None = None, license_type: str | _models.IntegrationRuntimeLicenseType | None
- = None, custom_setup_script_properties: _models.IntegrationRuntimeCustomSetupScriptProperties
- | None = None, data_proxy_properties: _models.IntegrationRuntimeDataProxyProperties
- | None = None, edition: str | _models.IntegrationRuntimeEdition | None = None,
- express_custom_setup_properties: List[_models.CustomSetupBase] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: catalog_info
- description: Catalog information for managed dedicated integration runtime.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogInfo>
- - name: license_type
- description: 'License type for bringing your own license scenario. Known values
- are:
-
- "BasePrice" and "LicenseIncluded".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeLicenseType>
- - name: custom_setup_script_properties
- description: 'Custom setup script properties for a managed dedicated
-
- integration runtime.'
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeCustomSetupScriptProperties>
- - name: data_proxy_properties
- description: 'Data proxy properties for a managed dedicated integration
-
- runtime.'
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeDataProxyProperties>
- - name: edition
- description: 'The edition for the SSIS Integration Runtime. Known values are:
- "Standard"
-
- and "Enterprise".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeEdition>
- - name: express_custom_setup_properties
- description: 'Custom setup without script properties for a SSIS
-
- integration runtime.'
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.CustomSetupBase>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Catalog information for managed dedicated integration runtime.
- name: catalog_info
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogInfo>
-- description: 'License type for bringing your own license scenario. Known values
- are:
-
- "BasePrice" and "LicenseIncluded".'
- name: license_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeLicenseType>
-- description: 'Custom setup script properties for a managed dedicated
-
- integration runtime.'
- name: custom_setup_script_properties
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeCustomSetupScriptProperties>
-- description: Data proxy properties for a managed dedicated integration runtime.
- name: data_proxy_properties
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeDataProxyProperties>
-- description: 'The edition for the SSIS Integration Runtime. Known values are: "Standard"
- and
-
- "Enterprise".'
- name: edition
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeEdition>
-- description: 'Custom setup without script properties for a SSIS
-
- integration runtime.'
- name: express_custom_setup_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.CustomSetupBase>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeState.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeState.yml
deleted file mode 100644
index b2e95509ece1..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeState.yml
+++ /dev/null
@@ -1,33 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.IntegrationRuntimeState
-name: IntegrationRuntimeState
-fullName: azure.synapse.artifacts.models.IntegrationRuntimeState
-summary: The state of integration runtime.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: IntegrationRuntimeState(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: ACCESS_DENIED
- uid: azure.synapse.artifacts.models.IntegrationRuntimeState.ACCESS_DENIED
-- name: INITIAL
- uid: azure.synapse.artifacts.models.IntegrationRuntimeState.INITIAL
-- name: LIMITED
- uid: azure.synapse.artifacts.models.IntegrationRuntimeState.LIMITED
-- name: NEED_REGISTRATION
- uid: azure.synapse.artifacts.models.IntegrationRuntimeState.NEED_REGISTRATION
-- name: OFFLINE
- uid: azure.synapse.artifacts.models.IntegrationRuntimeState.OFFLINE
-- name: ONLINE
- uid: azure.synapse.artifacts.models.IntegrationRuntimeState.ONLINE
-- name: STARTED
- uid: azure.synapse.artifacts.models.IntegrationRuntimeState.STARTED
-- name: STARTING
- uid: azure.synapse.artifacts.models.IntegrationRuntimeState.STARTING
-- name: STOPPED
- uid: azure.synapse.artifacts.models.IntegrationRuntimeState.STOPPED
-- name: STOPPING
- uid: azure.synapse.artifacts.models.IntegrationRuntimeState.STOPPING
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeType.yml
deleted file mode 100644
index c0c51a540e35..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeType.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.IntegrationRuntimeType
-name: IntegrationRuntimeType
-fullName: azure.synapse.artifacts.models.IntegrationRuntimeType
-summary: The type of integration runtime.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: IntegrationRuntimeType(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: MANAGED
- uid: azure.synapse.artifacts.models.IntegrationRuntimeType.MANAGED
-- name: SELF_HOSTED
- uid: azure.synapse.artifacts.models.IntegrationRuntimeType.SELF_HOSTED
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeVNetProperties.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeVNetProperties.yml
deleted file mode 100644
index 2fff1890c0cd..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeVNetProperties.yml
+++ /dev/null
@@ -1,55 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.IntegrationRuntimeVNetProperties
-name: IntegrationRuntimeVNetProperties
-fullName: azure.synapse.artifacts.models.IntegrationRuntimeVNetProperties
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: VNet properties for managed integration runtime.
-constructor:
- syntax: 'IntegrationRuntimeVNetProperties(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, v_net_id: str | None = None, subnet: str | None = None, public_i_ps:
- List[str] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: v_net_id
- description: The ID of the VNet that this integration runtime will join.
- types:
- - <xref:str>
- - name: subnet
- description: The name of the subnet this integration runtime will join.
- types:
- - <xref:str>
- - name: public_i_ps
- description: 'Resource IDs of the public IP addresses that this integration runtime
-
- will use.'
- types:
- - <xref:list>[<xref:str>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The ID of the VNet that this integration runtime will join.
- name: v_net_id
- types:
- - <xref:str>
-- description: The name of the subnet this integration runtime will join.
- name: subnet
- types:
- - <xref:str>
-- description: 'Resource IDs of the public IP addresses that this integration runtime
- will
-
- use.'
- name: public_i_ps
- types:
- - <xref:list>[<xref:str>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraLinkedService.yml
index 4ca3538ded48..25ba9326cbed 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraLinkedService.yml
@@ -10,69 +10,82 @@ summary: 'Jira Service linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'JiraLinkedService(*, host: MutableMapping[str, Any], username: MutableMapping[str,
- Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- connect_via: _models.IntegrationRuntimeReference | None = None, description: str
- | None = None, parameters: Dict[str, _models.ParameterSpecification] | None =
- None, annotations: List[MutableMapping[str, Any]] | None = None, port: MutableMapping[str,
- Any] | None = None, password: _models.SecretBase | None = None, use_encrypted_endpoints:
- MutableMapping[str, Any] | None = None, use_host_verification: MutableMapping[str,
- Any] | None = None, use_peer_verification: MutableMapping[str, Any] | None = None,
- encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: host
- description: 'The IP address or host name of the Jira service. (e.g. jira.example.com).
+ description: 'Required. The IP address or host name of the Jira service. (e.g.
- Required.'
+ jira.example.com).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: username
- description: The user name that you use to access Jira Service. Required.
+ description: Required. The user name that you use to access Jira Service.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: 'The password corresponding to the user name that you provided in
- the
+ the username
- username field.'
+ field.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: use_encrypted_endpoints
- description: 'Specifies whether the data source endpoints are encrypted
+ description: 'Specifies whether the data source endpoints are encrypted using
- using HTTPS. The default value is true.'
+ HTTPS. The default value is true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_host_verification
description: 'Specifies whether to require the host name in the server''s
@@ -80,101 +93,23 @@ constructor:
default value is
true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The IP address or host name of the Jira service. (e.g. jira.example.com).
- Required.
- name: host
- types:
- - <xref:JSON>
-- 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.'
- name: port
- types:
- - <xref:JSON>
-- description: The user name that you use to access Jira Service. Required.
- name: username
- types:
- - <xref:JSON>
-- description: 'The password corresponding to the user name that you provided in the
- username
-
- field.'
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Specifies whether the data source endpoints are encrypted using
-
- HTTPS. The default value is true.'
- name: use_encrypted_endpoints
- types:
- - <xref:JSON>
-- 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.'
- name: use_host_verification
- types:
- - <xref:JSON>
-- description: 'Specifies whether to verify the identity of the server when
-
- connecting over SSL. The default value is true.'
- name: use_peer_verification
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraObjectDataset.yml
index db15a139e2e8..3a6e50e06270 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraObjectDataset.yml
@@ -10,109 +10,70 @@ summary: 'Jira Service dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'JiraObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The table name. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraSource.yml
deleted file mode 100644
index efc6b6137ff3..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.JiraSource
-name: JiraSource
-fullName: azure.synapse.artifacts.models.JiraSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Jira Service source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'JiraSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonDataset.yml
index 5e808ebe3b90..5463e7557c02 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonDataset.yml
@@ -10,59 +10,72 @@ summary: 'Json dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'JsonDataset(*, linked_service_name: _models.LinkedServiceReference, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None,
- structure: MutableMapping[str, Any] | None = None, schema: MutableMapping[str,
- Any] | None = None, parameters: Dict[str, _models.ParameterSpecification] | None
- = None, annotations: List[MutableMapping[str, Any]] | None = None, folder: _models.DatasetFolder
- | None = None, location: _models.DatasetLocation | None = None, encoding_name:
- MutableMapping[str, Any] | None = None, compression: _models.DatasetCompression
- | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: location
description: The location of the json data storage.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetLocation>
- name: encoding_name
@@ -78,79 +91,11 @@ constructor:
Type: string (or Expression with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: compression
description: The data compression method used for the json dataset.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetCompression>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: The location of the json data storage.
- name: location
- types:
- - <xref:azure.synapse.artifacts.models.DatasetLocation>
-- 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).'
- name: encoding_name
- types:
- - <xref:JSON>
-- description: The data compression method used for the json dataset.
- name: compression
- types:
- - <xref:azure.synapse.artifacts.models.DatasetCompression>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonFormat.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonFormat.yml
deleted file mode 100644
index 8b6cce261c18..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonFormat.yml
+++ /dev/null
@@ -1,152 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.JsonFormat
-name: JsonFormat
-fullName: azure.synapse.artifacts.models.JsonFormat
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.DatasetStorageFormat
-summary: 'The data stored in JSON format.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'JsonFormat(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, serializer: MutableMapping[str, Any] | None = None, deserializer:
- MutableMapping[str, Any] | None = None, file_pattern: MutableMapping[str, Any]
- | None = None, nesting_separator: MutableMapping[str, Any] | None = None, encoding_name:
- MutableMapping[str, Any] | None = None, json_node_reference: MutableMapping[str,
- Any] | None = None, json_path_definition: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: serializer
- description: 'Serializer. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: deserializer
- description: 'Deserializer. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: file_pattern
- description: 'File pattern of JSON. To be more specific, the way of separating
- a
-
- collection of JSON objects. The default value is ''setOfObjects''. It is case-sensitive.'
- types:
- - <xref:JSON>
- - name: nesting_separator
- description: 'The character used to separate nesting levels. Default value is
- ''.''
-
- (dot). Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: encoding_name
- description: 'The code page name of the preferred encoding. If not provided, the
-
- default value is ''utf-8'', unless the byte order mark (BOM) denotes another
- Unicode encoding.
-
- The full list of supported values can be found in the ''Name'' column of the
- table of encodings
-
- in the following reference: [https://go.microsoft.com/fwlink/?linkid=861078](https://go.microsoft.com/fwlink/?linkid=861078).
- Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: json_node_reference
- description: 'The JSONPath of the JSON array element to be flattened. Example:
-
- "$.ArrayPath". Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: json_path_definition
- description: 'The JSONPath definition for each column mapping with a
-
- customized column name to extract data from JSON file. For fields under root
- object, start with
-
- "$"; for fields inside the array chosen by jsonNodeReference property, start
- from the array
-
- element. Example: {"Column1": "$.Column1Path", "Column2": "Column2PathInArray"}.
- Type: object
-
- (or Expression with resultType object).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset storage format. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Serializer. Type: string (or Expression with resultType string).'
- name: serializer
- types:
- - <xref:JSON>
-- description: 'Deserializer. Type: string (or Expression with resultType string).'
- name: deserializer
- types:
- - <xref:JSON>
-- description: 'File pattern of JSON. To be more specific, the way of separating a
-
- collection of JSON objects. The default value is ''setOfObjects''. It is case-sensitive.'
- name: file_pattern
- types:
- - <xref:JSON>
-- description: 'The character used to separate nesting levels. Default value is ''.''
-
- (dot). Type: string (or Expression with resultType string).'
- name: nesting_separator
- types:
- - <xref:JSON>
-- description: 'The code page name of the preferred encoding. If not provided, the
- default
-
- value is ''utf-8'', unless the byte order mark (BOM) denotes another Unicode encoding.
- The full
-
- list of supported values can be found in the ''Name'' column of the table of encodings
- in the
-
- following reference: [https://go.microsoft.com/fwlink/?linkid=861078](https://go.microsoft.com/fwlink/?linkid=861078).
- Type: string (or
-
- Expression with resultType string).'
- name: encoding_name
- types:
- - <xref:JSON>
-- description: 'The JSONPath of the JSON array element to be flattened. Example:
-
- "$.ArrayPath". Type: string (or Expression with resultType string).'
- name: json_node_reference
- types:
- - <xref:JSON>
-- description: 'The JSONPath definition for each column mapping with a customized
-
- column name to extract data from JSON file. For fields under root object, start
- with "$"; for
-
- fields inside the array chosen by jsonNodeReference property, start from the array
- element.
-
- Example: {"Column1": "$.Column1Path", "Column2": "Column2PathInArray"}. Type:
- object (or
-
- Expression with resultType object).'
- name: json_path_definition
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonFormatFilePattern.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonFormatFilePattern.yml
deleted file mode 100644
index 5ccd93f2b00e..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonFormatFilePattern.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.JsonFormatFilePattern
-name: JsonFormatFilePattern
-fullName: azure.synapse.artifacts.models.JsonFormatFilePattern
-summary: JSON format file pattern. A property of JsonFormat.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: JsonFormatFilePattern(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: ARRAY_OF_OBJECTS
- uid: azure.synapse.artifacts.models.JsonFormatFilePattern.ARRAY_OF_OBJECTS
-- name: SET_OF_OBJECTS
- uid: azure.synapse.artifacts.models.JsonFormatFilePattern.SET_OF_OBJECTS
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonReadSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonReadSettings.yml
deleted file mode 100644
index e8a78bd69c42..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonReadSettings.yml
+++ /dev/null
@@ -1,41 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.JsonReadSettings
-name: JsonReadSettings
-fullName: azure.synapse.artifacts.models.JsonReadSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.FormatReadSettings
-summary: 'Json read settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'JsonReadSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, compression_properties: _models.CompressionReadSettings |
- None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: compression_properties
- description: Compression settings.
- types:
- - <xref:azure.synapse.artifacts.models.CompressionReadSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The read setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: Compression settings.
- name: compression_properties
- types:
- - <xref:azure.synapse.artifacts.models.CompressionReadSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonSink.yml
deleted file mode 100644
index 73edd22b4aa4..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonSink.yml
+++ /dev/null
@@ -1,113 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.JsonSink
-name: JsonSink
-fullName: azure.synapse.artifacts.models.JsonSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Json sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'JsonSink(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, write_batch_size: MutableMapping[str, Any] | None = None, write_batch_timeout:
- MutableMapping[str, Any] | None = None, sink_retry_count: MutableMapping[str,
- Any] | None = None, sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, store_settings: _models.StoreWriteSettings
- | None = None, format_settings: _models.JsonWriteSettings | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: store_settings
- description: Json store settings.
- types:
- - <xref:azure.synapse.artifacts.models.StoreWriteSettings>
- - name: format_settings
- description: Json format settings.
- types:
- - <xref:azure.synapse.artifacts.models.JsonWriteSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: Json store settings.
- name: store_settings
- types:
- - <xref:azure.synapse.artifacts.models.StoreWriteSettings>
-- description: Json format settings.
- name: format_settings
- types:
- - <xref:azure.synapse.artifacts.models.JsonWriteSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonSource.yml
deleted file mode 100644
index 80757192e024..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonSource.yml
+++ /dev/null
@@ -1,101 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.JsonSource
-name: JsonSource
-fullName: azure.synapse.artifacts.models.JsonSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity Json source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'JsonSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, store_settings: _models.StoreReadSettings | None = None, format_settings:
- _models.JsonReadSettings | None = None, additional_columns: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: store_settings
- description: Json store settings.
- types:
- - <xref:azure.synapse.artifacts.models.StoreReadSettings>
- - name: format_settings
- description: Json format settings.
- types:
- - <xref:azure.synapse.artifacts.models.JsonReadSettings>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: Json store settings.
- name: store_settings
- types:
- - <xref:azure.synapse.artifacts.models.StoreReadSettings>
-- description: Json format settings.
- name: format_settings
- types:
- - <xref:azure.synapse.artifacts.models.JsonReadSettings>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonWriteFilePattern.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonWriteFilePattern.yml
deleted file mode 100644
index cc1c6df5fc06..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonWriteFilePattern.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.JsonWriteFilePattern
-name: JsonWriteFilePattern
-fullName: azure.synapse.artifacts.models.JsonWriteFilePattern
-summary: All available filePatterns.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: JsonWriteFilePattern(value, names=None, *, module=None, qualname=None, type=None,
- start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: ARRAY_OF_OBJECTS
- uid: azure.synapse.artifacts.models.JsonWriteFilePattern.ARRAY_OF_OBJECTS
-- name: SET_OF_OBJECTS
- uid: azure.synapse.artifacts.models.JsonWriteFilePattern.SET_OF_OBJECTS
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonWriteSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonWriteSettings.yml
deleted file mode 100644
index 606ee536cdb7..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonWriteSettings.yml
+++ /dev/null
@@ -1,47 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.JsonWriteSettings
-name: JsonWriteSettings
-fullName: azure.synapse.artifacts.models.JsonWriteSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.FormatWriteSettings
-summary: 'Json write settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'JsonWriteSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, file_pattern: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: file_pattern
- description: 'File pattern of JSON. This setting controls the way a collection
- of JSON
-
- objects will be treated. The default value is ''setOfObjects''. It is case-sensitive.'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The write setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'File pattern of JSON. This setting controls the way a collection of
- JSON
-
- objects will be treated. The default value is ''setOfObjects''. It is case-sensitive.'
- name: file_pattern
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.KqlScript.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.KqlScript.yml
deleted file mode 100644
index 31b3fad9a30f..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.KqlScript.yml
+++ /dev/null
@@ -1,19 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.KqlScript
-name: KqlScript
-fullName: azure.synapse.artifacts.models.KqlScript
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: KqlScript.
-constructor:
- syntax: 'KqlScript(*, content: _models.KqlScriptContent | None = None, **kwargs:
- Any)'
- parameters:
- - name: content
- types:
- - <xref:azure.synapse.artifacts.models.KqlScriptContent>
-variables:
-- name: content
- types:
- - <xref:azure.synapse.artifacts.models.KqlScriptContent>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.KqlScriptContent.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.KqlScriptContent.yml
deleted file mode 100644
index e8021df54552..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.KqlScriptContent.yml
+++ /dev/null
@@ -1,32 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.KqlScriptContent
-name: KqlScriptContent
-fullName: azure.synapse.artifacts.models.KqlScriptContent
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: KqlScriptContent.
-constructor:
- syntax: 'KqlScriptContent(*, query: str | None = None, metadata: _models.KqlScriptContentMetadata
- | None = None, current_connection: _models.KqlScriptContentCurrentConnection |
- None = None, **kwargs: Any)'
- parameters:
- - name: query
- types:
- - <xref:str>
- - name: metadata
- types:
- - <xref:azure.synapse.artifacts.models.KqlScriptContentMetadata>
- - name: current_connection
- types:
- - <xref:azure.synapse.artifacts.models.KqlScriptContentCurrentConnection>
-variables:
-- name: query
- types:
- - <xref:str>
-- name: metadata
- types:
- - <xref:azure.synapse.artifacts.models.KqlScriptContentMetadata>
-- name: current_connection
- types:
- - <xref:azure.synapse.artifacts.models.KqlScriptContentCurrentConnection>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.KqlScriptContentCurrentConnection.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.KqlScriptContentCurrentConnection.yml
deleted file mode 100644
index 282ddc4a5e22..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.KqlScriptContentCurrentConnection.yml
+++ /dev/null
@@ -1,38 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.KqlScriptContentCurrentConnection
-name: KqlScriptContentCurrentConnection
-fullName: azure.synapse.artifacts.models.KqlScriptContentCurrentConnection
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: KqlScriptContentCurrentConnection.
-constructor:
- syntax: 'KqlScriptContentCurrentConnection(*, name: str | None = None, pool_name:
- str | None = None, database_name: str | None = None, type: str | None = None,
- **kwargs: Any)'
- parameters:
- - name: name
- types:
- - <xref:str>
- - name: pool_name
- types:
- - <xref:str>
- - name: database_name
- types:
- - <xref:str>
- - name: type
- types:
- - <xref:str>
-variables:
-- name: name
- types:
- - <xref:str>
-- name: pool_name
- types:
- - <xref:str>
-- name: database_name
- types:
- - <xref:str>
-- name: type
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.KqlScriptContentMetadata.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.KqlScriptContentMetadata.yml
deleted file mode 100644
index 60d2ecc48188..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.KqlScriptContentMetadata.yml
+++ /dev/null
@@ -1,18 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.KqlScriptContentMetadata
-name: KqlScriptContentMetadata
-fullName: azure.synapse.artifacts.models.KqlScriptContentMetadata
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: KqlScriptContentMetadata.
-constructor:
- syntax: 'KqlScriptContentMetadata(*, language: str | None = None, **kwargs: Any)'
- parameters:
- - name: language
- types:
- - <xref:str>
-variables:
-- name: language
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.KqlScriptResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.KqlScriptResource.yml
deleted file mode 100644
index c541970772b1..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.KqlScriptResource.yml
+++ /dev/null
@@ -1,39 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.KqlScriptResource
-name: KqlScriptResource
-fullName: azure.synapse.artifacts.models.KqlScriptResource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: KqlScriptResource.
-constructor:
- syntax: 'KqlScriptResource(*, id: str | None = None, name: str | None = None, type:
- str | None = None, properties: _models.KqlScript | None = None, **kwargs: Any)'
- parameters:
- - name: id
- types:
- - <xref:str>
- - name: name
- types:
- - <xref:str>
- - name: type
- types:
- - <xref:str>
- - name: properties
- description: Properties of sql script.
- types:
- - <xref:azure.synapse.artifacts.models.KqlScript>
-variables:
-- name: id
- types:
- - <xref:str>
-- name: name
- types:
- - <xref:str>
-- name: type
- types:
- - <xref:str>
-- description: Properties of sql script.
- name: properties
- types:
- - <xref:azure.synapse.artifacts.models.KqlScript>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.KqlScriptsResourceCollectionResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.KqlScriptsResourceCollectionResponse.yml
deleted file mode 100644
index 81beab4cef3b..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.KqlScriptsResourceCollectionResponse.yml
+++ /dev/null
@@ -1,25 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.KqlScriptsResourceCollectionResponse
-name: KqlScriptsResourceCollectionResponse
-fullName: azure.synapse.artifacts.models.KqlScriptsResourceCollectionResponse
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: KqlScriptsResourceCollectionResponse.
-constructor:
- syntax: 'KqlScriptsResourceCollectionResponse(*, value: List[_models.KqlScriptResource]
- | None = None, next_link: str | None = None, **kwargs: Any)'
- parameters:
- - name: value
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.KqlScriptResource>]
- - name: next_link
- types:
- - <xref:str>
-variables:
-- name: value
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.KqlScriptResource>]
-- name: next_link
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LibraryInfo.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LibraryInfo.yml
deleted file mode 100644
index 88b5f1de12fd..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LibraryInfo.yml
+++ /dev/null
@@ -1,65 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LibraryInfo
-name: LibraryInfo
-fullName: azure.synapse.artifacts.models.LibraryInfo
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Library/package information of a Big Data pool powered by Apache Spark.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.'
-constructor:
- syntax: 'LibraryInfo(*, name: str | None = None, path: str | None = None, container_name:
- str | None = None, uploaded_timestamp: datetime | None = None, type: str | None
- = None, **kwargs: Any)'
- parameters:
- - name: name
- description: Name of the library.
- types:
- - <xref:str>
- - name: path
- description: Storage blob path of library.
- types:
- - <xref:str>
- - name: container_name
- description: Storage blob container name.
- types:
- - <xref:str>
- - name: uploaded_timestamp
- description: The last update time of the library.
- types:
- - <xref:datetime.datetime>
- - name: type
- description: Type of the library.
- types:
- - <xref:str>
-variables:
-- description: Name of the library.
- name: name
- types:
- - <xref:str>
-- description: Storage blob path of library.
- name: path
- types:
- - <xref:str>
-- description: Storage blob container name.
- name: container_name
- types:
- - <xref:str>
-- description: The last update time of the library.
- name: uploaded_timestamp
- types:
- - <xref:datetime.datetime>
-- description: Type of the library.
- name: type
- types:
- - <xref:str>
-- description: Provisioning status of the library/package.
- name: provisioning_status
- types:
- - <xref:str>
-- description: Creator Id of the library/package.
- name: creator_id
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LibraryListResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LibraryListResponse.yml
deleted file mode 100644
index e70f7edf1a45..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LibraryListResponse.yml
+++ /dev/null
@@ -1,32 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LibraryListResponse
-name: LibraryListResponse
-fullName: azure.synapse.artifacts.models.LibraryListResponse
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'A list of Library resources.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'LibraryListResponse(*, value: List[_models.LibraryResource], next_link:
- str | None = None, **kwargs: Any)'
- parameters:
- - name: value
- description: List of Library. Required.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.LibraryResource>]
- - name: next_link
- description: The link to the next page of results, if any remaining results exist.
- types:
- - <xref:str>
-variables:
-- description: List of Library. Required.
- name: value
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.LibraryResource>]
-- description: The link to the next page of results, if any remaining results exist.
- name: next_link
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LibraryRequirements.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LibraryRequirements.yml
deleted file mode 100644
index d8b1e1d889c0..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LibraryRequirements.yml
+++ /dev/null
@@ -1,36 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LibraryRequirements
-name: LibraryRequirements
-fullName: azure.synapse.artifacts.models.LibraryRequirements
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Library requirements for a Big Data pool powered by Apache Spark.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.'
-constructor:
- syntax: 'LibraryRequirements(*, content: str | None = None, filename: str | None
- = None, **kwargs: Any)'
- parameters:
- - name: content
- description: The library requirements.
- types:
- - <xref:str>
- - name: filename
- description: The filename of the library requirements file.
- types:
- - <xref:str>
-variables:
-- description: The last update time of the library requirements file.
- name: time
- types:
- - <xref:datetime.datetime>
-- description: The library requirements.
- name: content
- types:
- - <xref:str>
-- description: The filename of the library requirements file.
- name: filename
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LibraryResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LibraryResource.yml
deleted file mode 100644
index ad1495d667fb..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LibraryResource.yml
+++ /dev/null
@@ -1,48 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LibraryResource
-name: LibraryResource
-fullName: azure.synapse.artifacts.models.LibraryResource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.SubResource
-summary: 'Library response 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: 'LibraryResource(*, properties: _models.LibraryResourceProperties, **kwargs:
- Any)'
- parameters:
- - name: properties
- description: Library/package properties. Required.
- types:
- - <xref:azure.synapse.artifacts.models.LibraryResourceProperties>
-variables:
-- description: 'Fully qualified resource ID for the resource. Ex -
-
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.'
- name: id
- types:
- - <xref:str>
-- description: The name of the resource.
- name: name
- types:
- - <xref:str>
-- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines"
- or
-
- "Microsoft.Storage/storageAccounts".'
- name: type
- types:
- - <xref:str>
-- description: Resource Etag.
- name: etag
- types:
- - <xref:str>
-- description: Library/package properties. Required.
- name: properties
- types:
- - <xref:azure.synapse.artifacts.models.LibraryResourceProperties>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LibraryResourceInfo.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LibraryResourceInfo.yml
deleted file mode 100644
index b4808852286e..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LibraryResourceInfo.yml
+++ /dev/null
@@ -1,52 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LibraryResourceInfo
-name: LibraryResourceInfo
-fullName: azure.synapse.artifacts.models.LibraryResourceInfo
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Library resource info.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.'
-constructor:
- syntax: 'LibraryResourceInfo(**kwargs: Any)'
-variables:
-- description: 'Fully qualified resource ID for the resource. Ex -
-
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.'
- name: id
- types:
- - <xref:str>
-- description: record Id of the library/package.
- name: record_id
- types:
- - <xref:int>
-- description: Provisioning status of the library/package.
- name: state
- types:
- - <xref:str>
-- description: The creation time of the library/package.
- name: created
- types:
- - <xref:str>
-- description: The last updated time of the library/package.
- name: changed
- types:
- - <xref:str>
-- description: The type of the resource. E.g. LibraryArtifact.
- name: type
- types:
- - <xref:str>
-- description: Name of the library/package.
- name: name
- types:
- - <xref:str>
-- description: Operation Id of the operation performed on library/package.
- name: operation_id
- types:
- - <xref:str>
-- description: artifact Id of the library/package.
- name: artifact_id
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LibraryResourceProperties.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LibraryResourceProperties.yml
deleted file mode 100644
index dd4b64a7785c..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LibraryResourceProperties.yml
+++ /dev/null
@@ -1,42 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LibraryResourceProperties
-name: LibraryResourceProperties
-fullName: azure.synapse.artifacts.models.LibraryResourceProperties
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Library/package properties.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.'
-constructor:
- syntax: 'LibraryResourceProperties(**kwargs: Any)'
-variables:
-- description: Name of the library/package.
- name: name
- types:
- - <xref:str>
-- description: Location of library/package in storage account.
- name: path
- types:
- - <xref:str>
-- description: Container name of the library/package.
- name: container_name
- types:
- - <xref:str>
-- description: The last update time of the library/package.
- name: uploaded_timestamp
- types:
- - <xref:str>
-- description: Type of the library/package.
- name: type
- types:
- - <xref:str>
-- description: Provisioning status of the library/package.
- name: provisioning_status
- types:
- - <xref:str>
-- description: Creator Id of the library/package.
- name: creator_id
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnection.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnection.yml
deleted file mode 100644
index 0e6d91630ac8..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnection.yml
+++ /dev/null
@@ -1,47 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LinkConnection
-name: LinkConnection
-fullName: azure.synapse.artifacts.models.LinkConnection
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: LinkConnection.
-constructor:
- syntax: 'LinkConnection(*, source_database: _models.LinkConnectionSourceDatabase
- | None = None, target_database: _models.LinkConnectionTargetDatabase | None =
- None, landing_zone: _models.LinkConnectionLandingZone | None = None, compute:
- _models.LinkConnectionCompute | None = None, **kwargs: Any)'
- parameters:
- - name: source_database
- description: Properties of link connection's source database.
- types:
- - <xref:azure.synapse.artifacts.models.LinkConnectionSourceDatabase>
- - name: target_database
- description: Properties of link connection's target database.
- types:
- - <xref:azure.synapse.artifacts.models.LinkConnectionTargetDatabase>
- - name: landing_zone
- description: Properties of link connection's landing zone.
- types:
- - <xref:azure.synapse.artifacts.models.LinkConnectionLandingZone>
- - name: compute
- description: Properties of link connection's compute.
- types:
- - <xref:azure.synapse.artifacts.models.LinkConnectionCompute>
-variables:
-- description: Properties of link connection's source database.
- name: source_database
- types:
- - <xref:azure.synapse.artifacts.models.LinkConnectionSourceDatabase>
-- description: Properties of link connection's target database.
- name: target_database
- types:
- - <xref:azure.synapse.artifacts.models.LinkConnectionTargetDatabase>
-- description: Properties of link connection's landing zone.
- name: landing_zone
- types:
- - <xref:azure.synapse.artifacts.models.LinkConnectionLandingZone>
-- description: Properties of link connection's compute.
- name: compute
- types:
- - <xref:azure.synapse.artifacts.models.LinkConnectionCompute>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionCompute.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionCompute.yml
deleted file mode 100644
index a62374520dc7..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionCompute.yml
+++ /dev/null
@@ -1,37 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LinkConnectionCompute
-name: LinkConnectionCompute
-fullName: azure.synapse.artifacts.models.LinkConnectionCompute
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: LinkConnectionCompute.
-constructor:
- syntax: 'LinkConnectionCompute(*, core_count: int | None = None, compute_type: str
- | None = None, data_process_interval_minutes: int | None = None, **kwargs: Any)'
- parameters:
- - name: core_count
- description: Compute core count used by the link connection.
- types:
- - <xref:int>
- - name: compute_type
- description: Link connection's compute type.
- types:
- - <xref:str>
- - name: data_process_interval_minutes
- description: Link connection's data process interval in minutes.
- types:
- - <xref:int>
-variables:
-- description: Compute core count used by the link connection.
- name: core_count
- types:
- - <xref:int>
-- description: Link connection's compute type.
- name: compute_type
- types:
- - <xref:str>
-- description: Link connection's data process interval in minutes.
- name: data_process_interval_minutes
- types:
- - <xref:int>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionDetailedStatus.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionDetailedStatus.yml
deleted file mode 100644
index d8fa7c3b0feb..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionDetailedStatus.yml
+++ /dev/null
@@ -1,112 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LinkConnectionDetailedStatus
-name: LinkConnectionDetailedStatus
-fullName: azure.synapse.artifacts.models.LinkConnectionDetailedStatus
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: LinkConnectionDetailedStatus.
-constructor:
- syntax: 'LinkConnectionDetailedStatus(*, id: str | None = None, name: str | None
- = None, is_applying_changes: bool | None = None, is_partially_failed: bool | None
- = None, start_time: MutableMapping[str, Any] | None = None, stop_time: MutableMapping[str,
- Any] | None = None, status: str | None = None, continuous_run_id: str | None =
- None, error: MutableMapping[str, Any] | None = None, refresh_status: _models.LinkConnectionRefreshStatus
- | None = None, landing_zone_credential_expire_time: datetime | None = None, **kwargs:
- Any)'
- parameters:
- - name: id
- description: Link connection id.
- types:
- - <xref:str>
- - name: name
- description: Link connection name.
- types:
- - <xref:str>
- - name: is_applying_changes
- description: Is link connection applying changes.
- types:
- - <xref:bool>
- - name: is_partially_failed
- description: Is link connection partially failed.
- types:
- - <xref:bool>
- - name: start_time
- description: Link connection start time.
- types:
- - <xref:JSON>
- - name: stop_time
- description: Link connection stop time.
- types:
- - <xref:JSON>
- - name: status
- description: 'Link connection status, please refer to this [articles](https://learn.microsoft.com/azure/synapse-analytics/synapse-link/sql-database-synapse-link#monitoring)
-
- for details.'
- types:
- - <xref:str>
- - name: continuous_run_id
- description: Link connection's corresponding continuous run id.
- types:
- - <xref:str>
- - name: error
- description: Link connection error.
- types:
- - <xref:JSON>
- - name: refresh_status
- description: Link connection refresh status.
- types:
- - <xref:azure.synapse.artifacts.models.LinkConnectionRefreshStatus>
- - name: landing_zone_credential_expire_time
- description: 'Link connection landing zone credential expire
-
- time.'
- types:
- - <xref:datetime.datetime>
-variables:
-- description: Link connection id.
- name: id
- types:
- - <xref:str>
-- description: Link connection name.
- name: name
- types:
- - <xref:str>
-- description: Is link connection applying changes.
- name: is_applying_changes
- types:
- - <xref:bool>
-- description: Is link connection partially failed.
- name: is_partially_failed
- types:
- - <xref:bool>
-- description: Link connection start time.
- name: start_time
- types:
- - <xref:JSON>
-- description: Link connection stop time.
- name: stop_time
- types:
- - <xref:JSON>
-- description: 'Link connection status, please refer to this [articles](https://learn.microsoft.com/azure/synapse-analytics/synapse-link/sql-database-synapse-link#monitoring)
-
- for details.'
- name: status
- types:
- - <xref:str>
-- description: Link connection's corresponding continuous run id.
- name: continuous_run_id
- types:
- - <xref:str>
-- description: Link connection error.
- name: error
- types:
- - <xref:JSON>
-- description: Link connection refresh status.
- name: refresh_status
- types:
- - <xref:azure.synapse.artifacts.models.LinkConnectionRefreshStatus>
-- description: Link connection landing zone credential expire time.
- name: landing_zone_credential_expire_time
- types:
- - <xref:datetime.datetime>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionLandingZone.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionLandingZone.yml
deleted file mode 100644
index aba7cbb0e91b..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionLandingZone.yml
+++ /dev/null
@@ -1,46 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LinkConnectionLandingZone
-name: LinkConnectionLandingZone
-fullName: azure.synapse.artifacts.models.LinkConnectionLandingZone
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: LinkConnectionLandingZone.
-constructor:
- syntax: 'LinkConnectionLandingZone(*, linked_service: _models.LinkedServiceReference
- | None = None, file_system: str | None = None, folder_path: str | None = None,
- sas_token: _models.SecureString | None = None, **kwargs: Any)'
- parameters:
- - name: linked_service
- description: Linked service reference.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: file_system
- description: Landing zone's file system name.
- types:
- - <xref:str>
- - name: folder_path
- description: Landing zone's folder path name.
- types:
- - <xref:str>
- - name: sas_token
- description: Landing zone's sas token.
- types:
- - <xref:azure.synapse.artifacts.models.SecureString>
-variables:
-- description: Linked service reference.
- name: linked_service
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Landing zone's file system name.
- name: file_system
- types:
- - <xref:str>
-- description: Landing zone's folder path name.
- name: folder_path
- types:
- - <xref:str>
-- description: Landing zone's sas token.
- name: sas_token
- types:
- - <xref:azure.synapse.artifacts.models.SecureString>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionListResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionListResponse.yml
deleted file mode 100644
index 3afc853ff061..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionListResponse.yml
+++ /dev/null
@@ -1,32 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LinkConnectionListResponse
-name: LinkConnectionListResponse
-fullName: azure.synapse.artifacts.models.LinkConnectionListResponse
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'LinkConnectionListResponse.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'LinkConnectionListResponse(*, value: List[_models.LinkConnectionResource],
- next_link: str | None = None, **kwargs: Any)'
- parameters:
- - name: value
- description: List link connection value. Required.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.LinkConnectionResource>]
- - name: next_link
- description: List link connections next link.
- types:
- - <xref:str>
-variables:
-- description: List link connection value. Required.
- name: value
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.LinkConnectionResource>]
-- description: List link connections next link.
- name: next_link
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionQueryTableStatus.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionQueryTableStatus.yml
deleted file mode 100644
index 4c91c9195ca3..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionQueryTableStatus.yml
+++ /dev/null
@@ -1,30 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LinkConnectionQueryTableStatus
-name: LinkConnectionQueryTableStatus
-fullName: azure.synapse.artifacts.models.LinkConnectionQueryTableStatus
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: LinkConnectionQueryTableStatus.
-constructor:
- syntax: 'LinkConnectionQueryTableStatus(*, value: List[_models.LinkTableStatus]
- | None = None, continuation_token: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
- parameters:
- - name: value
- description: Link tables' status.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.LinkTableStatus>]
- - name: continuation_token
- description: Continuation token to query table status.
- types:
- - <xref:JSON>
-variables:
-- description: Link tables' status.
- name: value
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.LinkTableStatus>]
-- description: Continuation token to query table status.
- name: continuation_token
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionRefreshStatus.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionRefreshStatus.yml
deleted file mode 100644
index 4aa653d6f0b6..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionRefreshStatus.yml
+++ /dev/null
@@ -1,22 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LinkConnectionRefreshStatus
-name: LinkConnectionRefreshStatus
-fullName: azure.synapse.artifacts.models.LinkConnectionRefreshStatus
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'LinkConnectionRefreshStatus.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.'
-constructor:
- syntax: 'LinkConnectionRefreshStatus(**kwargs: Any)'
-variables:
-- description: Link connection refresh status.
- name: refresh_status
- types:
- - <xref:str>
-- description: Link connection refresh error message.
- name: error_message
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionResource.yml
deleted file mode 100644
index 678efbf015b8..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionResource.yml
+++ /dev/null
@@ -1,57 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LinkConnectionResource
-name: LinkConnectionResource
-fullName: azure.synapse.artifacts.models.LinkConnectionResource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'LinkConnectionResource.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'LinkConnectionResource(*, properties: _models.LinkConnection, id: str |
- None = None, name: str | None = None, type: str | None = None, description: str
- | None = None, **kwargs: Any)'
- parameters:
- - name: id
- description: Link connection id.
- types:
- - <xref:str>
- - name: name
- description: Link connection name.
- types:
- - <xref:str>
- - name: type
- description: Link connection type.
- types:
- - <xref:str>
- - name: properties
- description: Properties of link connection. Required.
- types:
- - <xref:azure.synapse.artifacts.models.LinkConnection>
- - name: description
- description: Link connection description.
- types:
- - <xref:str>
-variables:
-- description: Link connection id.
- name: id
- types:
- - <xref:str>
-- description: Link connection name.
- name: name
- types:
- - <xref:str>
-- description: Link connection type.
- name: type
- types:
- - <xref:str>
-- description: Properties of link connection. Required.
- name: properties
- types:
- - <xref:azure.synapse.artifacts.models.LinkConnection>
-- description: Link connection description.
- name: description
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionSourceDatabase.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionSourceDatabase.yml
deleted file mode 100644
index d09ea41d2015..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionSourceDatabase.yml
+++ /dev/null
@@ -1,30 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LinkConnectionSourceDatabase
-name: LinkConnectionSourceDatabase
-fullName: azure.synapse.artifacts.models.LinkConnectionSourceDatabase
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: LinkConnectionSourceDatabase.
-constructor:
- syntax: 'LinkConnectionSourceDatabase(*, linked_service: _models.LinkedServiceReference
- | None = None, type_properties: _models.LinkConnectionSourceDatabaseTypeProperties
- | None = None, **kwargs: Any)'
- parameters:
- - name: linked_service
- description: Linked service reference.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: type_properties
- description: Source database type properties.
- types:
- - <xref:azure.synapse.artifacts.models.LinkConnectionSourceDatabaseTypeProperties>
-variables:
-- description: Linked service reference.
- name: linked_service
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Source database type properties.
- name: type_properties
- types:
- - <xref:azure.synapse.artifacts.models.LinkConnectionSourceDatabaseTypeProperties>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionSourceDatabaseTypeProperties.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionSourceDatabaseTypeProperties.yml
deleted file mode 100644
index a6e17b94aa51..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionSourceDatabaseTypeProperties.yml
+++ /dev/null
@@ -1,29 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LinkConnectionSourceDatabaseTypeProperties
-name: LinkConnectionSourceDatabaseTypeProperties
-fullName: azure.synapse.artifacts.models.LinkConnectionSourceDatabaseTypeProperties
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: LinkConnectionSourceDatabaseTypeProperties.
-constructor:
- syntax: 'LinkConnectionSourceDatabaseTypeProperties(*, resource_id: str | None =
- None, principal_id: str | None = None, **kwargs: Any)'
- parameters:
- - name: resource_id
- description: Link connection source database server's resource id.
- types:
- - <xref:str>
- - name: principal_id
- description: Link connection source database server's principal id.
- types:
- - <xref:str>
-variables:
-- description: Link connection source database server's resource id.
- name: resource_id
- types:
- - <xref:str>
-- description: Link connection source database server's principal id.
- name: principal_id
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionTargetDatabase.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionTargetDatabase.yml
deleted file mode 100644
index df09cac0c3fe..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionTargetDatabase.yml
+++ /dev/null
@@ -1,30 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LinkConnectionTargetDatabase
-name: LinkConnectionTargetDatabase
-fullName: azure.synapse.artifacts.models.LinkConnectionTargetDatabase
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: LinkConnectionTargetDatabase.
-constructor:
- syntax: 'LinkConnectionTargetDatabase(*, linked_service: _models.LinkedServiceReference
- | None = None, type_properties: _models.LinkConnectionTargetDatabaseTypeProperties
- | None = None, **kwargs: Any)'
- parameters:
- - name: linked_service
- description: Linked service reference.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: type_properties
- description: Target database type properties.
- types:
- - <xref:azure.synapse.artifacts.models.LinkConnectionTargetDatabaseTypeProperties>
-variables:
-- description: Linked service reference.
- name: linked_service
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Target database type properties.
- name: type_properties
- types:
- - <xref:azure.synapse.artifacts.models.LinkConnectionTargetDatabaseTypeProperties>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionTargetDatabaseTypeProperties.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionTargetDatabaseTypeProperties.yml
deleted file mode 100644
index 3c06fbe38fad..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkConnectionTargetDatabaseTypeProperties.yml
+++ /dev/null
@@ -1,54 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LinkConnectionTargetDatabaseTypeProperties
-name: LinkConnectionTargetDatabaseTypeProperties
-fullName: azure.synapse.artifacts.models.LinkConnectionTargetDatabaseTypeProperties
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: LinkConnectionTargetDatabaseTypeProperties.
-constructor:
- syntax: 'LinkConnectionTargetDatabaseTypeProperties(*, cross_table_transaction:
- bool | None = None, drop_existing_target_table_on_start: bool | None = None, action_on_existing_target_table:
- str | _models.ActionOnExistingTargetTable | None = None, **kwargs: Any)'
- parameters:
- - name: cross_table_transaction
- description: 'Enable cross table transaction consistency on target
-
- database.'
- types:
- - <xref:bool>
- - name: drop_existing_target_table_on_start
- description: 'Drop and recreate same existing target table on
-
- link connection target database.'
- types:
- - <xref:bool>
- - name: action_on_existing_target_table
- description: 'Action on existing target table. If not specified,
-
- ''FailOnNonEmptyTable'' action is used. Known values are: "FailOnNonEmptyTable",
-
- "DropAndRecreateTable", and "MergeWithExistingData".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActionOnExistingTargetTable>
-variables:
-- description: Enable cross table transaction consistency on target database.
- name: cross_table_transaction
- types:
- - <xref:bool>
-- description: 'Drop and recreate same existing target table on link
-
- connection target database.'
- name: drop_existing_target_table_on_start
- types:
- - <xref:bool>
-- description: 'Action on existing target table. If not specified,
-
- ''FailOnNonEmptyTable'' action is used. Known values are: "FailOnNonEmptyTable",
-
- "DropAndRecreateTable", and "MergeWithExistingData".'
- name: action_on_existing_target_table
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActionOnExistingTargetTable>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableListResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableListResponse.yml
deleted file mode 100644
index f41f194cfee1..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableListResponse.yml
+++ /dev/null
@@ -1,21 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LinkTableListResponse
-name: LinkTableListResponse
-fullName: azure.synapse.artifacts.models.LinkTableListResponse
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: LinkTableListResponse.
-constructor:
- syntax: 'LinkTableListResponse(*, value: List[_models.LinkTableResource] | None
- = None, **kwargs: Any)'
- parameters:
- - name: value
- description: List link table value.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.LinkTableResource>]
-variables:
-- description: List link table value.
- name: value
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.LinkTableResource>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableRequest.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableRequest.yml
deleted file mode 100644
index e3c687925bbf..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableRequest.yml
+++ /dev/null
@@ -1,46 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LinkTableRequest
-name: LinkTableRequest
-fullName: azure.synapse.artifacts.models.LinkTableRequest
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: LinkTableRequest.
-constructor:
- syntax: 'LinkTableRequest(*, id: str | None = None, source: _models.LinkTableRequestSource
- | None = None, target: _models.LinkTableRequestTarget | None = None, operation_type:
- str | None = None, **kwargs: Any)'
- parameters:
- - name: id
- description: Link table id.
- types:
- - <xref:str>
- - name: source
- description: Source table properties for link table request.
- types:
- - <xref:azure.synapse.artifacts.models.LinkTableRequestSource>
- - name: target
- description: Target table properties for link table request.
- types:
- - <xref:azure.synapse.artifacts.models.LinkTableRequestTarget>
- - name: operation_type
- description: Link table operation type.
- types:
- - <xref:str>
-variables:
-- description: Link table id.
- name: id
- types:
- - <xref:str>
-- description: Source table properties for link table request.
- name: source
- types:
- - <xref:azure.synapse.artifacts.models.LinkTableRequestSource>
-- description: Target table properties for link table request.
- name: target
- types:
- - <xref:azure.synapse.artifacts.models.LinkTableRequestTarget>
-- description: Link table operation type.
- name: operation_type
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableRequestSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableRequestSource.yml
deleted file mode 100644
index f7478778d52a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableRequestSource.yml
+++ /dev/null
@@ -1,29 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LinkTableRequestSource
-name: LinkTableRequestSource
-fullName: azure.synapse.artifacts.models.LinkTableRequestSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: LinkTableRequestSource.
-constructor:
- syntax: 'LinkTableRequestSource(*, table_name: str | None = None, schema_name: str
- | None = None, **kwargs: Any)'
- parameters:
- - name: table_name
- description: Source table table name.
- types:
- - <xref:str>
- - name: schema_name
- description: Source table schema name.
- types:
- - <xref:str>
-variables:
-- description: Source table table name.
- name: table_name
- types:
- - <xref:str>
-- description: Source table schema name.
- name: schema_name
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableRequestTarget.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableRequestTarget.yml
deleted file mode 100644
index c117f9dda476..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableRequestTarget.yml
+++ /dev/null
@@ -1,47 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LinkTableRequestTarget
-name: LinkTableRequestTarget
-fullName: azure.synapse.artifacts.models.LinkTableRequestTarget
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: LinkTableRequestTarget.
-constructor:
- syntax: 'LinkTableRequestTarget(*, table_name: str | None = None, schema_name: str
- | None = None, distribution_options: _models.LinkTableRequestTargetDistributionOptions
- | None = None, structure_options: _models.LinkTableRequestTargetStructureOptions
- | None = None, **kwargs: Any)'
- parameters:
- - name: table_name
- description: Target table table name.
- types:
- - <xref:str>
- - name: schema_name
- description: Target table schema name.
- types:
- - <xref:str>
- - name: distribution_options
- description: Target table distribution options for link table request.
- types:
- - <xref:azure.synapse.artifacts.models.LinkTableRequestTargetDistributionOptions>
- - name: structure_options
- description: Target table structure options for link table request.
- types:
- - <xref:azure.synapse.artifacts.models.LinkTableRequestTargetStructureOptions>
-variables:
-- description: Target table table name.
- name: table_name
- types:
- - <xref:str>
-- description: Target table schema name.
- name: schema_name
- types:
- - <xref:str>
-- description: Target table distribution options for link table request.
- name: distribution_options
- types:
- - <xref:azure.synapse.artifacts.models.LinkTableRequestTargetDistributionOptions>
-- description: Target table structure options for link table request.
- name: structure_options
- types:
- - <xref:azure.synapse.artifacts.models.LinkTableRequestTargetStructureOptions>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableRequestTargetDistributionOptions.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableRequestTargetDistributionOptions.yml
deleted file mode 100644
index 375688f1f18a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableRequestTargetDistributionOptions.yml
+++ /dev/null
@@ -1,29 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LinkTableRequestTargetDistributionOptions
-name: LinkTableRequestTargetDistributionOptions
-fullName: azure.synapse.artifacts.models.LinkTableRequestTargetDistributionOptions
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: LinkTableRequestTargetDistributionOptions.
-constructor:
- syntax: 'LinkTableRequestTargetDistributionOptions(*, type: str | None = None, distribution_column:
- str | None = None, **kwargs: Any)'
- parameters:
- - name: type
- description: Target table distribution type.
- types:
- - <xref:str>
- - name: distribution_column
- description: Target table distribution column.
- types:
- - <xref:str>
-variables:
-- description: Target table distribution type.
- name: type
- types:
- - <xref:str>
-- description: Target table distribution column.
- name: distribution_column
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableRequestTargetStructureOptions.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableRequestTargetStructureOptions.yml
deleted file mode 100644
index ce66fa7cf8c4..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableRequestTargetStructureOptions.yml
+++ /dev/null
@@ -1,21 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LinkTableRequestTargetStructureOptions
-name: LinkTableRequestTargetStructureOptions
-fullName: azure.synapse.artifacts.models.LinkTableRequestTargetStructureOptions
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: LinkTableRequestTargetStructureOptions.
-constructor:
- syntax: 'LinkTableRequestTargetStructureOptions(*, type: str | None = None, **kwargs:
- Any)'
- parameters:
- - name: type
- description: Target table structure type.
- types:
- - <xref:str>
-variables:
-- description: Target table structure type.
- name: type
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableResource.yml
deleted file mode 100644
index 39140e9b9a1d..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableResource.yml
+++ /dev/null
@@ -1,46 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LinkTableResource
-name: LinkTableResource
-fullName: azure.synapse.artifacts.models.LinkTableResource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: LinkTableResource.
-constructor:
- syntax: 'LinkTableResource(*, id: str | None = None, name: str | None = None, source:
- _models.LinkTableRequestSource | None = None, target: _models.LinkTableRequestTarget
- | None = None, **kwargs: Any)'
- parameters:
- - name: id
- description: Link table id.
- types:
- - <xref:str>
- - name: name
- description: Link table name.
- types:
- - <xref:str>
- - name: source
- description: Source table properties for link table request.
- types:
- - <xref:azure.synapse.artifacts.models.LinkTableRequestSource>
- - name: target
- description: Target table properties for link table request.
- types:
- - <xref:azure.synapse.artifacts.models.LinkTableRequestTarget>
-variables:
-- description: Link table id.
- name: id
- types:
- - <xref:str>
-- description: Link table name.
- name: name
- types:
- - <xref:str>
-- description: Source table properties for link table request.
- name: source
- types:
- - <xref:azure.synapse.artifacts.models.LinkTableRequestSource>
-- description: Target table properties for link table request.
- name: target
- types:
- - <xref:azure.synapse.artifacts.models.LinkTableRequestTarget>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableStatus.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableStatus.yml
deleted file mode 100644
index b449c1f31dc8..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkTableStatus.yml
+++ /dev/null
@@ -1,92 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LinkTableStatus
-name: LinkTableStatus
-fullName: azure.synapse.artifacts.models.LinkTableStatus
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: LinkTableStatus.
-constructor:
- syntax: 'LinkTableStatus(*, id: str | None = None, status: str | None = None, error_message:
- str | None = None, start_time: MutableMapping[str, Any] | None = None, stop_time:
- MutableMapping[str, Any] | None = None, link_table_id: str | None = None, error_code:
- str | None = None, last_processed_data: datetime | None = None, last_transaction_commit_time:
- datetime | None = None, **kwargs: Any)'
- parameters:
- - name: id
- description: ID provided by the client.
- types:
- - <xref:str>
- - name: status
- description: 'Link table status, please refer to this [articles](https://learn.microsoft.com/azure/synapse-analytics/synapse-link/sql-database-synapse-link#monitoring)
-
- for details.'
- types:
- - <xref:str>
- - name: error_message
- description: Link table error message.
- types:
- - <xref:str>
- - name: start_time
- description: Link table start time.
- types:
- - <xref:JSON>
- - name: stop_time
- description: Link table stop time.
- types:
- - <xref:JSON>
- - name: link_table_id
- description: Link table ID.
- types:
- - <xref:str>
- - name: error_code
- description: Link table error code.
- types:
- - <xref:str>
- - name: last_processed_data
- description: Link table last processed data time.
- types:
- - <xref:datetime.datetime>
- - name: last_transaction_commit_time
- description: Link table last transaction commit time.
- types:
- - <xref:datetime.datetime>
-variables:
-- description: ID provided by the client.
- name: id
- types:
- - <xref:str>
-- description: 'Link table status, please refer to this [articles](https://learn.microsoft.com/azure/synapse-analytics/synapse-link/sql-database-synapse-link#monitoring)
-
- for details.'
- name: status
- types:
- - <xref:str>
-- description: Link table error message.
- name: error_message
- types:
- - <xref:str>
-- description: Link table start time.
- name: start_time
- types:
- - <xref:JSON>
-- description: Link table stop time.
- name: stop_time
- types:
- - <xref:JSON>
-- description: Link table ID.
- name: link_table_id
- types:
- - <xref:str>
-- description: Link table error code.
- name: error_code
- types:
- - <xref:str>
-- description: Link table last processed data time.
- name: last_processed_data
- types:
- - <xref:datetime.datetime>
-- description: Link table last transaction commit time.
- name: last_transaction_commit_time
- types:
- - <xref:datetime.datetime>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedIntegrationRuntimeKeyAuthorization.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedIntegrationRuntimeKeyAuthorization.yml
deleted file mode 100644
index 3a1ce8cca5c8..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedIntegrationRuntimeKeyAuthorization.yml
+++ /dev/null
@@ -1,28 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LinkedIntegrationRuntimeKeyAuthorization
-name: LinkedIntegrationRuntimeKeyAuthorization
-fullName: azure.synapse.artifacts.models.LinkedIntegrationRuntimeKeyAuthorization
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.LinkedIntegrationRuntimeType
-summary: 'The key authorization type integration runtime.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'LinkedIntegrationRuntimeKeyAuthorization(*, key: _models.SecureString,
- **kwargs: Any)'
- parameters:
- - name: key
- description: The key used for authorization. Required.
- types:
- - <xref:azure.synapse.artifacts.models.SecureString>
-variables:
-- description: The authorization type for integration runtime sharing. Required.
- name: authorization_type
- types:
- - <xref:str>
-- description: The key used for authorization. Required.
- name: key
- types:
- - <xref:azure.synapse.artifacts.models.SecureString>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedIntegrationRuntimeRbacAuthorization.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedIntegrationRuntimeRbacAuthorization.yml
deleted file mode 100644
index 6becedc4dc2f..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedIntegrationRuntimeRbacAuthorization.yml
+++ /dev/null
@@ -1,30 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LinkedIntegrationRuntimeRbacAuthorization
-name: LinkedIntegrationRuntimeRbacAuthorization
-fullName: azure.synapse.artifacts.models.LinkedIntegrationRuntimeRbacAuthorization
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.LinkedIntegrationRuntimeType
-summary: 'The role based access control (RBAC) authorization type integration runtime.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'LinkedIntegrationRuntimeRbacAuthorization(*, resource_id: str, **kwargs:
- Any)'
- parameters:
- - name: resource_id
- description: 'The resource identifier of the integration runtime to be shared.
-
- Required.'
- types:
- - <xref:str>
-variables:
-- description: The authorization type for integration runtime sharing. Required.
- name: authorization_type
- types:
- - <xref:str>
-- description: The resource identifier of the integration runtime to be shared. Required.
- name: resource_id
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedIntegrationRuntimeType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedIntegrationRuntimeType.yml
deleted file mode 100644
index c93060459699..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedIntegrationRuntimeType.yml
+++ /dev/null
@@ -1,24 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LinkedIntegrationRuntimeType
-name: LinkedIntegrationRuntimeType
-fullName: azure.synapse.artifacts.models.LinkedIntegrationRuntimeType
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'The base definition of a linked integration runtime.
-
-
- You probably want to use the sub-classes and not this class directly. Known sub-classes
- are:
-
- LinkedIntegrationRuntimeKeyAuthorization, LinkedIntegrationRuntimeRbacAuthorization
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'LinkedIntegrationRuntimeType(**kwargs: Any)'
-variables:
-- description: The authorization type for integration runtime sharing. Required.
- name: authorization_type
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedService.yml
index 88f1ac642276..f75f6a368c22 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedService.yml
@@ -4,141 +4,77 @@ name: LinkedService
fullName: azure.synapse.artifacts.models.LinkedService
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'The Azure Synapse nested object which contains the information and credential
- which can be used
+ which can be used to connect with related store or compute resource.
- to connect with related store or compute resource.
+ You probably want to use the sub-classes and not this class directly. Known
- You probably want to use the sub-classes and not this class directly. Known sub-classes
- are:
-
- AmazonMWSLinkedService, AmazonRdsForOracleLinkedService, AmazonRdsForSqlServerLinkedService,
-
- AmazonRedshiftLinkedService, AmazonS3LinkedService, AppFiguresLinkedService,
-
- AsanaLinkedService, AzureBatchLinkedService, AzureBlobFSLinkedService,
-
- AzureBlobStorageLinkedService, AzureDataExplorerLinkedService,
-
- AzureDataLakeAnalyticsLinkedService, AzureDataLakeStoreLinkedService,
-
- AzureDatabricksLinkedService, AzureDatabricksDeltaLakeLinkedService,
-
- AzureFileStorageLinkedService, AzureFunctionLinkedService, AzureKeyVaultLinkedService,
-
- AzureMLLinkedService, AzureMLServiceLinkedService, AzureMariaDBLinkedService,
-
+ 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, AzureSynapseArtifactsLinkedService, AzureTableStorageLinkedService,
-
- CassandraLinkedService, CommonDataServiceForAppsLinkedService, ConcurLinkedService,
-
- CosmosDbLinkedService, CosmosDbMongoDbApiLinkedService, CouchbaseLinkedService,
-
- CustomDataSourceLinkedService, DataworldLinkedService, Db2LinkedService, DrillLinkedService,
-
- DynamicsLinkedService, DynamicsAXLinkedService, DynamicsCrmLinkedService, EloquaLinkedService,
-
- FileServerLinkedService, FtpServerLinkedService, GoogleAdWordsLinkedService,
-
- GoogleBigQueryLinkedService, GoogleCloudStorageLinkedService, GoogleSheetsLinkedService,
-
- GreenplumLinkedService, HBaseLinkedService, HDInsightLinkedService,
-
- HDInsightOnDemandLinkedService, HdfsLinkedService, HiveLinkedService, HttpLinkedService,
-
- HubspotLinkedService, ImpalaLinkedService, InformixLinkedService, JiraLinkedService,
-
- MagentoLinkedService, MariaDBLinkedService, MarketoLinkedService, MicrosoftAccessLinkedService,
-
- MongoDbLinkedService, MongoDbAtlasLinkedService, MongoDbV2LinkedService, MySqlLinkedService,
-
- NetezzaLinkedService, ODataLinkedService, OdbcLinkedService, Office365LinkedService,
-
- OracleLinkedService, OracleServiceCloudLinkedService, PaypalLinkedService,
-
- PhoenixLinkedService, PostgreSqlLinkedService, PowerBIWorkspaceLinkedService,
-
- PrestoLinkedService, QuickBooksLinkedService, QuickbaseLinkedService, ResponsysLinkedService,
-
- RestServiceLinkedService, SalesforceLinkedService, SalesforceMarketingCloudLinkedService,
-
+ 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, SapOdpLinkedService, SapOpenHubLinkedService,
-
- SapTableLinkedService, ServiceNowLinkedService, SftpServerLinkedService,
-
- SharePointOnlineListLinkedService, ShopifyLinkedService, SmartsheetLinkedService,
-
- SnowflakeLinkedService, SparkLinkedService, SqlServerLinkedService, SquareLinkedService,
-
- SybaseLinkedService, TeamDeskLinkedService, TeradataLinkedService, TwilioLinkedService,
-
- VerticaLinkedService, WebLinkedService, XeroLinkedService, ZendeskLinkedService,
-
- ZohoLinkedService
+ 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, MutableMapping[str, Any]]
- | None = None, connect_via: _models.IntegrationRuntimeReference | None = None,
- description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, **kwargs:
- Any)'
+ 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:
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceDebugResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceDebugResource.yml
index b046f1922a01..4929466d6929 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceDebugResource.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceDebugResource.yml
@@ -10,23 +10,16 @@ summary: 'Linked service debug resource.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'LinkedServiceDebugResource(*, properties: _models.LinkedService, name:
- str | None = None, **kwargs: Any)'
+ syntax: 'LinkedServiceDebugResource(*, properties: LinkedService, name: str | None
+ = None, **kwargs)'
parameters:
- name: name
description: The resource name.
+ isRequired: true
types:
- <xref:str>
- name: properties
- description: Properties of linked service. Required.
+ description: Required. Properties of linked service.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedService>
-variables:
-- description: The resource name.
- name: name
- types:
- - <xref:str>
-- description: Properties of linked service. Required.
- name: properties
- types:
- - <xref:azure.synapse.artifacts.models.LinkedService>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceListResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceListResponse.yml
index 87855942cd28..70e880493ced 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceListResponse.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceListResponse.yml
@@ -4,29 +4,22 @@ name: LinkedServiceListResponse
fullName: azure.synapse.artifacts.models.LinkedServiceListResponse
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'A list of linked service resources.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'LinkedServiceListResponse(*, value: List[_models.LinkedServiceResource],
- next_link: str | None = None, **kwargs: Any)'
+ syntax: 'LinkedServiceListResponse(*, value: List[LinkedServiceResource], next_link:
+ str | None = None, **kwargs)'
parameters:
- name: value
- description: List of linked services. Required.
+ description: Required. List of linked services.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.LinkedServiceResource>]
- name: next_link
description: The link to the next page of results, if any remaining results exist.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: List of linked services. Required.
- name: value
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.LinkedServiceResource>]
-- description: The link to the next page of results, if any remaining results exist.
- name: next_link
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceReference.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceReference.yml
index 9951916045ee..e28251ef6624 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceReference.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceReference.yml
@@ -4,39 +4,34 @@ name: LinkedServiceReference
fullName: azure.synapse.artifacts.models.LinkedServiceReference
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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(*, type: str | _models.Type, reference_name: str,
- parameters: Dict[str, MutableMapping[str, Any]] | None = None, **kwargs: Any)'
+ syntax: 'LinkedServiceReference(*, reference_name: str, parameters: Dict[str, object]
+ | None = None, **kwargs)'
parameters:
- - name: type
- description: Linked service reference type. Required. "LinkedServiceReference"
- types:
- - <xref:str>
- - <xref:typing.Type>
- name: reference_name
- description: Reference LinkedService name. Required.
+ description: Required. Reference LinkedService name.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Arguments for LinkedService.
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
variables:
-- description: Linked service reference type. Required. "LinkedServiceReference"
+- description: 'Required. Linked service reference type. Default value: "LinkedServiceReference".'
name: type
types:
- <xref:str>
- - <xref:typing.Type>
-- description: Reference LinkedService name. Required.
- name: reference_name
- types:
- - <xref:str>
-- description: Arguments for LinkedService.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+attributes:
+- uid: azure.synapse.artifacts.models.LinkedServiceReference.type
+ name: type
+ signature: type = 'LinkedServiceReference'
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceResource.yml
index bd880555e562..b11afdaa5561 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceResource.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceResource.yml
@@ -13,35 +13,27 @@ summary: 'Linked service resource type.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'LinkedServiceResource(*, properties: _models.LinkedService, **kwargs: Any)'
+ syntax: 'LinkedServiceResource(*, properties: LinkedService, **kwargs)'
parameters:
- name: properties
- description: Properties of linked service. Required.
+ description: Required. Properties of linked service.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedService>
variables:
-- description: 'Fully qualified resource ID for the resource. Ex -
-
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.'
+- description: The resource identifier.
name: id
types:
- <xref:str>
-- description: The name of the resource.
+- description: The resource name.
name: name
types:
- <xref:str>
-- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines"
- or
-
- "Microsoft.Storage/storageAccounts".'
+- description: The resource type.
name: type
types:
- <xref:str>
-- description: Resource Etag.
+- description: Etag identifies change in the resource.
name: etag
types:
- <xref:str>
-- description: Properties of linked service. Required.
- name: properties
- types:
- - <xref:azure.synapse.artifacts.models.LinkedService>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LivyStates.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LivyStates.yml
deleted file mode 100644
index d90b213e42b5..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LivyStates.yml
+++ /dev/null
@@ -1,35 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.LivyStates
-name: LivyStates
-fullName: azure.synapse.artifacts.models.LivyStates
-summary: The batch state.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: LivyStates(value, names=None, *, module=None, qualname=None, type=None,
- start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: BUSY
- uid: azure.synapse.artifacts.models.LivyStates.BUSY
-- name: DEAD
- uid: azure.synapse.artifacts.models.LivyStates.DEAD
-- name: ERROR
- uid: azure.synapse.artifacts.models.LivyStates.ERROR
-- name: IDLE
- uid: azure.synapse.artifacts.models.LivyStates.IDLE
-- name: KILLED
- uid: azure.synapse.artifacts.models.LivyStates.KILLED
-- name: NOT_STARTED
- uid: azure.synapse.artifacts.models.LivyStates.NOT_STARTED
-- name: RECOVERING
- uid: azure.synapse.artifacts.models.LivyStates.RECOVERING
-- name: RUNNING
- uid: azure.synapse.artifacts.models.LivyStates.RUNNING
-- name: SHUTTING_DOWN
- uid: azure.synapse.artifacts.models.LivyStates.SHUTTING_DOWN
-- name: STARTING
- uid: azure.synapse.artifacts.models.LivyStates.STARTING
-- name: SUCCESS
- uid: azure.synapse.artifacts.models.LivyStates.SUCCESS
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LogLocationSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LogLocationSettings.yml
deleted file mode 100644
index 29a3b66808ed..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LogLocationSettings.yml
+++ /dev/null
@@ -1,38 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LogLocationSettings
-name: LogLocationSettings
-fullName: azure.synapse.artifacts.models.LogLocationSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Log location settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'LogLocationSettings(*, linked_service_name: _models.LinkedServiceReference,
- path: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: linked_service_name
- description: Log storage linked service reference. Required.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: path
- description: 'The path to storage for storing detailed logs of activity execution.
- Type:
-
- string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: Log storage linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: 'The path to storage for storing detailed logs of activity execution.
- Type: string
-
- (or Expression with resultType string).'
- name: path
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LogSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LogSettings.yml
deleted file mode 100644
index 245063fee15c..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LogSettings.yml
+++ /dev/null
@@ -1,49 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.LogSettings
-name: LogSettings
-fullName: azure.synapse.artifacts.models.LogSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Log settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'LogSettings(*, log_location_settings: _models.LogLocationSettings, enable_copy_activity_log:
- MutableMapping[str, Any] | None = None, copy_activity_log_settings: _models.CopyActivityLogSettings
- | None = None, **kwargs: Any)'
- parameters:
- - name: enable_copy_activity_log
- description: 'Specifies whether to enable copy activity log. Type: boolean
-
- (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: copy_activity_log_settings
- description: Specifies settings for copy activity log.
- types:
- - <xref:azure.synapse.artifacts.models.CopyActivityLogSettings>
- - name: log_location_settings
- description: 'Log location settings customer needs to provide when enabling
-
- log. Required.'
- types:
- - <xref:azure.synapse.artifacts.models.LogLocationSettings>
-variables:
-- description: 'Specifies whether to enable copy activity log. Type: boolean
-
- (or Expression with resultType boolean).'
- name: enable_copy_activity_log
- types:
- - <xref:JSON>
-- description: Specifies settings for copy activity log.
- name: copy_activity_log_settings
- types:
- - <xref:azure.synapse.artifacts.models.CopyActivityLogSettings>
-- description: 'Log location settings customer needs to provide when enabling log.
-
- Required.'
- name: log_location_settings
- types:
- - <xref:azure.synapse.artifacts.models.LogLocationSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LogStorageSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LogStorageSettings.yml
index 4c502f99c218..068e2c9d4035 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LogStorageSettings.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LogStorageSettings.yml
@@ -4,75 +4,32 @@ name: LogStorageSettings
fullName: azure.synapse.artifacts.models.LogStorageSettings
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: '(Deprecated. Please use LogSettings) Log storage settings.
+- msrest.serialization.Model
+summary: 'Log storage settings.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'LogStorageSettings(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, path:
- MutableMapping[str, Any] | None = None, log_level: MutableMapping[str, Any] |
- None = None, enable_reliable_logging: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: linked_service_name
- description: Log storage linked service reference. Required.
+ description: Required. Log storage linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: path
description: 'The path to storage for storing detailed logs of activity execution.
- Type:
+ Type: string
- string (or Expression with resultType string).'
+ (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
- - name: log_level
- description: 'Gets or sets the log level, support: Info, Warning. Type: string
- (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: enable_reliable_logging
- description: 'Specifies whether to enable reliable logging. Type: boolean
-
- (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Log storage linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: 'The path to storage for storing detailed logs of activity execution.
- Type: string
-
- (or Expression with resultType string).'
- name: path
- types:
- - <xref:JSON>
-- description: 'Gets or sets the log level, support: Info, Warning. Type: string (or
-
- Expression with resultType string).'
- name: log_level
- types:
- - <xref:JSON>
-- description: 'Specifies whether to enable reliable logging. Type: boolean (or
-
- Expression with resultType boolean).'
- name: enable_reliable_logging
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LookupActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LookupActivity.yml
index c41ee278c5d6..98ba0a54e244 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LookupActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LookupActivity.yml
@@ -10,70 +10,63 @@ summary: 'Lookup activity.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'LookupActivity(*, name: str, source: _models.CopySource, dataset: _models.DatasetReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, state: str | _models.ActivityState | None = None, on_inactive_mark_as:
- str | _models.ActivityOnInactiveMarkAs | None = None, depends_on: List[_models.ActivityDependency]
- | None = None, user_properties: List[_models.UserProperty] | None = None, linked_service_name:
- _models.LinkedServiceReference | None = None, policy: _models.ActivityPolicy |
- None = None, first_row_only: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
- name: source
- description: Dataset-specific source properties, same as copy activity source.
- Required.
+ description: Required. Dataset-specific source properties, same as copy activity
+ source.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.CopySource>
- name: dataset
- description: Lookup activity dataset reference. Required.
+ description: Required. Lookup activity dataset reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetReference>
- name: first_row_only
@@ -81,72 +74,6 @@ constructor:
Type:
boolean (or Expression with resultType boolean).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: Dataset-specific source properties, same as copy activity source. Required.
- name: source
- types:
- - <xref:azure.synapse.artifacts.models.CopySource>
-- description: Lookup activity dataset reference. Required.
- name: dataset
- types:
- - <xref:azure.synapse.artifacts.models.DatasetReference>
-- description: 'Whether to return first row or all rows. Default value is true. Type:
-
- boolean (or Expression with resultType boolean).'
- name: first_row_only
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoLinkedService.yml
index a427d849e076..1bf3f4fa2371 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoLinkedService.yml
@@ -10,52 +10,63 @@ summary: 'Magento server linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'MagentoLinkedService(*, host: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, access_token:
- _models.SecretBase | None = None, use_encrypted_endpoints: MutableMapping[str,
- Any] | None = None, use_host_verification: MutableMapping[str, Any] | None = None,
- use_peer_verification: MutableMapping[str, Any] | None = None, encrypted_credential:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: host
- description: The URL of the Magento instance. (i.e. 192.168.222.110/magento3).
- Required.
+ description: Required. The URL of the Magento instance. (i.e. 192.168.222.110/magento3).
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: access_token
description: The access token from Magento.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: use_encrypted_endpoints
- description: 'Specifies whether the data source endpoints are encrypted
+ description: 'Specifies whether the data source endpoints are encrypted using
- using HTTPS. The default value is true.'
+ HTTPS. The default value is true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_host_verification
description: 'Specifies whether to require the host name in the server''s
@@ -63,85 +74,23 @@ constructor:
default value is
true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The URL of the Magento instance. (i.e. 192.168.222.110/magento3). Required.
- name: host
- types:
- - <xref:JSON>
-- description: The access token from Magento.
- name: access_token
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Specifies whether the data source endpoints are encrypted using
-
- HTTPS. The default value is true.'
- name: use_encrypted_endpoints
- types:
- - <xref:JSON>
-- 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.'
- name: use_host_verification
- types:
- - <xref:JSON>
-- description: 'Specifies whether to verify the identity of the server when
-
- connecting over SSL. The default value is true.'
- name: use_peer_verification
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoObjectDataset.yml
index 8b7c569b05a5..e4fd85d7cc21 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoObjectDataset.yml
@@ -10,109 +10,70 @@ summary: 'Magento server dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'MagentoObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The table name. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoSource.yml
deleted file mode 100644
index 4b30a31d5e03..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.MagentoSource
-name: MagentoSource
-fullName: azure.synapse.artifacts.models.MagentoSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Magento server source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'MagentoSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ManagedIdentity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ManagedIdentity.yml
deleted file mode 100644
index 5cc4cdfe025e..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ManagedIdentity.yml
+++ /dev/null
@@ -1,40 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ManagedIdentity
-name: ManagedIdentity
-fullName: azure.synapse.artifacts.models.ManagedIdentity
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'The workspace managed identity.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.'
-constructor:
- syntax: 'ManagedIdentity(*, type: str | _models.ResourceIdentityType | None = None,
- **kwargs: Any)'
- parameters:
- - name: type
- description: 'The type of managed identity for the workspace. Known values are:
- "None" and
-
- "SystemAssigned".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ResourceIdentityType>
-variables:
-- description: The principal ID of the workspace managed identity.
- name: principal_id
- types:
- - <xref:str>
-- description: The tenant ID of the workspace managed identity.
- name: tenant_id
- types:
- - <xref:str>
-- description: 'The type of managed identity for the workspace. Known values are:
- "None" and
-
- "SystemAssigned".'
- name: type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ResourceIdentityType>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ManagedIntegrationRuntime.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ManagedIntegrationRuntime.yml
deleted file mode 100644
index 9e13e6aa298c..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ManagedIntegrationRuntime.yml
+++ /dev/null
@@ -1,87 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ManagedIntegrationRuntime
-name: ManagedIntegrationRuntime
-fullName: azure.synapse.artifacts.models.ManagedIntegrationRuntime
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.IntegrationRuntime
-summary: 'Managed integration runtime, including managed elastic and managed dedicated
- integration
-
- runtimes.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ManagedIntegrationRuntime(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, managed_virtual_network:
- _models.ManagedVirtualNetworkReference | None = None, compute_properties: _models.IntegrationRuntimeComputeProperties
- | None = None, ssis_properties: _models.IntegrationRuntimeSsisProperties | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Integration runtime description.
- types:
- - <xref:str>
- - name: managed_virtual_network
- description: Managed Virtual Network reference.
- types:
- - <xref:azure.synapse.artifacts.models.ManagedVirtualNetworkReference>
- - name: compute_properties
- description: The compute resource for managed integration runtime.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeComputeProperties>
- - name: ssis_properties
- description: SSIS properties for managed integration runtime.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeSsisProperties>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: 'Type of integration runtime. Required. Known values are: "Managed"
- and
-
- "SelfHosted".'
- name: type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeType>
-- description: Integration runtime description.
- name: description
- types:
- - <xref:str>
-- description: 'Integration runtime state, only valid for managed dedicated integration
- runtime.
-
- Known values are: "Initial", "Stopped", "Started", "Starting", "Stopping", "NeedRegistration",
-
- "Online", "Limited", "Offline", and "AccessDenied".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeState>
-- description: Managed Virtual Network reference.
- name: managed_virtual_network
- types:
- - <xref:azure.synapse.artifacts.models.ManagedVirtualNetworkReference>
-- description: The compute resource for managed integration runtime.
- name: compute_properties
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeComputeProperties>
-- description: SSIS properties for managed integration runtime.
- name: ssis_properties
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeSsisProperties>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ManagedVirtualNetworkReference.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ManagedVirtualNetworkReference.yml
deleted file mode 100644
index ed5812bc39db..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ManagedVirtualNetworkReference.yml
+++ /dev/null
@@ -1,36 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ManagedVirtualNetworkReference
-name: ManagedVirtualNetworkReference
-fullName: azure.synapse.artifacts.models.ManagedVirtualNetworkReference
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Managed Virtual Network reference type.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ManagedVirtualNetworkReference(*, type: str | _models.ManagedVirtualNetworkReferenceType,
- reference_name: str, **kwargs: Any)'
- parameters:
- - name: type
- description: 'Managed Virtual Network reference type. Required.
-
- "ManagedVirtualNetworkReference"'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ManagedVirtualNetworkReferenceType>
- - name: reference_name
- description: Reference ManagedVirtualNetwork name. Required.
- types:
- - <xref:str>
-variables:
-- description: Managed Virtual Network reference type. Required. "ManagedVirtualNetworkReference"
- name: type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ManagedVirtualNetworkReferenceType>
-- description: Reference ManagedVirtualNetwork name. Required.
- name: reference_name
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ManagedVirtualNetworkReferenceType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ManagedVirtualNetworkReferenceType.yml
deleted file mode 100644
index bfce32bebfad..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ManagedVirtualNetworkReferenceType.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.ManagedVirtualNetworkReferenceType
-name: ManagedVirtualNetworkReferenceType
-fullName: azure.synapse.artifacts.models.ManagedVirtualNetworkReferenceType
-summary: Managed Virtual Network reference type.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: ManagedVirtualNetworkReferenceType(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: MANAGED_VIRTUAL_NETWORK_REFERENCE
- uid: azure.synapse.artifacts.models.ManagedVirtualNetworkReferenceType.MANAGED_VIRTUAL_NETWORK_REFERENCE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ManagedVirtualNetworkSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ManagedVirtualNetworkSettings.yml
deleted file mode 100644
index 1e1b0b5e22b6..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ManagedVirtualNetworkSettings.yml
+++ /dev/null
@@ -1,38 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ManagedVirtualNetworkSettings
-name: ManagedVirtualNetworkSettings
-fullName: azure.synapse.artifacts.models.ManagedVirtualNetworkSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Managed Virtual Network Settings.
-constructor:
- syntax: 'ManagedVirtualNetworkSettings(*, prevent_data_exfiltration: bool | None
- = None, linked_access_check_on_target_resource: bool | None = None, allowed_aad_tenant_ids_for_linking:
- List[str] | None = None, **kwargs: Any)'
- parameters:
- - name: prevent_data_exfiltration
- description: Prevent Data Exfiltration.
- types:
- - <xref:bool>
- - name: linked_access_check_on_target_resource
- description: Linked Access Check On Target Resource.
- types:
- - <xref:bool>
- - name: allowed_aad_tenant_ids_for_linking
- description: Allowed Aad Tenant Ids For Linking.
- types:
- - <xref:list>[<xref:str>]
-variables:
-- description: Prevent Data Exfiltration.
- name: prevent_data_exfiltration
- types:
- - <xref:bool>
-- description: Linked Access Check On Target Resource.
- name: linked_access_check_on_target_resource
- types:
- - <xref:bool>
-- description: Allowed Aad Tenant Ids For Linking.
- name: allowed_aad_tenant_ids_for_linking
- types:
- - <xref:list>[<xref:str>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MappingDataFlow.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MappingDataFlow.yml
index 023d57691504..de4be0c7eac1 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MappingDataFlow.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MappingDataFlow.yml
@@ -10,84 +10,51 @@ 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[MutableMapping[str,
- Any]] | None = None, folder: _models.DataFlowFolder | None = None, sources: List[_models.DataFlowSource]
- | None = None, sinks: List[_models.DataFlowSink] | None = None, transformations:
- List[_models.Transformation] | None = None, script: str | None = None, script_lines:
- List[str] | None = None, **kwargs: Any)'
+ 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:
+ - <xref:str>
- name: description
description: The description of the data flow.
+ isRequired: true
types:
- <xref:str>
- name: annotations
description: List of tags that can be used for describing the data flow.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this data flow is in. If not specified, Data flow
- will appear
+ will appear at
- at the root level.'
+ the root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DataFlowFolder>
- name: sources
description: List of sources in data flow.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.DataFlowSource>]
- name: sinks
description: List of sinks in data flow.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.DataFlowSink>]
- name: transformations
description: List of transformations in data flow.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.Transformation>]
- name: script
description: DataFlow script.
+ isRequired: true
types:
- <xref:str>
- - name: script_lines
- description: Data flow script lines.
- types:
- - <xref:list>[<xref:str>]
-variables:
-- description: Type of data flow. Required.
- name: type
- types:
- - <xref:str>
-- description: The description of the data flow.
- name: description
- types:
- - <xref:str>
-- description: List of tags that can be used for describing the data flow.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this data flow is in. If not specified, Data flow
- will appear at
-
- the root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DataFlowFolder>
-- description: List of sources in data flow.
- name: sources
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DataFlowSource>]
-- description: List of sinks in data flow.
- name: sinks
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DataFlowSink>]
-- description: List of transformations in data flow.
- name: transformations
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.Transformation>]
-- description: DataFlow script.
- name: script
- types:
- - <xref:str>
-- description: Data flow script lines.
- name: script_lines
- types:
- - <xref:list>[<xref:str>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBLinkedService.yml
index 944a271c78c4..d6583c80ed5b 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBLinkedService.yml
@@ -10,98 +10,63 @@ summary: 'MariaDB server linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'MariaDBLinkedService(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, connection_string:
- MutableMapping[str, Any] | None = None, pwd: _models.AzureKeyVaultSecretReference
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
description: 'An ODBC connection string. Type: string, SecureString or
AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: pwd
description: The Azure key vault secret reference of password in connection string.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'An ODBC connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of password in connection string.
- name: pwd
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBSource.yml
deleted file mode 100644
index 1dd53260316a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.MariaDBSource
-name: MariaDBSource
-fullName: azure.synapse.artifacts.models.MariaDBSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity MariaDB server source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'MariaDBSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBTableDataset.yml
index b786daede275..836b1573bdbb 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBTableDataset.yml
@@ -10,109 +10,70 @@ summary: 'MariaDB server dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'MariaDBTableDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The table name. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoLinkedService.yml
index 9856e1fd8d73..44b9096cb0d2 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoLinkedService.yml
@@ -10,58 +10,68 @@ summary: 'Marketo server linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'MarketoLinkedService(*, endpoint: MutableMapping[str, Any], client_id:
- MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, client_secret:
- _models.SecretBase | None = None, use_encrypted_endpoints: MutableMapping[str,
- Any] | None = None, use_host_verification: MutableMapping[str, Any] | None = None,
- use_peer_verification: MutableMapping[str, Any] | None = None, encrypted_credential:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: endpoint
- description: 'The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com).
-
- Required.'
+ description: Required. The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com).
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: client_id
- description: The client Id of your Marketo service. Required.
+ description: Required. The client Id of your Marketo service.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: client_secret
description: The client secret of your Marketo service.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: use_encrypted_endpoints
- description: 'Specifies whether the data source endpoints are encrypted
+ description: 'Specifies whether the data source endpoints are encrypted using
- using HTTPS. The default value is true.'
+ HTTPS. The default value is true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_host_verification
description: 'Specifies whether to require the host name in the server''s
@@ -69,90 +79,23 @@ constructor:
default value is
true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com).
- Required.
- name: endpoint
- types:
- - <xref:JSON>
-- description: The client Id of your Marketo service. Required.
- name: client_id
- types:
- - <xref:JSON>
-- description: The client secret of your Marketo service.
- name: client_secret
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Specifies whether the data source endpoints are encrypted using
-
- HTTPS. The default value is true.'
- name: use_encrypted_endpoints
- types:
- - <xref:JSON>
-- 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.'
- name: use_host_verification
- types:
- - <xref:JSON>
-- description: 'Specifies whether to verify the identity of the server when
-
- connecting over SSL. The default value is true.'
- name: use_peer_verification
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoObjectDataset.yml
index ac565c4db2b4..210e644ae776 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoObjectDataset.yml
@@ -10,109 +10,70 @@ summary: 'Marketo server dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'MarketoObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The table name. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoSource.yml
deleted file mode 100644
index bd8f71d91212..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.MarketoSource
-name: MarketoSource
-fullName: azure.synapse.artifacts.models.MarketoSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Marketo server source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'MarketoSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MetastoreRegisterObject.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MetastoreRegisterObject.yml
deleted file mode 100644
index ce267aef8c11..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MetastoreRegisterObject.yml
+++ /dev/null
@@ -1,23 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.MetastoreRegisterObject
-name: MetastoreRegisterObject
-fullName: azure.synapse.artifacts.models.MetastoreRegisterObject
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'MetastoreRegisterObject.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'MetastoreRegisterObject(*, input_folder: str, **kwargs: Any)'
- parameters:
- - name: input_folder
- description: The input folder containing CDM files. Required.
- types:
- - <xref:str>
-variables:
-- description: The input folder containing CDM files. Required.
- name: input_folder
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MetastoreRegistrationResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MetastoreRegistrationResponse.yml
deleted file mode 100644
index c6fb1b9bb7da..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MetastoreRegistrationResponse.yml
+++ /dev/null
@@ -1,28 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.MetastoreRegistrationResponse
-name: MetastoreRegistrationResponse
-fullName: azure.synapse.artifacts.models.MetastoreRegistrationResponse
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: MetastoreRegistrationResponse.
-constructor:
- syntax: 'MetastoreRegistrationResponse(*, status: str | _models.RequestStatus |
- None = None, **kwargs: Any)'
- parameters:
- - name: status
- description: 'Enumerates possible request statuses. Known values are: "Running",
-
- "Completed", and "Failed".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.RequestStatus>
-variables:
-- description: 'Enumerates possible request statuses. Known values are: "Running",
- "Completed",
-
- and "Failed".'
- name: status
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.RequestStatus>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MetastoreRequestSuccessResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MetastoreRequestSuccessResponse.yml
deleted file mode 100644
index abdd2ee780ed..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MetastoreRequestSuccessResponse.yml
+++ /dev/null
@@ -1,27 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.MetastoreRequestSuccessResponse
-name: MetastoreRequestSuccessResponse
-fullName: azure.synapse.artifacts.models.MetastoreRequestSuccessResponse
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: MetastoreRequestSuccessResponse.
-constructor:
- syntax: 'MetastoreRequestSuccessResponse(*, status: str | _models.ResourceStatus
- | None = None, **kwargs: Any)'
- parameters:
- - name: status
- description: 'Enumerates possible Status of the resource. Known values are: "Creating",
-
- "Created", and "Failed".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ResourceStatus>
-variables:
-- description: 'Enumerates possible Status of the resource. Known values are: "Creating",
-
- "Created", and "Failed".'
- name: status
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ResourceStatus>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MetastoreUpdateObject.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MetastoreUpdateObject.yml
deleted file mode 100644
index f3c9d4ff2b03..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MetastoreUpdateObject.yml
+++ /dev/null
@@ -1,23 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.MetastoreUpdateObject
-name: MetastoreUpdateObject
-fullName: azure.synapse.artifacts.models.MetastoreUpdateObject
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'MetastoreUpdateObject.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'MetastoreUpdateObject(*, input_folder: str, **kwargs: Any)'
- parameters:
- - name: input_folder
- description: The input folder containing CDM files. Required.
- types:
- - <xref:str>
-variables:
-- description: The input folder containing CDM files. Required.
- name: input_folder
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MetastoreUpdationResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MetastoreUpdationResponse.yml
deleted file mode 100644
index 9af60b3853b7..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MetastoreUpdationResponse.yml
+++ /dev/null
@@ -1,28 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.MetastoreUpdationResponse
-name: MetastoreUpdationResponse
-fullName: azure.synapse.artifacts.models.MetastoreUpdationResponse
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: MetastoreUpdationResponse.
-constructor:
- syntax: 'MetastoreUpdationResponse(*, status: str | _models.RequestStatus | None
- = None, **kwargs: Any)'
- parameters:
- - name: status
- description: 'Enumerates possible request statuses. Known values are: "Running",
-
- "Completed", and "Failed".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.RequestStatus>
-variables:
-- description: 'Enumerates possible request statuses. Known values are: "Running",
- "Completed",
-
- and "Failed".'
- name: status
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.RequestStatus>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessLinkedService.yml
index c6de1f67920f..636e03958feb 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessLinkedService.yml
@@ -10,46 +10,55 @@ summary: 'Microsoft Access linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'MicrosoftAccessLinkedService(*, connection_string: MutableMapping[str,
- Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- connect_via: _models.IntegrationRuntimeReference | None = None, description: str
- | None = None, parameters: Dict[str, _models.ParameterSpecification] | None =
- None, annotations: List[MutableMapping[str, Any]] | None = None, authentication_type:
- MutableMapping[str, Any] | None = None, credential: _models.SecretBase | None
- = None, user_name: MutableMapping[str, Any] | None = None, password: _models.SecretBase
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
- description: 'The non-access credential portion of the connection string as well
+ description: 'Required. The non-access credential portion of the connection string
- as an optional encrypted credential. Type: string, SecureString or
+ as well as an optional encrypted credential. Type: string, SecureString or
- AzureKeyVaultSecretReference. Required.'
+ AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: authentication_type
description: 'Type of authentication used to connect to the Microsoft Access as
@@ -57,13 +66,15 @@ constructor:
Expression with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: credential
description: 'The access credential portion of the connection string specified
- in
+ in driver-
- driver-specific property-value format.'
+ specific property-value format.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: user_name
@@ -71,88 +82,21 @@ constructor:
with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: Password for Basic authentication.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The non-access credential portion of the connection string as well
- as
-
- an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.
-
- Required.'
- name: connection_string
- types:
- - <xref:JSON>
-- 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).'
- name: authentication_type
- types:
- - <xref:JSON>
-- description: 'The access credential portion of the connection string specified in
-
- driver-specific property-value format.'
- name: credential
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'User name for Basic authentication. Type: string (or Expression with
-
- resultType string).'
- name: user_name
- types:
- - <xref:JSON>
-- description: Password for Basic authentication.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessSink.yml
deleted file mode 100644
index 8bb7275251b1..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessSink.yml
+++ /dev/null
@@ -1,108 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.MicrosoftAccessSink
-name: MicrosoftAccessSink
-fullName: azure.synapse.artifacts.models.MicrosoftAccessSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Microsoft Access sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'MicrosoftAccessSink(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, write_batch_size: MutableMapping[str, Any] | None = None,
- write_batch_timeout: MutableMapping[str, Any] | None = None, sink_retry_count:
- MutableMapping[str, Any] | None = None, sink_retry_wait: MutableMapping[str, Any]
- | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None,
- pre_copy_script: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: pre_copy_script
- description: 'A query to execute before starting the copy. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'A query to execute before starting the copy. Type: string (or Expression
-
- with resultType string).'
- name: pre_copy_script
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessSource.yml
deleted file mode 100644
index 031a8e81e9bf..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessSource.yml
+++ /dev/null
@@ -1,93 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.MicrosoftAccessSource
-name: MicrosoftAccessSource
-fullName: azure.synapse.artifacts.models.MicrosoftAccessSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity source for Microsoft Access.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'MicrosoftAccessSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, additional_columns: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query
- description: 'Database query. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Database query. Type: string (or Expression with resultType string).'
- name: query
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessTableDataset.yml
index 082e8405551c..ad49a0c3c7a3 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessTableDataset.yml
@@ -10,114 +10,74 @@ summary: 'The Microsoft Access table dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'MicrosoftAccessTableDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The Microsoft Access table name. Type: string (or Expression with
+ resultType
- resultType string).'
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The Microsoft Access table name. Type: string (or Expression with
- resultType
-
- string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbAtlasCollectionDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbAtlasCollectionDataset.yml
deleted file mode 100644
index 40c81a542041..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbAtlasCollectionDataset.yml
+++ /dev/null
@@ -1,122 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.MongoDbAtlasCollectionDataset
-name: MongoDbAtlasCollectionDataset
-fullName: azure.synapse.artifacts.models.MongoDbAtlasCollectionDataset
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.Dataset
-summary: 'The MongoDB Atlas database dataset.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'MongoDbAtlasCollectionDataset(*, linked_service_name: _models.LinkedServiceReference,
- collection: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, structure: MutableMapping[str,
- Any] | None = None, schema: MutableMapping[str, Any] | None = None, parameters:
- Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str,
- Any]] | None = None, folder: _models.DatasetFolder | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Dataset description.
- types:
- - <xref:str>
- - name: structure
- description: 'Columns that define the structure of the dataset. Type: array (or
-
- Expression with resultType array), itemType: DatasetDataElement.'
- types:
- - <xref:JSON>
- - name: schema
- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- types:
- - <xref:JSON>
- - name: linked_service_name
- description: Linked service reference. Required.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: parameters
- description: Parameters for dataset.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the Dataset.
- types:
- - <xref:list>[<xref:JSON>]
- - name: folder
- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
-
- the root level.'
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
- - name: collection
- description: 'The collection name of the MongoDB Atlas database. Type: string
- (or
-
- Expression with resultType string). Required.'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The collection name of the MongoDB Atlas database. Type: string (or
-
- Expression with resultType string). Required.'
- name: collection
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbAtlasLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbAtlasLinkedService.yml
deleted file mode 100644
index 75b6b32897c9..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbAtlasLinkedService.yml
+++ /dev/null
@@ -1,113 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.MongoDbAtlasLinkedService
-name: MongoDbAtlasLinkedService
-fullName: azure.synapse.artifacts.models.MongoDbAtlasLinkedService
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.LinkedService
-summary: 'Linked service for MongoDB Atlas data source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'MongoDbAtlasLinkedService(*, connection_string: MutableMapping[str, Any],
- database: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, driver_version:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: connect_via
- description: The integration runtime reference.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- - name: description
- description: Linked service description.
- types:
- - <xref:str>
- - name: parameters
- description: Parameters for linked service.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the linked service.
- types:
- - <xref:list>[<xref:JSON>]
- - name: connection_string
- description: 'The MongoDB Atlas connection string. Type: string, SecureString
- or
-
- AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.
-
- Required.'
- types:
- - <xref:JSON>
- - name: database
- description: 'The name of the MongoDB Atlas database that you want to access.
- Type: string
-
- (or Expression with resultType string). Required.'
- types:
- - <xref:JSON>
- - name: driver_version
- description: 'The driver version that you want to choose. Allowed value are v1
- and
-
- v2. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The MongoDB Atlas connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.
-
- Required.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: 'The name of the MongoDB Atlas database that you want to access. Type:
- string
-
- (or Expression with resultType string). Required.'
- name: database
- types:
- - <xref:JSON>
-- description: 'The driver version that you want to choose. Allowed value are v1 and
- v2.
-
- Type: string (or Expression with resultType string).'
- name: driver_version
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbAtlasSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbAtlasSource.yml
deleted file mode 100644
index f0f8e640378d..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbAtlasSource.yml
+++ /dev/null
@@ -1,152 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.MongoDbAtlasSource
-name: MongoDbAtlasSource
-fullName: azure.synapse.artifacts.models.MongoDbAtlasSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity source for a MongoDB Atlas database.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'MongoDbAtlasSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, filter: MutableMapping[str, Any] | None
- = None, cursor_methods: _models.MongoDbCursorMethodsProperties | None = None,
- batch_size: MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str,
- Any] | None = None, additional_columns: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: filter
- description: 'Specifies selection filter using query operators. To return all
- documents in a
-
- collection, omit this parameter or pass an empty document ({}). Type: string
- (or Expression
-
- with resultType string).'
- types:
- - <xref:JSON>
- - name: cursor_methods
- description: Cursor methods for Mongodb query.
- types:
- - <xref:azure.synapse.artifacts.models.MongoDbCursorMethodsProperties>
- - name: batch_size
- description: 'Specifies the number of documents to return in each batch of the
- response
-
- from MongoDB Atlas instance. In most cases, modifying the batch size will not
- affect the user
-
- or the application. This property''s main purpose is to avoid hit the limitation
- of response
-
- size. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Specifies selection filter using query operators. To return all documents
- in a
-
- collection, omit this parameter or pass an empty document ({}). Type: string (or
- Expression
-
- with resultType string).'
- name: filter
- types:
- - <xref:JSON>
-- description: Cursor methods for Mongodb query.
- name: cursor_methods
- types:
- - <xref:azure.synapse.artifacts.models.MongoDbCursorMethodsProperties>
-- description: 'Specifies the number of documents to return in each batch of the response
-
- from MongoDB Atlas instance. In most cases, modifying the batch size will not
- affect the user
-
- or the application. This property''s main purpose is to avoid hit the limitation
- of response
-
- size. Type: integer (or Expression with resultType integer).'
- name: batch_size
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbAuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbAuthenticationType.yml
index b5890fa72f92..a05dfd59b64b 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbAuthenticationType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbAuthenticationType.yml
@@ -11,7 +11,7 @@ inheritances:
- builtins.str
- enum.Enum
fields:
-- name: ANONYMOUS
- uid: azure.synapse.artifacts.models.MongoDbAuthenticationType.ANONYMOUS
-- name: BASIC
- uid: azure.synapse.artifacts.models.MongoDbAuthenticationType.BASIC
+- name: anonymous
+ uid: azure.synapse.artifacts.models.MongoDbAuthenticationType.anonymous
+- name: basic
+ uid: azure.synapse.artifacts.models.MongoDbAuthenticationType.basic
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbCollectionDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbCollectionDataset.yml
index afab5639a05b..139f712f2eb8 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbCollectionDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbCollectionDataset.yml
@@ -10,113 +10,72 @@ summary: 'The MongoDB database dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'MongoDbCollectionDataset(*, linked_service_name: _models.LinkedServiceReference,
- collection_name: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, structure: MutableMapping[str,
- Any] | None = None, schema: MutableMapping[str, Any] | None = None, parameters:
- Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str,
- Any]] | None = None, folder: _models.DatasetFolder | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: collection_name
- description: 'The table name of the MongoDB database. Type: string (or Expression
+ description: 'Required. The table name of the MongoDB database. Type: string (or
- with resultType string). Required.'
+ Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name of the MongoDB database. Type: string (or Expression
- with
-
- resultType string). Required.'
- name: collection_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbCursorMethodsProperties.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbCursorMethodsProperties.yml
deleted file mode 100644
index 58a8e3ae0bd6..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbCursorMethodsProperties.yml
+++ /dev/null
@@ -1,102 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.MongoDbCursorMethodsProperties
-name: MongoDbCursorMethodsProperties
-fullName: azure.synapse.artifacts.models.MongoDbCursorMethodsProperties
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Cursor methods for Mongodb query.
-constructor:
- syntax: 'MongoDbCursorMethodsProperties(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, project: MutableMapping[str, Any] | None = None, sort: MutableMapping[str,
- Any] | None = None, skip: MutableMapping[str, Any] | None = None, limit: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: project
- description: 'Specifies the fields to return in the documents that match the query
- filter.
-
- To return all fields in the matching documents, omit this parameter. Type: string
- (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: sort
- description: 'Specifies the order in which the query returns matching documents.
- Type: string
-
- (or Expression with resultType string). Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
- - name: skip
- description: 'Specifies the how many documents skipped and where MongoDB begins
- returning
-
- results. This approach may be useful in implementing paginated results. Type:
- integer (or
-
- Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: limit
- description: 'Specifies the maximum number of documents the server returns. limit()
- is
-
- analogous to the LIMIT statement in a SQL database. Type: integer (or Expression
- with
-
- resultType integer).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: 'Specifies the fields to return in the documents that match the query
- filter. To
-
- return all fields in the matching documents, omit this parameter. Type: string
- (or Expression
-
- with resultType string).'
- name: project
- types:
- - <xref:JSON>
-- description: 'Specifies the order in which the query returns matching documents.
- Type: string (or
-
- Expression with resultType string). Type: string (or Expression with resultType
- string).'
- name: sort
- types:
- - <xref:JSON>
-- description: 'Specifies the how many documents skipped and where MongoDB begins
- returning
-
- results. This approach may be useful in implementing paginated results. Type:
- integer (or
-
- Expression with resultType integer).'
- name: skip
- types:
- - <xref:JSON>
-- description: 'Specifies the maximum number of documents the server returns. limit()
- is analogous
-
- to the LIMIT statement in a SQL database. Type: integer (or Expression with resultType
-
- integer).'
- name: limit
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbLinkedService.yml
index f2f1e675dd22..e60df75a9cde 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbLinkedService.yml
@@ -10,203 +10,122 @@ summary: 'Linked service for MongoDb data source.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'MongoDbLinkedService(*, server: MutableMapping[str, Any], database_name:
- MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, authentication_type:
- str | _models.MongoDbAuthenticationType | None = None, username: MutableMapping[str,
- Any] | None = None, password: _models.SecretBase | None = None, auth_source: MutableMapping[str,
- Any] | None = None, port: MutableMapping[str, Any] | None = None, enable_ssl:
- MutableMapping[str, Any] | None = None, allow_self_signed_server_cert: MutableMapping[str,
- Any] | None = None, encrypted_credential: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: server
- description: 'The IP address or server name of the MongoDB server. Type: string
- (or
+ description: 'Required. The IP address or server name of the MongoDB server. Type:
+ string (or
- Expression with resultType string). Required.'
+ Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: authentication_type
description: 'The authentication type to be used to connect to the MongoDB
- database. Known values are: "Basic" and "Anonymous".'
+ database. Possible values include: "Basic", "Anonymous".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.MongoDbAuthenticationType>
- name: database_name
- description: 'The name of the MongoDB database that you want to access. Type:
- string
+ description: 'Required. The name of the MongoDB database that you want to access.
+ Type:
- (or Expression with resultType string). Required.'
+ string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: username
description: 'Username for authentication. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: Password for authentication.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: auth_source
description: 'Database to verify the username and password. Type: string (or Expression
with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: port
description: 'The TCP port number that the MongoDB server uses to listen for client
+ connections.
- connections. The default value is 27017. Type: integer (or Expression with resultType
- integer),
-
+ The default value is 27017. Type: integer (or Expression with resultType integer),
minimum: 0.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: enable_ssl
description: 'Specifies whether the connections to the server are encrypted using
- SSL.
+ SSL. The
- The default value is false. Type: boolean (or Expression with resultType boolean).'
+ default value is false. Type: boolean (or Expression with resultType boolean).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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
+ 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:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The IP address or server name of the MongoDB server. Type: string
- (or Expression
-
- with resultType string). Required.'
- name: server
- types:
- - <xref:JSON>
-- description: 'The authentication type to be used to connect to the MongoDB
-
- database. Known values are: "Basic" and "Anonymous".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.MongoDbAuthenticationType>
-- description: 'The name of the MongoDB database that you want to access. Type: string
- (or
-
- Expression with resultType string). Required.'
- name: database_name
- types:
- - <xref:JSON>
-- description: 'Username for authentication. Type: string (or Expression with resultType
-
- string).'
- name: username
- types:
- - <xref:JSON>
-- description: Password for authentication.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Database to verify the username and password. Type: string (or Expression
-
- with resultType string).'
- name: auth_source
- types:
- - <xref:JSON>
-- 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.'
- name: port
- types:
- - <xref:JSON>
-- description: 'Specifies whether the connections to the server are encrypted using
- SSL. The
-
- default value is false. Type: boolean (or Expression with resultType boolean).'
- name: enable_ssl
- types:
- - <xref:JSON>
-- description: 'Specifies whether to allow self-signed certificates from
-
- the server. The default value is false. Type: boolean (or Expression with resultType
- boolean).'
- name: allow_self_signed_server_cert
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbSource.yml
deleted file mode 100644
index c5e93f32c7f4..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbSource.yml
+++ /dev/null
@@ -1,98 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.MongoDbSource
-name: MongoDbSource
-fullName: azure.synapse.artifacts.models.MongoDbSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity source for a MongoDB database.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'MongoDbSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query
- description: 'Database query. Should be a SQL-92 query expression. Type: string
- (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Database query. Should be a SQL-92 query expression. Type: string
- (or Expression
-
- with resultType string).'
- name: query
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2CollectionDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2CollectionDataset.yml
index e0c80eaf14eb..691bcda57f93 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2CollectionDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2CollectionDataset.yml
@@ -10,113 +10,73 @@ summary: 'The MongoDB database dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'MongoDbV2CollectionDataset(*, linked_service_name: _models.LinkedServiceReference,
- collection: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, structure: MutableMapping[str,
- Any] | None = None, schema: MutableMapping[str, Any] | None = None, parameters:
- Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str,
- Any]] | None = None, folder: _models.DatasetFolder | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: collection
- description: 'The collection name of the MongoDB database. Type: string (or Expression
+ description: 'Required. The collection name of the MongoDB database. Type: string
+ (or
- with resultType string). Required.'
+ Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The collection name of the MongoDB database. Type: string (or Expression
- with
-
- resultType string). Required.'
- name: collection
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2LinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2LinkedService.yml
index 952594bc7eb9..989bc82df95d 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2LinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2LinkedService.yml
@@ -10,89 +10,55 @@ summary: 'Linked service for MongoDB data source.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'MongoDbV2LinkedService(*, connection_string: MutableMapping[str, Any],
- database: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
- description: 'The MongoDB connection string. Type: string, SecureString or
+ description: 'Required. The MongoDB connection string. Type: string, SecureString
- AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.
-
- Required.'
+ or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: database
- description: 'The name of the MongoDB database that you want to access. Type:
- string (or
+ description: 'Required. The name of the MongoDB database that you want to access.
+ Type:
- Expression with resultType string). Required.'
+ string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The MongoDB connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.
-
- Required.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: 'The name of the MongoDB database that you want to access. Type: string
- (or
-
- Expression with resultType string). Required.'
- name: database
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2Source.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2Source.yml
deleted file mode 100644
index 0457102391d9..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2Source.yml
+++ /dev/null
@@ -1,152 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.MongoDbV2Source
-name: MongoDbV2Source
-fullName: azure.synapse.artifacts.models.MongoDbV2Source
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity source for a MongoDB database.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'MongoDbV2Source(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, filter: MutableMapping[str, Any] | None
- = None, cursor_methods: _models.MongoDbCursorMethodsProperties | None = None,
- batch_size: MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str,
- Any] | None = None, additional_columns: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: filter
- description: 'Specifies selection filter using query operators. To return all
- documents in a
-
- collection, omit this parameter or pass an empty document ({}). Type: string
- (or Expression
-
- with resultType string).'
- types:
- - <xref:JSON>
- - name: cursor_methods
- description: Cursor methods for Mongodb query.
- types:
- - <xref:azure.synapse.artifacts.models.MongoDbCursorMethodsProperties>
- - name: batch_size
- description: 'Specifies the number of documents to return in each batch of the
- response
-
- from MongoDB instance. In most cases, modifying the batch size will not affect
- the user or the
-
- application. This property''s main purpose is to avoid hit the limitation of
- response size.
-
- Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Specifies selection filter using query operators. To return all documents
- in a
-
- collection, omit this parameter or pass an empty document ({}). Type: string (or
- Expression
-
- with resultType string).'
- name: filter
- types:
- - <xref:JSON>
-- description: Cursor methods for Mongodb query.
- name: cursor_methods
- types:
- - <xref:azure.synapse.artifacts.models.MongoDbCursorMethodsProperties>
-- description: 'Specifies the number of documents to return in each batch of the response
-
- from MongoDB instance. In most cases, modifying the batch size will not affect
- the user or the
-
- application. This property''s main purpose is to avoid hit the limitation of response
- size.
-
- Type: integer (or Expression with resultType integer).'
- name: batch_size
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MultiplePipelineTrigger.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MultiplePipelineTrigger.yml
index f552b68db54f..35e788a283be 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MultiplePipelineTrigger.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MultiplePipelineTrigger.yml
@@ -9,68 +9,48 @@ summary: 'Base class for all triggers that support one to many model for trigger
pipeline.
- You probably want to use the sub-classes and not this class directly. Known sub-classes
- are:
-
- BlobEventsTrigger, BlobTrigger, CustomEventsTrigger, ScheduleTrigger
-
-
Variables are only populated by 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, MutableMapping[str,
- Any]] | None = None, description: str | None = None, annotations: List[MutableMapping[str,
- Any]] | None = None, pipelines: List[_models.TriggerPipelineReference] | None
- = None, **kwargs: Any)'
+ 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:
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Trigger type.Constant filled by server.
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:str>
- name: description
description: Trigger description.
+ isRequired: true
types:
- <xref:str>
- name: annotations
description: List of tags that can be used for describing the trigger.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: pipelines
description: Pipelines that need to be started.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.TriggerPipelineReference>]
variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Trigger type. Required.
- name: type
- types:
- - <xref:str>
-- description: Trigger description.
- name: description
- types:
- - <xref:str>
- description: 'Indicates if trigger is running or not. Updated when Start/Stop APIs
are
- called on the Trigger. Known values are: "Started", "Stopped", and "Disabled".'
+ called on the Trigger. Possible values include: "Started", "Stopped", "Disabled".'
name: runtime_state
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.TriggerRuntimeState>
-- description: List of tags that can be used for describing the trigger.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: Pipelines that need to be started.
- name: pipelines
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.TriggerPipelineReference>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlLinkedService.yml
index 9bdfdd25f397..4e2d68eb8651 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlLinkedService.yml
@@ -10,93 +10,61 @@ summary: 'Linked service for MySQL data source.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'MySqlLinkedService(*, connection_string: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, password:
- _models.AzureKeyVaultSecretReference | None = None, encrypted_credential: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
- description: The connection string. Required.
+ description: Required. The connection string.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: The Azure key vault secret reference of password in connection string.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The connection string. Required.
- name: connection_string
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of password in connection string.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlSource.yml
deleted file mode 100644
index 87fcbe82caa1..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlSource.yml
+++ /dev/null
@@ -1,105 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.MySqlSource
-name: MySqlSource
-fullName: azure.synapse.artifacts.models.MySqlSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity source for MySQL databases.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'MySqlSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'Database query. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'Database query. Type: string (or Expression with resultType string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlTableDataset.yml
index 702203738610..ad1640763ff8 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlTableDataset.yml
@@ -10,111 +10,71 @@ summary: 'The MySQL table dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'MySqlTableDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The MySQL table name. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The MySQL table name. Type: string (or Expression with resultType
- string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaLinkedService.yml
index e61da05c3ab2..9dfddae8391c 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaLinkedService.yml
@@ -10,98 +10,63 @@ summary: 'Netezza linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'NetezzaLinkedService(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, connection_string:
- MutableMapping[str, Any] | None = None, pwd: _models.AzureKeyVaultSecretReference
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
description: 'An ODBC connection string. Type: string, SecureString or
AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: pwd
description: The Azure key vault secret reference of password in connection string.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'An ODBC connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of password in connection string.
- name: pwd
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaPartitionOption.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaPartitionOption.yml
deleted file mode 100644
index cb5434d5dbde..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaPartitionOption.yml
+++ /dev/null
@@ -1,19 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.NetezzaPartitionOption
-name: NetezzaPartitionOption
-fullName: azure.synapse.artifacts.models.NetezzaPartitionOption
-summary: The partition mechanism that will be used for Netezza read in parallel.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: NetezzaPartitionOption(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: DATA_SLICE
- uid: azure.synapse.artifacts.models.NetezzaPartitionOption.DATA_SLICE
-- name: DYNAMIC_RANGE
- uid: azure.synapse.artifacts.models.NetezzaPartitionOption.DYNAMIC_RANGE
-- name: NONE
- uid: azure.synapse.artifacts.models.NetezzaPartitionOption.NONE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaPartitionSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaPartitionSettings.yml
deleted file mode 100644
index 7e3827014625..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaPartitionSettings.yml
+++ /dev/null
@@ -1,62 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.NetezzaPartitionSettings
-name: NetezzaPartitionSettings
-fullName: azure.synapse.artifacts.models.NetezzaPartitionSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: The settings that will be leveraged for Netezza source partitioning.
-constructor:
- syntax: 'NetezzaPartitionSettings(*, partition_column_name: MutableMapping[str,
- Any] | None = None, partition_upper_bound: MutableMapping[str, Any] | None = None,
- partition_lower_bound: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: partition_column_name
- description: 'The name of the column in integer type that will be used for
-
- proceeding range partitioning. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: partition_upper_bound
- description: 'The maximum value of column specified in partitionColumnName
-
- that will be used for proceeding range partitioning. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: partition_lower_bound
- description: 'The minimum value of column specified in partitionColumnName
-
- that will be used for proceeding range partitioning. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'The name of the column in integer type that will be used for
-
- proceeding range partitioning. Type: string (or Expression with resultType string).'
- name: partition_column_name
- types:
- - <xref:JSON>
-- description: 'The maximum value of column specified in partitionColumnName that
-
- will be used for proceeding range partitioning. Type: string (or Expression with
- resultType
-
- string).'
- name: partition_upper_bound
- types:
- - <xref:JSON>
-- description: 'The minimum value of column specified in partitionColumnName that
-
- will be used for proceeding range partitioning. Type: string (or Expression with
- resultType
-
- string).'
- name: partition_lower_bound
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaSource.yml
deleted file mode 100644
index 76ad175ae618..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaSource.yml
+++ /dev/null
@@ -1,137 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.NetezzaSource
-name: NetezzaSource
-fullName: azure.synapse.artifacts.models.NetezzaSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Netezza source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'NetezzaSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, partition_option: str | _models.NetezzaPartitionOption | None = None,
- partition_settings: _models.NetezzaPartitionSettings | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: partition_option
- description: 'The partition mechanism that will be used for Netezza read in
-
- parallel. Known values are: "None", "DataSlice", and "DynamicRange".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.NetezzaPartitionOption>
- - name: partition_settings
- description: 'The settings that will be leveraged for Netezza source
-
- partitioning.'
- types:
- - <xref:azure.synapse.artifacts.models.NetezzaPartitionSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
-- description: 'The partition mechanism that will be used for Netezza read in parallel.
-
- Known values are: "None", "DataSlice", and "DynamicRange".'
- name: partition_option
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.NetezzaPartitionOption>
-- description: The settings that will be leveraged for Netezza source partitioning.
- name: partition_settings
- types:
- - <xref:azure.synapse.artifacts.models.NetezzaPartitionSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaTableDataset.yml
index f0056369e44b..49627d30c3d4 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaTableDataset.yml
@@ -10,139 +10,88 @@ summary: 'Netezza dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'NetezzaTableDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, table: MutableMapping[str, Any] | None = None, schema_type_properties_schema:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'This property will be retired. Please consider using schema + table
properties instead.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: table
description: 'The table name of the Netezza. Type: string (or Expression with
resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: schema_type_properties_schema
description: 'The schema name of the Netezza. Type: string (or
Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'This property will be retired. Please consider using schema + table
-
- properties instead.'
- name: table_name
- types:
- - <xref:JSON>
-- description: 'The table name of the Netezza. Type: string (or Expression with resultType
-
- string).'
- name: table
- types:
- - <xref:JSON>
-- description: 'The schema name of the Netezza. Type: string (or
-
- Expression with resultType string).'
- name: schema_type_properties_schema
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NodeSize.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NodeSize.yml
deleted file mode 100644
index 2e29e8fa5b72..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NodeSize.yml
+++ /dev/null
@@ -1,27 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.NodeSize
-name: NodeSize
-fullName: azure.synapse.artifacts.models.NodeSize
-summary: The level of compute power that each node in the Big Data pool has.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: NodeSize(value, names=None, *, module=None, qualname=None, type=None, start=1,
- boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: LARGE
- uid: azure.synapse.artifacts.models.NodeSize.LARGE
-- name: MEDIUM
- uid: azure.synapse.artifacts.models.NodeSize.MEDIUM
-- name: NONE
- uid: azure.synapse.artifacts.models.NodeSize.NONE
-- name: SMALL
- uid: azure.synapse.artifacts.models.NodeSize.SMALL
-- name: XXX_LARGE
- uid: azure.synapse.artifacts.models.NodeSize.XXX_LARGE
-- name: XX_LARGE
- uid: azure.synapse.artifacts.models.NodeSize.XX_LARGE
-- name: X_LARGE
- uid: azure.synapse.artifacts.models.NodeSize.X_LARGE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NodeSizeFamily.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NodeSizeFamily.yml
deleted file mode 100644
index be9b5936783e..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NodeSizeFamily.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.NodeSizeFamily
-name: NodeSizeFamily
-fullName: azure.synapse.artifacts.models.NodeSizeFamily
-summary: The kind of nodes that the Big Data pool provides.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: NodeSizeFamily(value, names=None, *, module=None, qualname=None, type=None,
- start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: MEMORY_OPTIMIZED
- uid: azure.synapse.artifacts.models.NodeSizeFamily.MEMORY_OPTIMIZED
-- name: NONE
- uid: azure.synapse.artifacts.models.NodeSizeFamily.NONE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Notebook.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Notebook.yml
index a1bb5d6baca7..f7a7c5500fb9 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Notebook.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Notebook.yml
@@ -4,115 +4,60 @@ name: Notebook
fullName: azure.synapse.artifacts.models.Notebook
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'Notebook.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'Notebook(*, metadata: _models.NotebookMetadata, nbformat: int, nbformat_minor:
- int, cells: List[_models.NotebookCell], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, big_data_pool: _models.BigDataPoolReference
- | None = None, target_spark_configuration: _models.SparkConfigurationReference
- | None = None, session_properties: _models.NotebookSessionProperties | None =
- None, folder: _models.NotebookFolder | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: description
description: The description of the notebook.
+ isRequired: true
types:
- <xref:str>
- name: big_data_pool
description: Big data pool reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.BigDataPoolReference>
- - name: target_spark_configuration
- description: The spark configuration of the spark job.
- types:
- - <xref:azure.synapse.artifacts.models.SparkConfigurationReference>
- name: session_properties
description: Session properties.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.NotebookSessionProperties>
- name: metadata
- description: Notebook root-level metadata. Required.
+ description: Required. Notebook root-level metadata.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.NotebookMetadata>
- name: nbformat
- description: 'Notebook format (major number). Incremented between backwards incompatible
+ description: 'Required. Notebook format (major number). Incremented between backwards
- changes to the notebook format. Required.'
+ incompatible changes to the notebook format.'
+ isRequired: true
types:
- <xref:int>
- name: nbformat_minor
- description: 'Notebook format (minor number). Incremented for backward compatible
+ description: 'Required. Notebook format (minor number). Incremented for backward
- changes to the notebook format. Required.'
+ compatible changes to the notebook format.'
+ isRequired: true
types:
- <xref:int>
- name: cells
- description: Array of cells of the current notebook. Required.
+ description: Required. Array of cells of the current notebook.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.NotebookCell>]
- - name: folder
- description: 'The folder that this notebook is in. If not specified, this notebook
- will
-
- appear at the root level.'
- types:
- - <xref:azure.synapse.artifacts.models.NotebookFolder>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The description of the notebook.
- name: description
- types:
- - <xref:str>
-- description: Big data pool reference.
- name: big_data_pool
- types:
- - <xref:azure.synapse.artifacts.models.BigDataPoolReference>
-- description: The spark configuration of the spark job.
- name: target_spark_configuration
- types:
- - <xref:azure.synapse.artifacts.models.SparkConfigurationReference>
-- description: Session properties.
- name: session_properties
- types:
- - <xref:azure.synapse.artifacts.models.NotebookSessionProperties>
-- description: Notebook root-level metadata. Required.
- name: metadata
- types:
- - <xref:azure.synapse.artifacts.models.NotebookMetadata>
-- description: 'Notebook format (major number). Incremented between backwards incompatible
-
- changes to the notebook format. Required.'
- name: nbformat
- types:
- - <xref:int>
-- description: 'Notebook format (minor number). Incremented for backward compatible
-
- changes to the notebook format. Required.'
- name: nbformat_minor
- types:
- - <xref:int>
-- description: Array of cells of the current notebook. Required.
- name: cells
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.NotebookCell>]
-- description: 'The folder that this notebook is in. If not specified, this notebook
- will appear
-
- at the root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.NotebookFolder>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCell.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCell.yml
index 0530bdedac66..3562ed88aaed 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCell.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCell.yml
@@ -4,67 +4,45 @@ name: NotebookCell
fullName: azure.synapse.artifacts.models.NotebookCell
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'Notebook cell.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'NotebookCell(*, cell_type: str, metadata: MutableMapping[str, Any], source:
- List[str], additional_properties: Dict[str, MutableMapping[str, Any]] | None =
- None, attachments: MutableMapping[str, Any] | None = None, outputs: List[_models.NotebookCellOutputItem]
- | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: cell_type
- description: String identifying the type of cell. Required.
+ description: Required. String identifying the type of cell.
+ isRequired: true
types:
- <xref:str>
- name: metadata
- description: Cell-level metadata. Required.
+ description: Required. Cell-level metadata.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: source
- description: Contents of the cell, represented as an array of lines. Required.
+ description: Required. Contents of the cell, represented as an array of lines.
+ isRequired: true
types:
- <xref:list>[<xref:str>]
- name: attachments
description: Attachments associated with the cell.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: outputs
description: Cell-level output items.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.NotebookCellOutputItem>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: String identifying the type of cell. Required.
- name: cell_type
- types:
- - <xref:str>
-- description: Cell-level metadata. Required.
- name: metadata
- types:
- - <xref:JSON>
-- description: Contents of the cell, represented as an array of lines. Required.
- name: source
- types:
- - <xref:list>[<xref:str>]
-- description: Attachments associated with the cell.
- name: attachments
- types:
- - <xref:JSON>
-- description: Cell-level output items.
- name: outputs
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.NotebookCellOutputItem>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCellOutputItem.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCellOutputItem.yml
index 6ec2b7ce1b55..d18a6558cf69 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCellOutputItem.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCellOutputItem.yml
@@ -4,29 +4,32 @@ name: NotebookCellOutputItem
fullName: azure.synapse.artifacts.models.NotebookCellOutputItem
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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 | _models.CellOutputType, name:
- str | None = None, execution_count: int | None = None, text: Any | None = None,
- data: MutableMapping[str, Any] | None = None, metadata: MutableMapping[str, Any]
- | None = None, **kwargs: Any)'
+ 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:
- <xref:str>
- name: execution_count
description: Execution sequence number.
+ isRequired: true
types:
- <xref:int>
- name: output_type
- description: 'Execution, display, or stream outputs. Required. Known values are:
+ description: 'Required. Execution, display, or stream outputs. Possible values
+ include:
- "execute_result", "display_data", "stream", and "error".'
+ "execute_result", "display_data", "stream", "error".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.CellOutputType>
@@ -35,44 +38,16 @@ constructor:
a string or an
array of strings.'
+ isRequired: true
types:
- - <xref:any>
+ - <xref:object>
- name: data
description: Output data. Use MIME type as key, and content as value.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: metadata
description: Metadata for the output item.
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: For output_type=stream, determines the name of stream (stdout / stderr).
- name: name
- types:
- - <xref:str>
-- description: Execution sequence number.
- name: execution_count
- types:
- - <xref:int>
-- description: 'Execution, display, or stream outputs. Required. Known values are:
-
- "execute_result", "display_data", "stream", and "error".'
- name: output_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.CellOutputType>
-- description: 'For output_type=stream, the stream''s text output, represented as
- a string or an
-
- array of strings.'
- name: text
- types:
- - <xref:any>
-- description: Output data. Use MIME type as key, and content as value.
- name: data
- types:
- - <xref:JSON>
-- description: Metadata for the output item.
- name: metadata
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookFolder.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookFolder.yml
deleted file mode 100644
index 25538b389a3b..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookFolder.yml
+++ /dev/null
@@ -1,23 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.NotebookFolder
-name: NotebookFolder
-fullName: azure.synapse.artifacts.models.NotebookFolder
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'The folder that this notebook is in. If not specified, this notebook will
- appear at the root
-
- level.'
-constructor:
- syntax: 'NotebookFolder(*, name: str | None = None, **kwargs: Any)'
- parameters:
- - name: name
- description: The name of the folder that this notebook is in.
- types:
- - <xref:str>
-variables:
-- description: The name of the folder that this notebook is in.
- name: name
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookKernelSpec.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookKernelSpec.yml
index f6c87f7c5242..8fe04e3fde76 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookKernelSpec.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookKernelSpec.yml
@@ -4,41 +4,29 @@ name: NotebookKernelSpec
fullName: azure.synapse.artifacts.models.NotebookKernelSpec
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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, MutableMapping[str, Any]] | None = None, **kwargs: Any)'
+ Dict[str, object] | None = None, **kwargs)'
parameters:
- name: additional_properties
description: 'Unmatched properties from the message are deserialized to this
collection.'
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Name of the kernel specification. Required.
+ description: Required. Name of the kernel specification.
+ isRequired: true
types:
- <xref:str>
- name: display_name
- description: Name to display in UI. Required.
+ description: Required. Name to display in UI.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Name of the kernel specification. Required.
- name: name
- types:
- - <xref:str>
-- description: Name to display in UI. Required.
- name: display_name
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookLanguageInfo.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookLanguageInfo.yml
index 01b358599790..952dd9c185a9 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookLanguageInfo.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookLanguageInfo.yml
@@ -4,41 +4,29 @@ name: NotebookLanguageInfo
fullName: azure.synapse.artifacts.models.NotebookLanguageInfo
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'Language info.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'NotebookLanguageInfo(*, name: str, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, codemirror_mode: str | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: The programming language which this kernel runs. Required.
+ description: Required. The programming language which this kernel runs.
+ isRequired: true
types:
- <xref:str>
- name: codemirror_mode
description: The codemirror mode to use for code in this language.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The programming language which this kernel runs. Required.
- name: name
- types:
- - <xref:str>
-- description: The codemirror mode to use for code in this language.
- name: codemirror_mode
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookListResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookListResponse.yml
index f7d4bd4cbf23..4ae183aa4898 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookListResponse.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookListResponse.yml
@@ -4,29 +4,22 @@ name: NotebookListResponse
fullName: azure.synapse.artifacts.models.NotebookListResponse
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'A list of Notebook resources.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'NotebookListResponse(*, value: List[_models.NotebookResource], next_link:
- str | None = None, **kwargs: Any)'
+ syntax: 'NotebookListResponse(*, value: List[NotebookResource], next_link: str |
+ None = None, **kwargs)'
parameters:
- name: value
- description: List of Notebooks. Required.
+ description: Required. List of Notebooks.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.NotebookResource>]
- name: next_link
description: The link to the next page of results, if any remaining results exist.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: List of Notebooks. Required.
- name: value
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.NotebookResource>]
-- description: The link to the next page of results, if any remaining results exist.
- name: next_link
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookMetadata.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookMetadata.yml
index 30978eac1625..bbf751771e3e 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookMetadata.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookMetadata.yml
@@ -4,39 +4,27 @@ name: NotebookMetadata
fullName: azure.synapse.artifacts.models.NotebookMetadata
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: Notebook root-level metadata.
constructor:
- syntax: 'NotebookMetadata(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, kernelspec: _models.NotebookKernelSpec | None = None, language_info:
- _models.NotebookLanguageInfo | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: kernelspec
description: Kernel information.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.NotebookKernelSpec>
- name: language_info
description: Language info.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.NotebookLanguageInfo>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Kernel information.
- name: kernelspec
- types:
- - <xref:azure.synapse.artifacts.models.NotebookKernelSpec>
-- description: Language info.
- name: language_info
- types:
- - <xref:azure.synapse.artifacts.models.NotebookLanguageInfo>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookParameter.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookParameter.yml
deleted file mode 100644
index 51d676b8ced1..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookParameter.yml
+++ /dev/null
@@ -1,35 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.NotebookParameter
-name: NotebookParameter
-fullName: azure.synapse.artifacts.models.NotebookParameter
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Notebook parameter.
-constructor:
- syntax: 'NotebookParameter(*, value: MutableMapping[str, Any] | None = None, type:
- str | _models.NotebookParameterType | None = None, **kwargs: Any)'
- parameters:
- - name: value
- description: 'Notebook parameter value. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
- - name: type
- description: 'Notebook parameter type. Known values are: "string", "int", "float",
- and "bool".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.NotebookParameterType>
-variables:
-- description: 'Notebook parameter value. Type: string (or Expression with resultType
- string).'
- name: value
- types:
- - <xref:JSON>
-- description: 'Notebook parameter type. Known values are: "string", "int", "float",
- and "bool".'
- name: type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.NotebookParameterType>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookParameterType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookParameterType.yml
deleted file mode 100644
index ac75405450fe..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookParameterType.yml
+++ /dev/null
@@ -1,21 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.NotebookParameterType
-name: NotebookParameterType
-fullName: azure.synapse.artifacts.models.NotebookParameterType
-summary: Notebook parameter type.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: NotebookParameterType(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: BOOL
- uid: azure.synapse.artifacts.models.NotebookParameterType.BOOL
-- name: FLOAT
- uid: azure.synapse.artifacts.models.NotebookParameterType.FLOAT
-- name: INT
- uid: azure.synapse.artifacts.models.NotebookParameterType.INT
-- name: STRING
- uid: azure.synapse.artifacts.models.NotebookParameterType.STRING
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookReferenceType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookReferenceType.yml
deleted file mode 100644
index 86ae73039ef3..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookReferenceType.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.NotebookReferenceType
-name: NotebookReferenceType
-fullName: azure.synapse.artifacts.models.NotebookReferenceType
-summary: Synapse notebook reference type.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: NotebookReferenceType(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: NOTEBOOK_REFERENCE
- uid: azure.synapse.artifacts.models.NotebookReferenceType.NOTEBOOK_REFERENCE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookResource.yml
index d2f2b2b087b2..4b46e524b86b 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookResource.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookResource.yml
@@ -4,7 +4,7 @@ name: NotebookResource
fullName: azure.synapse.artifacts.models.NotebookResource
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- azure.synapse.artifacts.models._models_py3.SubResource
summary: 'Notebook resource type.
@@ -13,39 +13,27 @@ summary: 'Notebook resource type.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'NotebookResource(*, name: str, properties: _models.Notebook, **kwargs:
- Any)'
+ syntax: 'NotebookResource(*, properties: Notebook, **kwargs)'
parameters:
- - name: name
- description: The name of the resource. Required.
- types:
- - <xref:str>
- name: properties
- description: Properties of Notebook. Required.
+ description: Required. Properties of Notebook.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.Notebook>
variables:
-- description: 'Fully qualified resource Id for the resource. Ex -
-
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.'
+- description: The resource identifier.
name: id
types:
- <xref:str>
-- description: The name of the resource. Required.
+- description: The resource name.
name: name
types:
- <xref:str>
-- description: 'The type of the resource. Ex- Microsoft.Compute/virtualMachines or
-
- Microsoft.Storage/storageAccounts.'
+- description: The resource type.
name: type
types:
- <xref:str>
-- description: Resource Etag.
+- description: Etag identifies change in the resource.
name: etag
types:
- <xref:str>
-- description: Properties of Notebook. Required.
- name: properties
- types:
- - <xref:azure.synapse.artifacts.models.Notebook>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookSessionProperties.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookSessionProperties.yml
index 06d4854c11e1..39f6267fccb6 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookSessionProperties.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookSessionProperties.yml
@@ -4,53 +4,37 @@ name: NotebookSessionProperties
fullName: azure.synapse.artifacts.models.NotebookSessionProperties
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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: Any)'
+ str, executor_cores: int, num_executors: int, **kwargs)'
parameters:
- name: driver_memory
- description: Amount of memory to use for the driver process. Required.
+ description: Required. Amount of memory to use for the driver process.
+ isRequired: true
types:
- <xref:str>
- name: driver_cores
- description: Number of cores to use for the driver. Required.
+ description: Required. Number of cores to use for the driver.
+ isRequired: true
types:
- <xref:int>
- name: executor_memory
- description: Amount of memory to use per executor process. Required.
+ description: Required. Amount of memory to use per executor process.
+ isRequired: true
types:
- <xref:str>
- name: executor_cores
- description: Number of cores to use for each executor. Required.
+ description: Required. Number of cores to use for each executor.
+ isRequired: true
types:
- <xref:int>
- name: num_executors
- description: Number of executors to launch for this session. Required.
+ description: Required. Number of executors to launch for this session.
+ isRequired: true
types:
- <xref:int>
-variables:
-- description: Amount of memory to use for the driver process. Required.
- name: driver_memory
- types:
- - <xref:str>
-- description: Number of cores to use for the driver. Required.
- name: driver_cores
- types:
- - <xref:int>
-- description: Amount of memory to use per executor process. Required.
- name: executor_memory
- types:
- - <xref:str>
-- description: Number of cores to use for each executor. Required.
- name: executor_cores
- types:
- - <xref:int>
-- description: Number of executors to launch for this session. Required.
- name: num_executors
- types:
- - <xref:int>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataAadServicePrincipalCredentialType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataAadServicePrincipalCredentialType.yml
index 60483dfebff6..5ecd75a0f93a 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataAadServicePrincipalCredentialType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataAadServicePrincipalCredentialType.yml
@@ -11,7 +11,7 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataAuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataAuthenticationType.yml
index 895afb16754e..46a1a6b38632 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataAuthenticationType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataAuthenticationType.yml
@@ -11,13 +11,13 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataLinkedService.yml
index e9f830468be5..6e02148fddb9 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataLinkedService.yml
@@ -10,55 +10,65 @@ summary: 'Open Data Protocol (OData) linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'ODataLinkedService(*, url: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, authentication_type:
- str | _models.ODataAuthenticationType | None = None, user_name: MutableMapping[str,
- Any] | None = None, password: _models.SecretBase | None = None, tenant: MutableMapping[str,
- Any] | None = None, service_principal_id: MutableMapping[str, Any] | None = None,
- azure_cloud_type: MutableMapping[str, Any] | None = None, aad_resource_id: MutableMapping[str,
- Any] | None = None, aad_service_principal_credential_type: str | _models.ODataAadServicePrincipalCredentialType
- | None = None, service_principal_key: _models.SecretBase | None = None, service_principal_embedded_cert:
- _models.SecretBase | None = None, service_principal_embedded_cert_password: _models.SecretBase
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: url
- description: 'The URL of the OData service endpoint. Type: string (or Expression
- with
+ description: 'Required. The URL of the OData service endpoint. Type: string (or
+ Expression with
- resultType string). Required.'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: authentication_type
description: 'Type of authentication used to connect to the OData service.
- Known values are: "Basic", "Anonymous", "Windows", "AadServicePrincipal", and
+ Possible values include: "Basic", "Anonymous", "Windows", "AadServicePrincipal",
"ManagedServiceIdentity".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.ODataAuthenticationType>
@@ -67,10 +77,12 @@ constructor:
resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: Password of the OData service.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: tenant
@@ -78,41 +90,36 @@ constructor:
which your
application resides. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_id
- description: 'Specify the application id of your application registered in
-
- Azure Active Directory. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: azure_cloud_type
- description: 'Indicates the azure cloud type of the service principle auth.
+ description: 'Specify the application id of your application registered in Azure
- Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany.
- Default value is
-
- the data factory regions'' cloud type. Type: string (or Expression with resultType
- string).'
+ Active Directory. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: aad_resource_id
- description: 'Specify the resource you are requesting authorization to use
+ description: 'Specify the resource you are requesting authorization to use Directory.
- Directory. Type: string (or Expression with resultType string).'
+ Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: aad_service_principal_credential_type
- description: 'Specify the credential type (key or cert) is
+ description: 'Specify the credential type (key or cert) is used
- used for service principal. Known values are: "ServicePrincipalKey" and "ServicePrincipalCert".'
+ for service principal. Possible values include: "ServicePrincipalKey", "ServicePrincipalCert".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.ODataAadServicePrincipalCredentialType>
- name: service_principal_key
- description: 'Specify the secret of your application registered in Azure
+ description: 'Specify the secret of your application registered in Azure Active
- Active Directory. Type: string (or Expression with resultType string).'
+ Directory. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: service_principal_embedded_cert
@@ -122,6 +129,7 @@ constructor:
with resultType
string).'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: service_principal_embedded_cert_password
@@ -131,135 +139,16 @@ constructor:
Type:
string (or Expression with resultType string).'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The URL of the OData service endpoint. Type: string (or Expression
- with resultType
-
- string). Required.'
- name: url
- types:
- - <xref:JSON>
-- description: 'Type of authentication used to connect to the OData service. Known
-
- values are: "Basic", "Anonymous", "Windows", "AadServicePrincipal", and
-
- "ManagedServiceIdentity".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ODataAuthenticationType>
-- description: 'User name of the OData service. Type: string (or Expression with resultType
-
- string).'
- name: user_name
- types:
- - <xref:JSON>
-- description: Password of the OData service.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Specify the tenant information (domain name or tenant ID) under which
- your
-
- application resides. Type: string (or Expression with resultType string).'
- name: tenant
- types:
- - <xref:JSON>
-- description: 'Specify the application id of your application registered in Azure
-
- Active Directory. Type: string (or Expression with resultType string).'
- name: service_principal_id
- types:
- - <xref:JSON>
-- description: 'Indicates the azure cloud type of the service principle auth. Allowed
-
- values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value
- is the data
-
- factory regions'' cloud type. Type: string (or Expression with resultType string).'
- name: azure_cloud_type
- types:
- - <xref:JSON>
-- description: 'Specify the resource you are requesting authorization to use Directory.
-
- Type: string (or Expression with resultType string).'
- name: aad_resource_id
- types:
- - <xref:JSON>
-- description: 'Specify the credential type (key or cert) is used
-
- for service principal. Known values are: "ServicePrincipalKey" and "ServicePrincipalCert".'
- name: aad_service_principal_credential_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ODataAadServicePrincipalCredentialType>
-- description: 'Specify the secret of your application registered in Azure Active
-
- Directory. Type: string (or Expression with resultType string).'
- name: service_principal_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Specify the base64 encoded certificate of your
-
- application registered in Azure Active Directory. Type: string (or Expression
- with resultType
-
- string).'
- name: service_principal_embedded_cert
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- 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).'
- name: service_principal_embedded_cert_password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataResourceDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataResourceDataset.yml
index 68cbc473388e..43b6e228afc7 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataResourceDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataResourceDataset.yml
@@ -10,111 +10,71 @@ 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: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, path: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: path
description: 'The OData resource path. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The OData resource path. Type: string (or Expression with resultType
- string).'
- name: path
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataSource.yml
deleted file mode 100644
index 9b5ae764e163..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataSource.yml
+++ /dev/null
@@ -1,121 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ODataSource
-name: ODataSource
-fullName: azure.synapse.artifacts.models.ODataSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity source for OData source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ODataSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query: MutableMapping[str, Any] | None = None, http_request_timeout:
- MutableMapping[str, Any] | None = None, additional_columns: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query
- description: 'OData query. For example, "$top=1". Type: string (or Expression
- with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: http_request_timeout
- description: 'The timeout (TimeSpan) to get an HTTP response. It is the
-
- timeout to get a response, not the timeout to read response data. Default value:
- 00:05:00.
-
- Type: string (or Expression with resultType string), pattern:
-
- ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'OData query. For example, "$top=1". Type: string (or Expression with
- resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
-- description: 'The timeout (TimeSpan) to get an HTTP response. It is the timeout
-
- to get a response, not the timeout to read response data. Default value: 00:05:00.
- Type: string
-
- (or Expression with resultType string), pattern:
-
- ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: http_request_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcLinkedService.yml
index 2feb4662589a..2bfafeaed7e9 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcLinkedService.yml
@@ -10,57 +10,69 @@ summary: 'Open Database Connectivity (ODBC) linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'OdbcLinkedService(*, connection_string: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, authentication_type:
- MutableMapping[str, Any] | None = None, credential: _models.SecretBase | None
- = None, user_name: MutableMapping[str, Any] | None = None, password: _models.SecretBase
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
- description: 'The non-access credential portion of the connection string as well
+ description: 'Required. The non-access credential portion of the connection string
- as an optional encrypted credential. Type: string, SecureString or
+ as well as an optional encrypted credential. Type: string, SecureString or
- AzureKeyVaultSecretReference. Required.'
+ AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: credential
description: 'The access credential portion of the connection string specified
- in
+ in driver-
- driver-specific property-value format.'
+ specific property-value format.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: user_name
@@ -68,86 +80,21 @@ constructor:
with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: Password for Basic authentication.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The non-access credential portion of the connection string as well
- as
-
- an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.
-
- Required.'
- name: connection_string
- types:
- - <xref:JSON>
-- 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).'
- name: authentication_type
- types:
- - <xref:JSON>
-- description: 'The access credential portion of the connection string specified in
-
- driver-specific property-value format.'
- name: credential
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'User name for Basic authentication. Type: string (or Expression with
-
- resultType string).'
- name: user_name
- types:
- - <xref:JSON>
-- description: Password for Basic authentication.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcSink.yml
deleted file mode 100644
index 76f410325d56..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcSink.yml
+++ /dev/null
@@ -1,108 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.OdbcSink
-name: OdbcSink
-fullName: azure.synapse.artifacts.models.OdbcSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity ODBC sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'OdbcSink(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, write_batch_size: MutableMapping[str, Any] | None = None, write_batch_timeout:
- MutableMapping[str, Any] | None = None, sink_retry_count: MutableMapping[str,
- Any] | None = None, sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, pre_copy_script: MutableMapping[str, Any]
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: pre_copy_script
- description: 'A query to execute before starting the copy. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'A query to execute before starting the copy. Type: string (or Expression
-
- with resultType string).'
- name: pre_copy_script
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcSource.yml
deleted file mode 100644
index 526ed94019f3..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcSource.yml
+++ /dev/null
@@ -1,105 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.OdbcSource
-name: OdbcSource
-fullName: azure.synapse.artifacts.models.OdbcSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity source for ODBC databases.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'OdbcSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'Database query. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'Database query. Type: string (or Expression with resultType string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcTableDataset.yml
index 2d5c3dcaba6a..05de5e60da61 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcTableDataset.yml
@@ -10,110 +10,71 @@ summary: 'The ODBC table dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'OdbcTableDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The ODBC table name. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The ODBC table name. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365Dataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365Dataset.yml
index f47fe8dc6622..440ccc2f1834 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365Dataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365Dataset.yml
@@ -10,127 +10,82 @@ summary: 'The Office365 account.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'Office365Dataset(*, linked_service_name: _models.LinkedServiceReference,
- table_name: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, structure: MutableMapping[str,
- Any] | None = None, schema: MutableMapping[str, Any] | None = None, parameters:
- Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str,
- Any]] | None = None, folder: _models.DatasetFolder | None = None, predicate: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
- description: 'Name of the dataset to extract from Office 365. Type: string (or
+ description: 'Required. Name of the dataset to extract from Office 365. Type:
+ string (or
- Expression with resultType string). Required.'
+ Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'Name of the dataset to extract from Office 365. Type: string (or Expression
-
- with resultType string). Required.'
- name: table_name
- types:
- - <xref:JSON>
-- 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).'
- name: predicate
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365LinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365LinkedService.yml
index e0ea123cbdfd..d0f6fd7c2011 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365LinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365LinkedService.yml
@@ -10,123 +10,79 @@ summary: 'Office365 linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'Office365LinkedService(*, office365_tenant_id: MutableMapping[str, Any],
- service_principal_tenant_id: MutableMapping[str, Any], service_principal_id: MutableMapping[str,
- Any], service_principal_key: _models.SecretBase, additional_properties: Dict[str,
- MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, encrypted_credential:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: office365_tenant_id
- description: 'Azure tenant ID to which the Office 365 account belongs. Type:
+ description: 'Required. Azure tenant ID to which the Office 365 account belongs.
- string (or Expression with resultType string). Required.'
+ Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_tenant_id
- description: 'Specify the tenant information under which your Azure AD
+ description: 'Required. Specify the tenant information under which your
- web application resides. Type: string (or Expression with resultType string).
- Required.'
+ Azure AD web application resides. Type: string (or Expression with resultType
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_id
- description: 'Specify the application''s client ID. Type: string (or Expression
+ description: 'Required. Specify the application''s client ID. Type: string (or
- with resultType string). Required.'
+ Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_key
- description: Specify the application's key. Required.
+ description: Required. Specify the application's key.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Azure tenant ID to which the Office 365 account belongs. Type:
-
- string (or Expression with resultType string). Required.'
- name: office365_tenant_id
- types:
- - <xref:JSON>
-- description: 'Specify the tenant information under which your Azure AD web
-
- application resides. Type: string (or Expression with resultType string). Required.'
- name: service_principal_tenant_id
- types:
- - <xref:JSON>
-- description: 'Specify the application''s client ID. Type: string (or Expression
-
- with resultType string). Required.'
- name: service_principal_id
- types:
- - <xref:JSON>
-- description: Specify the application's key. Required.
- name: service_principal_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365Source.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365Source.yml
deleted file mode 100644
index 88999b6592aa..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365Source.yml
+++ /dev/null
@@ -1,156 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.Office365Source
-name: Office365Source
-fullName: azure.synapse.artifacts.models.Office365Source
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity source for an Office 365 service.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'Office365Source(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, allowed_groups: MutableMapping[str, Any]
- | None = None, user_scope_filter_uri: MutableMapping[str, Any] | None = None,
- date_filter_column: MutableMapping[str, Any] | None = None, start_time: MutableMapping[str,
- Any] | None = None, end_time: MutableMapping[str, Any] | None = None, output_columns:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: allowed_groups
- description: 'The groups containing all the users. Type: array of strings (or
-
- Expression with resultType array of strings).'
- types:
- - <xref:JSON>
- - name: user_scope_filter_uri
- description: 'The user scope uri. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: date_filter_column
- description: 'The Column to apply the `<paramref name="StartTime"/>` and
-
- `<paramref name="EndTime"/>`. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: start_time
- description: 'Start time of the requested range for this dataset. Type: string
- (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: end_time
- description: 'End time of the requested range for this dataset. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: output_columns
- description: 'The columns to be read out from the Office 365 table. Type: array
- of
-
- objects (or Expression with resultType array of objects). itemType: OutputColumn. Example:
- [ {
-
- "name": "Id" }, { "name": "CreatedDateTime" } ].'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'The groups containing all the users. Type: array of strings (or
-
- Expression with resultType array of strings).'
- name: allowed_groups
- types:
- - <xref:JSON>
-- description: 'The user scope uri. Type: string (or Expression with resultType
-
- string).'
- name: user_scope_filter_uri
- types:
- - <xref:JSON>
-- description: 'The Column to apply the `<paramref name="StartTime"/>` and
-
- `<paramref name="EndTime"/>`. Type: string (or Expression with resultType string).'
- name: date_filter_column
- types:
- - <xref:JSON>
-- description: 'Start time of the requested range for this dataset. Type: string (or
-
- Expression with resultType string).'
- name: start_time
- types:
- - <xref:JSON>
-- description: 'End time of the requested range for this dataset. Type: string (or
- Expression
-
- with resultType string).'
- name: end_time
- types:
- - <xref:JSON>
-- description: 'The columns to be read out from the Office 365 table. Type: array
- of
-
- objects (or Expression with resultType array of objects). itemType: OutputColumn. Example:
- [ {
-
- "name": "Id" }, { "name": "CreatedDateTime" } ].'
- name: output_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OperationResult.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OperationResult.yml
deleted file mode 100644
index 96e0f41aa3c9..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OperationResult.yml
+++ /dev/null
@@ -1,53 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.OperationResult
-name: OperationResult
-fullName: azure.synapse.artifacts.models.OperationResult
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Operation status for the operation.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.'
-constructor:
- syntax: 'OperationResult(*, code: str | None = None, message: str | None = None,
- target: str | None = None, details: List[_models.CloudError] | None = None, **kwargs:
- Any)'
- parameters:
- - name: code
- description: Error code.
- types:
- - <xref:str>
- - name: message
- description: Error message.
- types:
- - <xref:str>
- - name: target
- description: Property name/path in request associated with error.
- types:
- - <xref:str>
- - name: details
- description: Array with additional error details.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.CloudError>]
-variables:
-- description: Operation status.
- name: status
- types:
- - <xref:str>
-- description: Error code.
- name: code
- types:
- - <xref:str>
-- description: Error message.
- name: message
- types:
- - <xref:str>
-- description: Property name/path in request associated with error.
- name: target
- types:
- - <xref:str>
-- description: Array with additional error details.
- name: details
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.CloudError>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleLinkedService.yml
index 8278f8af6bbb..cc13215c9ca9 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleLinkedService.yml
@@ -10,97 +10,63 @@ summary: 'Oracle database.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'OracleLinkedService(*, connection_string: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, password:
- _models.AzureKeyVaultSecretReference | None = None, encrypted_credential: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
- description: 'The connection string. Type: string, SecureString or
+ description: 'Required. The connection string. Type: string, SecureString or
- AzureKeyVaultSecretReference. Required.'
+ AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: The Azure key vault secret reference of password in connection string.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference. Required.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of password in connection string.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OraclePartitionOption.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OraclePartitionOption.yml
deleted file mode 100644
index 385546c2da2d..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OraclePartitionOption.yml
+++ /dev/null
@@ -1,19 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.OraclePartitionOption
-name: OraclePartitionOption
-fullName: azure.synapse.artifacts.models.OraclePartitionOption
-summary: The partition mechanism that will be used for Oracle read in parallel.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: OraclePartitionOption(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: DYNAMIC_RANGE
- uid: azure.synapse.artifacts.models.OraclePartitionOption.DYNAMIC_RANGE
-- name: NONE
- uid: azure.synapse.artifacts.models.OraclePartitionOption.NONE
-- name: PHYSICAL_PARTITIONS_OF_TABLE
- uid: azure.synapse.artifacts.models.OraclePartitionOption.PHYSICAL_PARTITIONS_OF_TABLE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OraclePartitionSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OraclePartitionSettings.yml
deleted file mode 100644
index bfc12ca0ec44..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OraclePartitionSettings.yml
+++ /dev/null
@@ -1,71 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.OraclePartitionSettings
-name: OraclePartitionSettings
-fullName: azure.synapse.artifacts.models.OraclePartitionSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: The settings that will be leveraged for Oracle source partitioning.
-constructor:
- syntax: 'OraclePartitionSettings(*, partition_names: MutableMapping[str, Any] |
- None = None, partition_column_name: MutableMapping[str, Any] | None = None, partition_upper_bound:
- MutableMapping[str, Any] | None = None, partition_lower_bound: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: partition_names
- description: Names of the physical partitions of Oracle table.
- types:
- - <xref:JSON>
- - name: partition_column_name
- description: 'The name of the column in integer type that will be used for
-
- proceeding range partitioning. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: partition_upper_bound
- description: 'The maximum value of column specified in partitionColumnName
-
- that will be used for proceeding range partitioning. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: partition_lower_bound
- description: 'The minimum value of column specified in partitionColumnName
-
- that will be used for proceeding range partitioning. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: Names of the physical partitions of Oracle table.
- name: partition_names
- types:
- - <xref:JSON>
-- description: 'The name of the column in integer type that will be used for
-
- proceeding range partitioning. Type: string (or Expression with resultType string).'
- name: partition_column_name
- types:
- - <xref:JSON>
-- description: 'The maximum value of column specified in partitionColumnName that
-
- will be used for proceeding range partitioning. Type: string (or Expression with
- resultType
-
- string).'
- name: partition_upper_bound
- types:
- - <xref:JSON>
-- description: 'The minimum value of column specified in partitionColumnName that
-
- will be used for proceeding range partitioning. Type: string (or Expression with
- resultType
-
- string).'
- name: partition_lower_bound
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudLinkedService.yml
index b55d5ee87f6d..f8ae4f3b71e2 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudLinkedService.yml
@@ -10,60 +10,73 @@ summary: 'Oracle Service Cloud linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'OracleServiceCloudLinkedService(*, host: MutableMapping[str, Any], username:
- MutableMapping[str, Any], password: _models.SecretBase, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, use_encrypted_endpoints:
- MutableMapping[str, Any] | None = None, use_host_verification: MutableMapping[str,
- Any] | None = None, use_peer_verification: MutableMapping[str, Any] | None = None,
- encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: host
- description: The URL of the Oracle Service Cloud instance. Required.
+ description: Required. The URL of the Oracle Service Cloud instance.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: username
- description: The user name that you use to access Oracle Service Cloud server.
- Required.
+ description: Required. The user name that you use to access Oracle Service Cloud
+ server.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
- description: 'The password corresponding to the user name that you provided in
- the
+ description: 'Required. The password corresponding to the user name that you provided
+ in the
- username key. Required.'
+ username key.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: use_encrypted_endpoints
- description: 'Specifies whether the data source endpoints are encrypted
+ description: 'Specifies whether the data source endpoints are encrypted using
- using HTTPS. The default value is true. Type: boolean (or Expression with resultType
+ HTTPS. The default value is true. Type: boolean (or Expression with resultType
boolean).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_host_verification
description: 'Specifies whether to require the host name in the server''s
@@ -71,8 +84,9 @@ constructor:
default value is
true. Type: boolean (or Expression with resultType boolean).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_peer_verification
description: 'Specifies whether to verify the identity of the server when
@@ -80,90 +94,16 @@ constructor:
with resultType
boolean).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The URL of the Oracle Service Cloud instance. Required.
- name: host
- types:
- - <xref:JSON>
-- description: The user name that you use to access Oracle Service Cloud server. Required.
- name: username
- types:
- - <xref:JSON>
-- description: 'The password corresponding to the user name that you provided in the
- username
-
- key. Required.'
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Specifies whether the data source endpoints are encrypted using
-
- HTTPS. The default value is true. Type: boolean (or Expression with resultType
- boolean).'
- name: use_encrypted_endpoints
- types:
- - <xref:JSON>
-- 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).'
- name: use_host_verification
- types:
- - <xref:JSON>
-- 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).'
- name: use_peer_verification
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudObjectDataset.yml
index 12ddf41394e8..3221f0e35169 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudObjectDataset.yml
@@ -10,109 +10,71 @@ summary: 'Oracle Service Cloud dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'OracleServiceCloudObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The table name. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudSource.yml
deleted file mode 100644
index e02e306e4f0a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.OracleServiceCloudSource
-name: OracleServiceCloudSource
-fullName: azure.synapse.artifacts.models.OracleServiceCloudSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Oracle Service Cloud source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'OracleServiceCloudSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, query:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleSink.yml
deleted file mode 100644
index 7caf3075baed..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleSink.yml
+++ /dev/null
@@ -1,108 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.OracleSink
-name: OracleSink
-fullName: azure.synapse.artifacts.models.OracleSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Oracle sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'OracleSink(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, write_batch_size: MutableMapping[str, Any] | None = None, write_batch_timeout:
- MutableMapping[str, Any] | None = None, sink_retry_count: MutableMapping[str,
- Any] | None = None, sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, pre_copy_script: MutableMapping[str, Any]
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: pre_copy_script
- description: 'SQL pre-copy script. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'SQL pre-copy script. Type: string (or Expression with resultType
-
- string).'
- name: pre_copy_script
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleSource.yml
deleted file mode 100644
index a331617e14e3..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleSource.yml
+++ /dev/null
@@ -1,135 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.OracleSource
-name: OracleSource
-fullName: azure.synapse.artifacts.models.OracleSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity Oracle source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'OracleSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, oracle_reader_query: MutableMapping[str, Any] | None = None,
- query_timeout: MutableMapping[str, Any] | None = None, partition_option: str |
- _models.OraclePartitionOption | None = None, partition_settings: _models.OraclePartitionSettings
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: oracle_reader_query
- description: 'Oracle reader query. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: partition_option
- description: 'The partition mechanism that will be used for Oracle read in
-
- parallel. Known values are: "None", "PhysicalPartitionsOfTable", and "DynamicRange".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.OraclePartitionOption>
- - name: partition_settings
- description: 'The settings that will be leveraged for Oracle source
-
- partitioning.'
- types:
- - <xref:azure.synapse.artifacts.models.OraclePartitionSettings>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Oracle reader query. Type: string (or Expression with resultType
-
- string).'
- name: oracle_reader_query
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'The partition mechanism that will be used for Oracle read in parallel.
-
- Known values are: "None", "PhysicalPartitionsOfTable", and "DynamicRange".'
- name: partition_option
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.OraclePartitionOption>
-- description: The settings that will be leveraged for Oracle source partitioning.
- name: partition_settings
- types:
- - <xref:azure.synapse.artifacts.models.OraclePartitionSettings>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleTableDataset.yml
index 8b68c26cab72..ff35e4320d9f 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleTableDataset.yml
@@ -10,140 +10,88 @@ 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: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, schema_type_properties_schema: MutableMapping[str, Any] | None = None,
- table: MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'This property will be retired. Please consider using schema + table
properties instead.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: schema_type_properties_schema
- description: 'The schema name of the on-premises Oracle database.
+ description: 'The schema name of the on-premises Oracle database. Type:
- Type: string (or Expression with resultType string).'
+ string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: table
description: 'The table name of the on-premises Oracle database. Type: string
(or Expression
with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'This property will be retired. Please consider using schema + table
-
- properties instead.'
- name: table_name
- types:
- - <xref:JSON>
-- description: 'The schema name of the on-premises Oracle database. Type:
-
- string (or Expression with resultType string).'
- name: schema_type_properties_schema
- types:
- - <xref:JSON>
-- description: 'The table name of the on-premises Oracle database. Type: string (or
- Expression
-
- with resultType string).'
- name: table
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcCompressionCodec.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcCompressionCodec.yml
index cea15c515d6a..5367a15be31a 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcCompressionCodec.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcCompressionCodec.yml
@@ -2,7 +2,6 @@
uid: azure.synapse.artifacts.models.OrcCompressionCodec
name: OrcCompressionCodec
fullName: azure.synapse.artifacts.models.OrcCompressionCodec
-summary: OrcCompressionCodec.
module: azure.synapse.artifacts.models
constructor:
syntax: OrcCompressionCodec(value, names=None, *, module=None, qualname=None, type=None,
@@ -11,11 +10,9 @@ inheritances:
- builtins.str
- enum.Enum
fields:
-- name: LZO
- uid: azure.synapse.artifacts.models.OrcCompressionCodec.LZO
-- 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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcDataset.yml
index e9bc3c28c2f2..6336276e238d 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcDataset.yml
@@ -10,121 +10,77 @@ summary: 'ORC dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'OrcDataset(*, linked_service_name: _models.LinkedServiceReference, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None,
- structure: MutableMapping[str, Any] | None = None, schema: MutableMapping[str,
- Any] | None = None, parameters: Dict[str, _models.ParameterSpecification] | None
- = None, annotations: List[MutableMapping[str, Any]] | None = None, folder: _models.DatasetFolder
- | None = None, location: _models.DatasetLocation | None = None, orc_compression_codec:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: location
description: The location of the ORC data storage.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetLocation>
- name: orc_compression_codec
- description: 'The data orcCompressionCodec. Type: string (or Expression with
-
- resultType string).'
+ description: 'Possible values include: "none", "zlib", "snappy".'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: The location of the ORC data storage.
- name: location
- types:
- - <xref:azure.synapse.artifacts.models.DatasetLocation>
-- description: 'The data orcCompressionCodec. Type: string (or Expression with
-
- resultType string).'
- name: orc_compression_codec
- types:
- - <xref:JSON>
+ - <xref:str>
+ - <xref:azure.synapse.artifacts.models.OrcCompressionCodec>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcFormat.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcFormat.yml
deleted file mode 100644
index d42a329c441d..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcFormat.yml
+++ /dev/null
@@ -1,49 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.OrcFormat
-name: OrcFormat
-fullName: azure.synapse.artifacts.models.OrcFormat
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.DatasetStorageFormat
-summary: 'The data stored in Optimized Row Columnar (ORC) format.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'OrcFormat(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, serializer: MutableMapping[str, Any] | None = None, deserializer:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: serializer
- description: 'Serializer. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: deserializer
- description: 'Deserializer. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset storage format. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Serializer. Type: string (or Expression with resultType string).'
- name: serializer
- types:
- - <xref:JSON>
-- description: 'Deserializer. Type: string (or Expression with resultType string).'
- name: deserializer
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcSink.yml
deleted file mode 100644
index b8f78bae49e2..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcSink.yml
+++ /dev/null
@@ -1,113 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.OrcSink
-name: OrcSink
-fullName: azure.synapse.artifacts.models.OrcSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity ORC sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'OrcSink(*, additional_properties: Dict[str, MutableMapping[str, Any]] |
- None = None, write_batch_size: MutableMapping[str, Any] | None = None, write_batch_timeout:
- MutableMapping[str, Any] | None = None, sink_retry_count: MutableMapping[str,
- Any] | None = None, sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, store_settings: _models.StoreWriteSettings
- | None = None, format_settings: _models.OrcWriteSettings | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: store_settings
- description: ORC store settings.
- types:
- - <xref:azure.synapse.artifacts.models.StoreWriteSettings>
- - name: format_settings
- description: ORC format settings.
- types:
- - <xref:azure.synapse.artifacts.models.OrcWriteSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: ORC store settings.
- name: store_settings
- types:
- - <xref:azure.synapse.artifacts.models.StoreWriteSettings>
-- description: ORC format settings.
- name: format_settings
- types:
- - <xref:azure.synapse.artifacts.models.OrcWriteSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcSource.yml
deleted file mode 100644
index ce9fb62fc881..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcSource.yml
+++ /dev/null
@@ -1,92 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.OrcSource
-name: OrcSource
-fullName: azure.synapse.artifacts.models.OrcSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity ORC source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'OrcSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, store_settings: _models.StoreReadSettings | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: store_settings
- description: ORC store settings.
- types:
- - <xref:azure.synapse.artifacts.models.StoreReadSettings>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: ORC store settings.
- name: store_settings
- types:
- - <xref:azure.synapse.artifacts.models.StoreReadSettings>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcWriteSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcWriteSettings.yml
deleted file mode 100644
index 7799a9c09fcd..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcWriteSettings.yml
+++ /dev/null
@@ -1,67 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.OrcWriteSettings
-name: OrcWriteSettings
-fullName: azure.synapse.artifacts.models.OrcWriteSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.FormatWriteSettings
-summary: 'Orc write settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'OrcWriteSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, max_rows_per_file: MutableMapping[str, Any] | None = None,
- file_name_prefix: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: max_rows_per_file
- description: 'Limit the written file''s row count to be smaller than or equal
- to
-
- the specified count. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: file_name_prefix
- description: 'Specifies the file name pattern
-
- >>:code:`<fileNamePrefix>`_<<`<fileIndex>`.:code:*<fileExtension>* when copy
- from non-file
-
- based store without partitionOptions. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The write setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Limit the written file''s row count to be smaller than or equal to
- the
-
- specified count. Type: integer (or Expression with resultType integer).'
- name: max_rows_per_file
- types:
- - <xref:JSON>
-- description: 'Specifies the file name pattern
-
- >>:code:`<fileNamePrefix>`_<<`<fileIndex>`.:code:*<fileExtension>* when copy from
- non-file
-
- based store without partitionOptions. Type: string (or Expression with resultType
- string).'
- name: file_name_prefix
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OutputColumn.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OutputColumn.yml
deleted file mode 100644
index ee57f0aa2d39..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OutputColumn.yml
+++ /dev/null
@@ -1,20 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.OutputColumn
-name: OutputColumn
-fullName: azure.synapse.artifacts.models.OutputColumn
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: The columns to be read out from the Office 365 table.
-constructor:
- syntax: 'OutputColumn(*, name: str | None = None, **kwargs: Any)'
- parameters:
- - name: name
- description: 'Name of the table column. Type: string.'
- types:
- - <xref:str>
-variables:
-- description: 'Name of the table column. Type: string.'
- name: name
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParameterSpecification.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParameterSpecification.yml
index 71a674a0887c..f923b5c7f4e9 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParameterSpecification.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParameterSpecification.yml
@@ -4,37 +4,26 @@ name: ParameterSpecification
fullName: azure.synapse.artifacts.models.ParameterSpecification
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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 | _models.ParameterType, default_value:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ syntax: 'ParameterSpecification(*, type: str | ParameterType, default_value: object
+ | None = None, **kwargs)'
parameters:
- name: type
- description: 'Parameter type. Required. Known values are: "Object", "String",
- "Int", "Float",
+ description: 'Required. Parameter type. Possible values include: "Object", "String",
+ "Int",
- "Bool", "Array", and "SecureString".'
+ "Float", "Bool", "Array", "SecureString".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.ParameterType>
- name: default_value
description: Default value of parameter.
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Parameter type. Required. Known values are: "Object", "String", "Int",
- "Float",
-
- "Bool", "Array", and "SecureString".'
- name: type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ParameterType>
-- description: Default value of parameter.
- name: default_value
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParameterType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParameterType.yml
index 399265573fac..08811302b369 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParameterType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParameterType.yml
@@ -11,17 +11,17 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetCompressionCodec.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetCompressionCodec.yml
new file mode 100644
index 000000000000..758a9e709a59
--- /dev/null
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetCompressionCodec.yml
@@ -0,0 +1,20 @@
+### YamlMime:PythonEnum
+uid: azure.synapse.artifacts.models.ParquetCompressionCodec
+name: ParquetCompressionCodec
+fullName: azure.synapse.artifacts.models.ParquetCompressionCodec
+module: azure.synapse.artifacts.models
+constructor:
+ syntax: ParquetCompressionCodec(value, names=None, *, module=None, qualname=None,
+ type=None, start=1, boundary=None)
+inheritances:
+- builtins.str
+- enum.Enum
+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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetCompressionCodecEnum.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetCompressionCodecEnum.yml
deleted file mode 100644
index 737cb5a6a3f6..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetCompressionCodecEnum.yml
+++ /dev/null
@@ -1,21 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.ParquetCompressionCodecEnum
-name: ParquetCompressionCodecEnum
-fullName: azure.synapse.artifacts.models.ParquetCompressionCodecEnum
-summary: ParquetCompressionCodecEnum.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: ParquetCompressionCodecEnum(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: GZIP
- uid: azure.synapse.artifacts.models.ParquetCompressionCodecEnum.GZIP
-- name: LZO
- uid: azure.synapse.artifacts.models.ParquetCompressionCodecEnum.LZO
-- name: NONE
- uid: azure.synapse.artifacts.models.ParquetCompressionCodecEnum.NONE
-- name: SNAPPY
- uid: azure.synapse.artifacts.models.ParquetCompressionCodecEnum.SNAPPY
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetDataset.yml
index fd550a4fe484..35a0ce2bcde9 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetDataset.yml
@@ -10,117 +10,77 @@ summary: 'Parquet dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'ParquetDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, location: _models.DatasetLocation | None
- = None, compression_codec: MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: location
description: The location of the parquet storage.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetLocation>
- name: compression_codec
- description: A string from ParquetCompressionCodecEnum or an expression.
+ description: 'Possible values include: "none", "gzip", "snappy", "lzo".'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: The location of the parquet storage.
- name: location
- types:
- - <xref:azure.synapse.artifacts.models.DatasetLocation>
-- description: A string from ParquetCompressionCodecEnum or an expression.
- name: compression_codec
- types:
- - <xref:JSON>
+ - <xref:str>
+ - <xref:azure.synapse.artifacts.models.ParquetCompressionCodec>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetFormat.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetFormat.yml
deleted file mode 100644
index 348ab4e0d1ed..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetFormat.yml
+++ /dev/null
@@ -1,49 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ParquetFormat
-name: ParquetFormat
-fullName: azure.synapse.artifacts.models.ParquetFormat
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.DatasetStorageFormat
-summary: 'The data stored in Parquet format.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ParquetFormat(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, serializer: MutableMapping[str, Any] | None = None, deserializer:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: serializer
- description: 'Serializer. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: deserializer
- description: 'Deserializer. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset storage format. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Serializer. Type: string (or Expression with resultType string).'
- name: serializer
- types:
- - <xref:JSON>
-- description: 'Deserializer. Type: string (or Expression with resultType string).'
- name: deserializer
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetSink.yml
deleted file mode 100644
index d3c11aa5b992..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetSink.yml
+++ /dev/null
@@ -1,113 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ParquetSink
-name: ParquetSink
-fullName: azure.synapse.artifacts.models.ParquetSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Parquet sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ParquetSink(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, write_batch_size: MutableMapping[str, Any] | None = None, write_batch_timeout:
- MutableMapping[str, Any] | None = None, sink_retry_count: MutableMapping[str,
- Any] | None = None, sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, store_settings: _models.StoreWriteSettings
- | None = None, format_settings: _models.ParquetWriteSettings | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: store_settings
- description: Parquet store settings.
- types:
- - <xref:azure.synapse.artifacts.models.StoreWriteSettings>
- - name: format_settings
- description: Parquet format settings.
- types:
- - <xref:azure.synapse.artifacts.models.ParquetWriteSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: Parquet store settings.
- name: store_settings
- types:
- - <xref:azure.synapse.artifacts.models.StoreWriteSettings>
-- description: Parquet format settings.
- name: format_settings
- types:
- - <xref:azure.synapse.artifacts.models.ParquetWriteSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetSource.yml
deleted file mode 100644
index 63ef67d543ef..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetSource.yml
+++ /dev/null
@@ -1,92 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ParquetSource
-name: ParquetSource
-fullName: azure.synapse.artifacts.models.ParquetSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity Parquet source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ParquetSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, store_settings: _models.StoreReadSettings | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: store_settings
- description: Parquet store settings.
- types:
- - <xref:azure.synapse.artifacts.models.StoreReadSettings>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: Parquet store settings.
- name: store_settings
- types:
- - <xref:azure.synapse.artifacts.models.StoreReadSettings>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetWriteSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetWriteSettings.yml
deleted file mode 100644
index 423a7c76950f..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetWriteSettings.yml
+++ /dev/null
@@ -1,67 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ParquetWriteSettings
-name: ParquetWriteSettings
-fullName: azure.synapse.artifacts.models.ParquetWriteSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.FormatWriteSettings
-summary: 'Parquet write settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ParquetWriteSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, max_rows_per_file: MutableMapping[str, Any] | None = None,
- file_name_prefix: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: max_rows_per_file
- description: 'Limit the written file''s row count to be smaller than or equal
- to
-
- the specified count. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: file_name_prefix
- description: 'Specifies the file name pattern
-
- >>:code:`<fileNamePrefix>`_<<`<fileIndex>`.:code:*<fileExtension>* when copy
- from non-file
-
- based store without partitionOptions. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The write setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Limit the written file''s row count to be smaller than or equal to
- the
-
- specified count. Type: integer (or Expression with resultType integer).'
- name: max_rows_per_file
- types:
- - <xref:JSON>
-- description: 'Specifies the file name pattern
-
- >>:code:`<fileNamePrefix>`_<<`<fileIndex>`.:code:*<fileExtension>* when copy from
- non-file
-
- based store without partitionOptions. Type: string (or Expression with resultType
- string).'
- name: file_name_prefix
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalLinkedService.yml
index 3119b83be8c1..4043e7b803e7 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalLinkedService.yml
@@ -10,57 +10,68 @@ summary: 'Paypal Service linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'PaypalLinkedService(*, host: MutableMapping[str, Any], client_id: MutableMapping[str,
- Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- connect_via: _models.IntegrationRuntimeReference | None = None, description: str
- | None = None, parameters: Dict[str, _models.ParameterSpecification] | None =
- None, annotations: List[MutableMapping[str, Any]] | None = None, client_secret:
- _models.SecretBase | None = None, use_encrypted_endpoints: MutableMapping[str,
- Any] | None = None, use_host_verification: MutableMapping[str, Any] | None = None,
- use_peer_verification: MutableMapping[str, Any] | None = None, encrypted_credential:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: host
- description: "The URL\_of the PayPal instance. (i.e. api.sandbox.paypal.com).\
- \ Required."
+ description: "Required. The URL\_of the PayPal instance. (i.e. api.sandbox.paypal.com)."
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: client_id
- description: The client ID associated with your PayPal application. Required.
+ description: Required. The client ID associated with your PayPal application.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: client_secret
description: The client secret associated with your PayPal application.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: use_encrypted_endpoints
- description: 'Specifies whether the data source endpoints are encrypted
+ description: 'Specifies whether the data source endpoints are encrypted using
- using HTTPS. The default value is true.'
+ HTTPS. The default value is true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_host_verification
description: 'Specifies whether to require the host name in the server''s
@@ -68,89 +79,23 @@ constructor:
default value is
true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: "The URL\_of the PayPal instance. (i.e. api.sandbox.paypal.com). Required."
- name: host
- types:
- - <xref:JSON>
-- description: The client ID associated with your PayPal application. Required.
- name: client_id
- types:
- - <xref:JSON>
-- description: The client secret associated with your PayPal application.
- name: client_secret
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Specifies whether the data source endpoints are encrypted using
-
- HTTPS. The default value is true.'
- name: use_encrypted_endpoints
- types:
- - <xref:JSON>
-- 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.'
- name: use_host_verification
- types:
- - <xref:JSON>
-- description: 'Specifies whether to verify the identity of the server when
-
- connecting over SSL. The default value is true.'
- name: use_peer_verification
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalObjectDataset.yml
index 8d1caee81f3f..3cbcfc05b310 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalObjectDataset.yml
@@ -10,109 +10,70 @@ summary: 'Paypal Service dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'PaypalObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The table name. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalSource.yml
deleted file mode 100644
index a1b8ec058798..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.PaypalSource
-name: PaypalSource
-fullName: azure.synapse.artifacts.models.PaypalSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Paypal Service source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'PaypalSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixAuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixAuthenticationType.yml
index 42c464cbb648..2ffed5fa55b5 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixAuthenticationType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixAuthenticationType.yml
@@ -11,9 +11,9 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixLinkedService.yml
index b2a8504cb6c4..70437a646d0f 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixLinkedService.yml
@@ -10,231 +10,141 @@ summary: 'Phoenix server linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'PhoenixLinkedService(*, host: MutableMapping[str, Any], authentication_type:
- str | _models.PhoenixAuthenticationType, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, port:
- MutableMapping[str, Any] | None = None, http_path: MutableMapping[str, Any] |
- None = None, username: MutableMapping[str, Any] | None = None, password: _models.SecretBase
- | None = None, enable_ssl: MutableMapping[str, Any] | None = None, trusted_cert_path:
- MutableMapping[str, Any] | None = None, use_system_trust_store: MutableMapping[str,
- Any] | None = None, allow_host_name_cn_mismatch: MutableMapping[str, Any] | None
- = None, allow_self_signed_server_cert: MutableMapping[str, Any] | None = None,
- encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: host
- description: 'The IP address or host name of the Phoenix server. (i.e. 192.168.222.160).
+ description: 'Required. The IP address or host name of the Phoenix server. (i.e.
- Required.'
+ 192.168.222.160).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: port
description: 'The TCP port that the Phoenix server uses to listen for client connections.
The
default value is 8765.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: authentication_type
- description: 'The authentication mechanism used to connect to the Phoenix
+ description: 'Required. The authentication mechanism used to connect to the
- server. Required. Known values are: "Anonymous", "UsernameAndPassword", and
+ Phoenix server. Possible values include: "Anonymous", "UsernameAndPassword",
"WindowsAzureHDInsightService".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.PhoenixAuthenticationType>
- name: username
description: The user name used to connect to the Phoenix server.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: The password corresponding to the user name.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: enable_ssl
description: 'Specifies whether the connections to the server are encrypted using
- SSL.
+ SSL. The
- The default value is false.'
+ default value is false.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: trusted_cert_path
description: 'The full path of the .pem file containing trusted CA certificates
+ for
- for verifying the server when connecting over SSL. This property can only be
- set when using SSL
+ verifying the server when connecting over SSL. This property can only be set
+ when using SSL on
- on self-hosted IR. The default value is the cacerts.pem file installed with
- the IR.'
+ self-hosted IR. The default value is the cacerts.pem file installed with the
+ IR.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_system_trust_store
- description: 'Specifies whether to use a CA certificate from the system
+ description: 'Specifies whether to use a CA certificate from the system trust
- trust store or from a specified PEM file. The default value is false.'
+ store or from a specified PEM file. The default value is false.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: allow_self_signed_server_cert
- description: 'Specifies whether to allow self-signed certificates
+ description: 'Specifies whether to allow self-signed certificates from
- from the server. The default value is false.'
+ the server. The default value is false.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The IP address or host name of the Phoenix server. (i.e. 192.168.222.160).
-
- Required.'
- name: host
- types:
- - <xref:JSON>
-- description: 'The TCP port that the Phoenix server uses to listen for client connections.
- The
-
- default value is 8765.'
- name: port
- types:
- - <xref:JSON>
-- description: 'The partial URL corresponding to the Phoenix server. (i.e.
-
- /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using
-
- WindowsAzureHDInsightService.'
- name: http_path
- types:
- - <xref:JSON>
-- description: 'The authentication mechanism used to connect to the Phoenix server.
-
- Required. Known values are: "Anonymous", "UsernameAndPassword", and
-
- "WindowsAzureHDInsightService".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.PhoenixAuthenticationType>
-- description: The user name used to connect to the Phoenix server.
- name: username
- types:
- - <xref:JSON>
-- description: The password corresponding to the user name.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Specifies whether the connections to the server are encrypted using
- SSL. The
-
- default value is false.'
- name: enable_ssl
- types:
- - <xref:JSON>
-- 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.'
- name: trusted_cert_path
- types:
- - <xref:JSON>
-- description: 'Specifies whether to use a CA certificate from the system trust
-
- store or from a specified PEM file. The default value is false.'
- name: use_system_trust_store
- types:
- - <xref:JSON>
-- 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.'
- name: allow_host_name_cn_mismatch
- types:
- - <xref:JSON>
-- description: 'Specifies whether to allow self-signed certificates from
-
- the server. The default value is false.'
- name: allow_self_signed_server_cert
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ 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:
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixObjectDataset.yml
index 9f79cd7f6880..60fad4f21500 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixObjectDataset.yml
@@ -10,139 +10,88 @@ summary: 'Phoenix server dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'PhoenixObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, table: MutableMapping[str, Any] | None = None, schema_type_properties_schema:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'This property will be retired. Please consider using schema + table
properties instead.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: table
description: 'The table name of the Phoenix. Type: string (or Expression with
resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: schema_type_properties_schema
description: 'The schema name of the Phoenix. Type: string (or
Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'This property will be retired. Please consider using schema + table
-
- properties instead.'
- name: table_name
- types:
- - <xref:JSON>
-- description: 'The table name of the Phoenix. Type: string (or Expression with resultType
-
- string).'
- name: table
- types:
- - <xref:JSON>
-- description: 'The schema name of the Phoenix. Type: string (or
-
- Expression with resultType string).'
- name: schema_type_properties_schema
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixSource.yml
deleted file mode 100644
index a3ceefdd5b3f..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.PhoenixSource
-name: PhoenixSource
-fullName: azure.synapse.artifacts.models.PhoenixSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Phoenix server source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'PhoenixSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineFolder.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineFolder.yml
index 3a91a4f5ec60..1a870beaea18 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineFolder.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineFolder.yml
@@ -4,18 +4,14 @@ name: PipelineFolder
fullName: azure.synapse.artifacts.models.PipelineFolder
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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: Any)'
+ syntax: 'PipelineFolder(*, name: str | None = None, **kwargs)'
parameters:
- name: name
description: The name of the folder that this Pipeline is in.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: The name of the folder that this Pipeline is in.
- name: name
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineListResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineListResponse.yml
index c24f1e421b52..c3b1c4deb7dd 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineListResponse.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineListResponse.yml
@@ -4,29 +4,22 @@ name: PipelineListResponse
fullName: azure.synapse.artifacts.models.PipelineListResponse
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'A list of pipeline resources.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'PipelineListResponse(*, value: List[_models.PipelineResource], next_link:
- str | None = None, **kwargs: Any)'
+ syntax: 'PipelineListResponse(*, value: List[PipelineResource], next_link: str |
+ None = None, **kwargs)'
parameters:
- name: value
- description: List of pipelines. Required.
+ description: Required. List of pipelines.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.PipelineResource>]
- name: next_link
description: The link to the next page of results, if any remaining results exist.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: List of pipelines. Required.
- name: value
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.PipelineResource>]
-- description: The link to the next page of results, if any remaining results exist.
- name: next_link
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineReference.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineReference.yml
index cb99dda4d3bb..8831d26c1643 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineReference.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineReference.yml
@@ -4,39 +4,33 @@ name: PipelineReference
fullName: azure.synapse.artifacts.models.PipelineReference
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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(*, type: str | _models.PipelineReferenceType, reference_name:
- str, name: str | None = None, **kwargs: Any)'
+ syntax: 'PipelineReference(*, reference_name: str, name: str | None = None, **kwargs)'
parameters:
- - name: type
- description: Pipeline reference type. Required. "PipelineReference"
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.PipelineReferenceType>
- name: reference_name
- description: Reference pipeline name. Required.
+ description: Required. Reference pipeline name.
+ isRequired: true
types:
- <xref:str>
- name: name
description: Reference name.
+ isRequired: true
types:
- <xref:str>
variables:
-- description: Pipeline reference type. Required. "PipelineReference"
+- description: 'Required. Pipeline reference type. Default value: "PipelineReference".'
name: type
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.PipelineReferenceType>
-- description: Reference pipeline name. Required.
- name: reference_name
- types:
- - <xref:str>
-- description: Reference name.
- name: name
- types:
- - <xref:str>
+attributes:
+- uid: azure.synapse.artifacts.models.PipelineReference.type
+ name: type
+ signature: type = 'PipelineReference'
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineReferenceType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineReferenceType.yml
deleted file mode 100644
index 6dab47b9ca9d..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineReferenceType.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.PipelineReferenceType
-name: PipelineReferenceType
-fullName: azure.synapse.artifacts.models.PipelineReferenceType
-summary: Pipeline reference type.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: PipelineReferenceType(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: PIPELINE_REFERENCE
- uid: azure.synapse.artifacts.models.PipelineReferenceType.PIPELINE_REFERENCE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineResource.yml
index eed03468f270..136735a7c2f2 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineResource.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineResource.yml
@@ -10,115 +10,77 @@ 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, MutableMapping[str,
- Any]] | None = None, description: str | None = None, activities: List[_models.Activity]
- | None = None, parameters: Dict[str, _models.ParameterSpecification] | None =
- None, variables: Dict[str, _models.VariableSpecification] | None = None, concurrency:
- int | None = None, annotations: List[MutableMapping[str, Any]] | None = None,
- run_dimensions: Dict[str, MutableMapping[str, Any]] | None = None, folder: _models.PipelineFolder
- | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: description
description: The description of the pipeline.
+ isRequired: true
types:
- <xref:str>
- name: activities
description: List of activities in pipeline.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.Activity>]
- name: parameters
description: List of parameters for pipeline.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: variables
description: List of variables for pipeline.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.VariableSpecification>]
- name: concurrency
description: The max number of concurrent runs for the pipeline.
+ isRequired: true
types:
- <xref:int>
- name: annotations
description: List of tags that can be used for describing the Pipeline.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: run_dimensions
description: Dimensions emitted by Pipeline.
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: folder
description: 'The folder that this Pipeline is in. If not specified, Pipeline
will appear at
the root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.PipelineFolder>
variables:
-- description: 'Fully qualified resource ID for the resource. Ex -
-
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.'
+- description: The resource identifier.
name: id
types:
- <xref:str>
-- description: The name of the resource.
+- description: The resource name.
name: name
types:
- <xref:str>
-- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines"
- or
-
- "Microsoft.Storage/storageAccounts".'
+- description: The resource type.
name: type
types:
- <xref:str>
-- description: Resource Etag.
+- description: Etag identifies change in the resource.
name: etag
types:
- <xref:str>
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The description of the pipeline.
- name: description
- types:
- - <xref:str>
-- description: List of activities in pipeline.
- name: activities
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.Activity>]
-- description: List of parameters for pipeline.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of variables for pipeline.
- name: variables
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.VariableSpecification>]
-- description: The max number of concurrent runs for the pipeline.
- name: concurrency
- types:
- - <xref:int>
-- description: List of tags that can be used for describing the Pipeline.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: Dimensions emitted by Pipeline.
- name: run_dimensions
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: 'The folder that this Pipeline is in. If not specified, Pipeline will
- appear at
-
- the root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.PipelineFolder>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRun.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRun.yml
index 53da55e9e8aa..0d5cc536b9ac 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRun.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRun.yml
@@ -4,28 +4,23 @@ name: PipelineRun
fullName: azure.synapse.artifacts.models.PipelineRun
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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, MutableMapping[str, Any]]
- | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- description: Identifier of a run.
name: run_id
types:
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRunInvokedBy.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRunInvokedBy.yml
index f03851f7576c..ce899dc6a2cd 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRunInvokedBy.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRunInvokedBy.yml
@@ -4,13 +4,13 @@ name: PipelineRunInvokedBy
fullName: azure.synapse.artifacts.models.PipelineRunInvokedBy
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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: Any)'
+ syntax: PipelineRunInvokedBy(**kwargs)
variables:
- description: Name of the entity that started the pipeline run.
name: name
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRunsQueryResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRunsQueryResponse.yml
index d6ef954e8010..ce13a8afffef 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRunsQueryResponse.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRunsQueryResponse.yml
@@ -4,33 +4,25 @@ name: PipelineRunsQueryResponse
fullName: azure.synapse.artifacts.models.PipelineRunsQueryResponse
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'A list pipeline runs.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'PipelineRunsQueryResponse(*, value: List[_models.PipelineRun], continuation_token:
- str | None = None, **kwargs: Any)'
+ syntax: 'PipelineRunsQueryResponse(*, value: List[PipelineRun], continuation_token:
+ str | None = None, **kwargs)'
parameters:
- name: value
- description: List of pipeline runs. Required.
+ description: Required. List of pipeline runs.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.PipelineRun>]
- name: continuation_token
description: 'The continuation token for getting the next page of results, if
+ any
- any remaining results exist, null otherwise.'
+ remaining results exist, null otherwise.'
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: List of pipeline runs. Required.
- name: value
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.PipelineRun>]
-- description: 'The continuation token for getting the next page of results, if any
-
- remaining results exist, null otherwise.'
- name: continuation_token
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PluginCurrentState.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PluginCurrentState.yml
index 17239be97074..14e118fbf430 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PluginCurrentState.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PluginCurrentState.yml
@@ -2,7 +2,6 @@
uid: azure.synapse.artifacts.models.PluginCurrentState
name: PluginCurrentState
fullName: azure.synapse.artifacts.models.PluginCurrentState
-summary: PluginCurrentState.
module: azure.synapse.artifacts.models
constructor:
syntax: PluginCurrentState(value, names=None, *, module=None, qualname=None, type=None,
@@ -11,17 +10,17 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PolybaseSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PolybaseSettings.yml
deleted file mode 100644
index 2a41415740df..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PolybaseSettings.yml
+++ /dev/null
@@ -1,89 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.PolybaseSettings
-name: PolybaseSettings
-fullName: azure.synapse.artifacts.models.PolybaseSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: PolyBase settings.
-constructor:
- syntax: 'PolybaseSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, reject_type: str | _models.PolybaseSettingsRejectType | None
- = None, reject_value: MutableMapping[str, Any] | None = None, reject_sample_value:
- MutableMapping[str, Any] | None = None, use_type_default: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: reject_type
- description: 'Reject type. Known values are: "value" and "percentage".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.PolybaseSettingsRejectType>
- - name: reject_value
- description: 'Specifies the value or the percentage of rows that can be rejected
-
- before the query fails. Type: number (or Expression with resultType number),
- minimum: 0.'
- types:
- - <xref:JSON>
- - name: reject_sample_value
- description: 'Determines the number of rows to attempt to retrieve before the
-
- PolyBase recalculates the percentage of rejected rows. Type: integer (or Expression
- with
-
- resultType integer), minimum: 0.'
- types:
- - <xref:JSON>
- - name: use_type_default
- description: 'Specifies how to handle missing values in delimited text files when
-
- PolyBase retrieves data from the text file. Type: boolean (or Expression with
- resultType
-
- boolean).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: 'Reject type. Known values are: "value" and "percentage".'
- name: reject_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.PolybaseSettingsRejectType>
-- description: 'Specifies the value or the percentage of rows that can be rejected
- before
-
- the query fails. Type: number (or Expression with resultType number), minimum:
- 0.'
- name: reject_value
- types:
- - <xref:JSON>
-- description: 'Determines the number of rows to attempt to retrieve before the
-
- PolyBase recalculates the percentage of rejected rows. Type: integer (or Expression
- with
-
- resultType integer), minimum: 0.'
- name: reject_sample_value
- types:
- - <xref:JSON>
-- description: 'Specifies how to handle missing values in delimited text files when
-
- PolyBase retrieves data from the text file. Type: boolean (or Expression with
- resultType
-
- boolean).'
- name: use_type_default
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PolybaseSettingsRejectType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PolybaseSettingsRejectType.yml
deleted file mode 100644
index d6f23b8879ee..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PolybaseSettingsRejectType.yml
+++ /dev/null
@@ -1,18 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.PolybaseSettingsRejectType
-name: PolybaseSettingsRejectType
-fullName: azure.synapse.artifacts.models.PolybaseSettingsRejectType
-summary: Indicates whether the RejectValue property is specified as a literal value
- or a percentage.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: PolybaseSettingsRejectType(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: PERCENTAGE
- uid: azure.synapse.artifacts.models.PolybaseSettingsRejectType.PERCENTAGE
-- name: VALUE
- uid: azure.synapse.artifacts.models.PolybaseSettingsRejectType.VALUE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlLinkedService.yml
index 8cff19629d97..e8944eb768ee 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlLinkedService.yml
@@ -10,94 +10,61 @@ summary: 'Linked service for PostgreSQL data source.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'PostgreSqlLinkedService(*, connection_string: MutableMapping[str, Any],
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, connect_via:
- _models.IntegrationRuntimeReference | None = None, description: str | None = None,
- parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations:
- List[MutableMapping[str, Any]] | None = None, password: _models.AzureKeyVaultSecretReference
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
- description: The connection string. Required.
+ description: Required. The connection string.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: The Azure key vault secret reference of password in connection string.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The connection string. Required.
- name: connection_string
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of password in connection string.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlSource.yml
deleted file mode 100644
index e5b36b96fec1..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlSource.yml
+++ /dev/null
@@ -1,105 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.PostgreSqlSource
-name: PostgreSqlSource
-fullName: azure.synapse.artifacts.models.PostgreSqlSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity source for PostgreSQL databases.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'PostgreSqlSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, query:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'Database query. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'Database query. Type: string (or Expression with resultType string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlTableDataset.yml
index a41acde684e0..d09dcedb7fd9 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlTableDataset.yml
@@ -10,136 +10,87 @@ summary: 'The PostgreSQL table dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'PostgreSqlTableDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, table: MutableMapping[str, Any] | None = None, schema_type_properties_schema:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'This property will be retired. Please consider using schema + table
properties instead.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: table
description: 'The PostgreSQL table name. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: schema_type_properties_schema
description: 'The PostgreSQL schema name. Type: string (or Expression
with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'This property will be retired. Please consider using schema + table
-
- properties instead.'
- name: table_name
- types:
- - <xref:JSON>
-- description: 'The PostgreSQL table name. Type: string (or Expression with resultType
- string).'
- name: table
- types:
- - <xref:JSON>
-- description: 'The PostgreSQL schema name. Type: string (or Expression
-
- with resultType string).'
- name: schema_type_properties_schema
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PowerBIWorkspaceLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PowerBIWorkspaceLinkedService.yml
deleted file mode 100644
index 12ff78107ef4..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PowerBIWorkspaceLinkedService.yml
+++ /dev/null
@@ -1,83 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.PowerBIWorkspaceLinkedService
-name: PowerBIWorkspaceLinkedService
-fullName: azure.synapse.artifacts.models.PowerBIWorkspaceLinkedService
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.LinkedService
-summary: 'Power BI Workspace linked service.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'PowerBIWorkspaceLinkedService(*, workspace_id: str, tenant_id: str, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: connect_via
- description: The integration runtime reference.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- - name: description
- description: Linked service description.
- types:
- - <xref:str>
- - name: parameters
- description: Parameters for linked service.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the linked service.
- types:
- - <xref:list>[<xref:JSON>]
- - name: workspace_id
- description: The Power BI workspace id. Required.
- types:
- - <xref:str>
- - name: tenant_id
- description: The tenant id to which the Power BI workspace belongs. Required.
- types:
- - <xref:str>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The Power BI workspace id. Required.
- name: workspace_id
- types:
- - <xref:str>
-- description: The tenant id to which the Power BI workspace belongs. Required.
- name: tenant_id
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoAuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoAuthenticationType.yml
index dca756be496c..a32551338602 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoAuthenticationType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoAuthenticationType.yml
@@ -11,7 +11,7 @@ inheritances:
- builtins.str
- enum.Enum
fields:
-- name: ANONYMOUS
- uid: azure.synapse.artifacts.models.PrestoAuthenticationType.ANONYMOUS
-- name: LDAP
- uid: azure.synapse.artifacts.models.PrestoAuthenticationType.LDAP
+- name: anonymous
+ uid: azure.synapse.artifacts.models.PrestoAuthenticationType.anonymous
+- name: ldap
+ uid: azure.synapse.artifacts.models.PrestoAuthenticationType.ldap
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoLinkedService.yml
index 5d0b2a534a4c..235b064f5a15 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoLinkedService.yml
@@ -10,243 +10,150 @@ summary: 'Presto server linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'PrestoLinkedService(*, host: MutableMapping[str, Any], server_version:
- MutableMapping[str, Any], catalog: MutableMapping[str, Any], authentication_type:
- str | _models.PrestoAuthenticationType, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, port:
- MutableMapping[str, Any] | None = None, username: MutableMapping[str, Any] | None
- = None, password: _models.SecretBase | None = None, enable_ssl: MutableMapping[str,
- Any] | None = None, trusted_cert_path: MutableMapping[str, Any] | None = None,
- use_system_trust_store: MutableMapping[str, Any] | None = None, allow_host_name_cn_mismatch:
- MutableMapping[str, Any] | None = None, allow_self_signed_server_cert: MutableMapping[str,
- Any] | None = None, time_zone_id: MutableMapping[str, Any] | None = None, encrypted_credential:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: host
- description: 'The IP address or host name of the Presto server. (i.e. 192.168.222.160).
+ description: 'Required. The IP address or host name of the Presto server. (i.e.
- Required.'
+ 192.168.222.160).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: server_version
- description: The version of the Presto server. (i.e. 0.148-t). Required.
+ description: Required. The version of the Presto server. (i.e. 0.148-t).
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: catalog
- description: The catalog context for all request against the server. Required.
+ description: Required. The catalog context for all request against the server.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: port
description: 'The TCP port that the Presto server uses to listen for client connections.
The
default value is 8080.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: authentication_type
- description: 'The authentication mechanism used to connect to the Presto
+ description: 'Required. The authentication mechanism used to connect to the
- server. Required. Known values are: "Anonymous" and "LDAP".'
+ Presto server. Possible values include: "Anonymous", "LDAP".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.PrestoAuthenticationType>
- name: username
description: The user name used to connect to the Presto server.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: The password corresponding to the user name.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: enable_ssl
description: 'Specifies whether the connections to the server are encrypted using
- SSL.
+ SSL. The
- The default value is false.'
+ default value is false.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: trusted_cert_path
description: 'The full path of the .pem file containing trusted CA certificates
+ for
- for verifying the server when connecting over SSL. This property can only be
- set when using SSL
+ verifying the server when connecting over SSL. This property can only be set
+ when using SSL on
- on self-hosted IR. The default value is the cacerts.pem file installed with
- the IR.'
+ self-hosted IR. The default value is the cacerts.pem file installed with the
+ IR.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_system_trust_store
- description: 'Specifies whether to use a CA certificate from the system
+ description: 'Specifies whether to use a CA certificate from the system trust
- trust store or from a specified PEM file. The default value is false.'
+ store or from a specified PEM file. The default value is false.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: allow_self_signed_server_cert
- description: 'Specifies whether to allow self-signed certificates
+ description: 'Specifies whether to allow self-signed certificates from
- from the server. The default value is false.'
+ the server. The default value is false.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The IP address or host name of the Presto server. (i.e. 192.168.222.160).
- Required.
- name: host
- types:
- - <xref:JSON>
-- description: The version of the Presto server. (i.e. 0.148-t). Required.
- name: server_version
- types:
- - <xref:JSON>
-- description: The catalog context for all request against the server. Required.
- name: catalog
- types:
- - <xref:JSON>
-- description: 'The TCP port that the Presto server uses to listen for client connections.
- The
-
- default value is 8080.'
- name: port
- types:
- - <xref:JSON>
-- description: 'The authentication mechanism used to connect to the Presto server.
-
- Required. Known values are: "Anonymous" and "LDAP".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.PrestoAuthenticationType>
-- description: The user name used to connect to the Presto server.
- name: username
- types:
- - <xref:JSON>
-- description: The password corresponding to the user name.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Specifies whether the connections to the server are encrypted using
- SSL. The
-
- default value is false.'
- name: enable_ssl
- types:
- - <xref:JSON>
-- 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.'
- name: trusted_cert_path
- types:
- - <xref:JSON>
-- description: 'Specifies whether to use a CA certificate from the system trust
-
- store or from a specified PEM file. The default value is false.'
- name: use_system_trust_store
- types:
- - <xref:JSON>
-- 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.'
- name: allow_host_name_cn_mismatch
- types:
- - <xref:JSON>
-- description: 'Specifies whether to allow self-signed certificates from
-
- the server. The default value is false.'
- name: allow_self_signed_server_cert
- types:
- - <xref:JSON>
-- 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.'
- name: time_zone_id
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoObjectDataset.yml
index 0236b9b8865c..8608c1d4c5bd 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoObjectDataset.yml
@@ -10,137 +10,87 @@ summary: 'Presto server dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'PrestoObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, table: MutableMapping[str, Any] | None = None, schema_type_properties_schema:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'This property will be retired. Please consider using schema + table
properties instead.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: table
description: 'The table name of the Presto. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: schema_type_properties_schema
description: 'The schema name of the Presto. Type: string (or
Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'This property will be retired. Please consider using schema + table
-
- properties instead.'
- name: table_name
- types:
- - <xref:JSON>
-- description: 'The table name of the Presto. Type: string (or Expression with resultType
- string).'
- name: table
- types:
- - <xref:JSON>
-- description: 'The schema name of the Presto. Type: string (or Expression
-
- with resultType string).'
- name: schema_type_properties_schema
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoSource.yml
deleted file mode 100644
index aa9fa8b3f6d2..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.PrestoSource
-name: PrestoSource
-fullName: azure.synapse.artifacts.models.PrestoSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Presto server source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'PrestoSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrivateEndpoint.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrivateEndpoint.yml
deleted file mode 100644
index fe1abb25f540..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrivateEndpoint.yml
+++ /dev/null
@@ -1,18 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.PrivateEndpoint
-name: PrivateEndpoint
-fullName: azure.synapse.artifacts.models.PrivateEndpoint
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Private endpoint details.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.'
-constructor:
- syntax: 'PrivateEndpoint(**kwargs: Any)'
-variables:
-- description: Resource id of the private endpoint.
- name: id
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrivateEndpointConnection.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrivateEndpointConnection.yml
deleted file mode 100644
index e88fcec19fe7..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrivateEndpointConnection.yml
+++ /dev/null
@@ -1,58 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.PrivateEndpointConnection
-name: PrivateEndpointConnection
-fullName: azure.synapse.artifacts.models.PrivateEndpointConnection
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.ProxyResource
-summary: 'A private endpoint connection.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.'
-constructor:
- syntax: 'PrivateEndpointConnection(*, private_endpoint: _models.PrivateEndpoint
- | None = None, private_link_service_connection_state: _models.PrivateLinkServiceConnectionState
- | None = None, **kwargs: Any)'
- parameters:
- - name: private_endpoint
- description: The private endpoint which the connection belongs to.
- types:
- - <xref:azure.synapse.artifacts.models.PrivateEndpoint>
- - name: private_link_service_connection_state
- description: 'Connection state of the private endpoint
-
- connection.'
- types:
- - <xref:azure.synapse.artifacts.models.PrivateLinkServiceConnectionState>
-variables:
-- description: 'Fully qualified resource ID for the resource. Ex -
-
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.'
- name: id
- types:
- - <xref:str>
-- description: The name of the resource.
- name: name
- types:
- - <xref:str>
-- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines"
- or
-
- "Microsoft.Storage/storageAccounts".'
- name: type
- types:
- - <xref:str>
-- description: The private endpoint which the connection belongs to.
- name: private_endpoint
- types:
- - <xref:azure.synapse.artifacts.models.PrivateEndpoint>
-- description: 'Connection state of the private endpoint
-
- connection.'
- name: private_link_service_connection_state
- types:
- - <xref:azure.synapse.artifacts.models.PrivateLinkServiceConnectionState>
-- description: Provisioning state of the private endpoint connection.
- name: provisioning_state
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrivateLinkServiceConnectionState.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrivateLinkServiceConnectionState.yml
deleted file mode 100644
index dbb9f111dd9a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrivateLinkServiceConnectionState.yml
+++ /dev/null
@@ -1,36 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.PrivateLinkServiceConnectionState
-name: PrivateLinkServiceConnectionState
-fullName: azure.synapse.artifacts.models.PrivateLinkServiceConnectionState
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Connection state details of the private endpoint.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.'
-constructor:
- syntax: 'PrivateLinkServiceConnectionState(*, status: str | None = None, description:
- str | None = None, **kwargs: Any)'
- parameters:
- - name: status
- description: The private link service connection status.
- types:
- - <xref:str>
- - name: description
- description: The private link service connection description.
- types:
- - <xref:str>
-variables:
-- description: The private link service connection status.
- name: status
- types:
- - <xref:str>
-- description: The private link service connection description.
- name: description
- types:
- - <xref:str>
-- description: The actions required for private link service connection.
- name: actions_required
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ProxyResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ProxyResource.yml
deleted file mode 100644
index 36ed893e70c6..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ProxyResource.yml
+++ /dev/null
@@ -1,34 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ProxyResource
-name: ProxyResource
-fullName: azure.synapse.artifacts.models.ProxyResource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.Resource
-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:
- - <xref:str>
-- description: The name of the resource.
- name: name
- types:
- - <xref:str>
-- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines"
- or
-
- "Microsoft.Storage/storageAccounts".'
- name: type
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PurviewConfiguration.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PurviewConfiguration.yml
deleted file mode 100644
index 3ef99b1b3932..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PurviewConfiguration.yml
+++ /dev/null
@@ -1,21 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.PurviewConfiguration
-name: PurviewConfiguration
-fullName: azure.synapse.artifacts.models.PurviewConfiguration
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Purview Configuration.
-constructor:
- syntax: 'PurviewConfiguration(*, purview_resource_id: str | None = None, **kwargs:
- Any)'
- parameters:
- - name: purview_resource_id
- description: Purview Resource ID.
- types:
- - <xref:str>
-variables:
-- description: Purview Resource ID.
- name: purview_resource_id
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse.yml
index 6c1964b66635..9cf60f95b9b7 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse.yml
@@ -4,26 +4,19 @@ name: QueryDataFlowDebugSessionsResponse
fullName: azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: A list of active debug sessions.
constructor:
- syntax: 'QueryDataFlowDebugSessionsResponse(*, value: List[_models.DataFlowDebugSessionInfo]
- | None = None, next_link: str | None = None, **kwargs: Any)'
+ 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:
- <xref:list>[<xref:azure.synapse.artifacts.models.DataFlowDebugSessionInfo>]
- name: next_link
description: The link to the next page of results, if any remaining results exist.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: Array with all active debug sessions.
- name: value
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DataFlowDebugSessionInfo>]
-- description: The link to the next page of results, if any remaining results exist.
- name: next_link
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QueryTableStatusRequest.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QueryTableStatusRequest.yml
deleted file mode 100644
index bb436f531476..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QueryTableStatusRequest.yml
+++ /dev/null
@@ -1,29 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.QueryTableStatusRequest
-name: QueryTableStatusRequest
-fullName: azure.synapse.artifacts.models.QueryTableStatusRequest
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: QueryTableStatusRequest.
-constructor:
- syntax: 'QueryTableStatusRequest(*, max_segment_count: int | None = None, continuation_token:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: max_segment_count
- description: Max segment count to query table status.
- types:
- - <xref:int>
- - name: continuation_token
- description: Continuation token to query table status.
- types:
- - <xref:JSON>
-variables:
-- description: Max segment count to query table status.
- name: max_segment_count
- types:
- - <xref:int>
-- description: Continuation token to query table status.
- name: continuation_token
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksLinkedService.yml
index 01f891fa858f..b71690ddba8e 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksLinkedService.yml
@@ -10,157 +10,92 @@ summary: 'QuickBooks server linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'QuickBooksLinkedService(*, endpoint: MutableMapping[str, Any], company_id:
- MutableMapping[str, Any], consumer_key: MutableMapping[str, Any], consumer_secret:
- _models.SecretBase, access_token: _models.SecretBase, access_token_secret: _models.SecretBase,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, connect_via:
- _models.IntegrationRuntimeReference | None = None, description: str | None = None,
- parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations:
- List[MutableMapping[str, Any]] | None = None, connection_properties: MutableMapping[str,
- Any] | None = None, use_encrypted_endpoints: MutableMapping[str, Any] | None =
- None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
- - name: connection_properties
- description: 'Properties used to connect to QuickBooks. It is mutually
-
- exclusive with any other properties in the linked service. Type: object.'
- types:
- - <xref:JSON>
+ - <xref:list>[<xref:object>]
- name: endpoint
- description: 'The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com).
+ description: 'Required. The endpoint of the QuickBooks server. (i.e.
- Required.'
+ quickbooks.api.intuit.com).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: company_id
- description: The company ID of the QuickBooks company to authorize. Required.
+ description: Required. The company ID of the QuickBooks company to authorize.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: consumer_key
- description: The consumer key for OAuth 1.0 authentication. Required.
+ description: Required. The consumer key for OAuth 1.0 authentication.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: consumer_secret
- description: The consumer secret for OAuth 1.0 authentication. Required.
+ description: Required. The consumer secret for OAuth 1.0 authentication.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: access_token
- description: The access token for OAuth 1.0 authentication. Required.
+ description: Required. The access token for OAuth 1.0 authentication.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: access_token_secret
- description: The access token secret for OAuth 1.0 authentication. Required.
+ description: Required. The access token secret for OAuth 1.0 authentication.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: use_encrypted_endpoints
- description: 'Specifies whether the data source endpoints are encrypted
+ description: 'Specifies whether the data source endpoints are encrypted using
- using HTTPS. The default value is true.'
+ HTTPS. The default value is true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Properties used to connect to QuickBooks. It is mutually exclusive
-
- with any other properties in the linked service. Type: object.'
- name: connection_properties
- types:
- - <xref:JSON>
-- description: 'The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com).
-
- Required.'
- name: endpoint
- types:
- - <xref:JSON>
-- description: The company ID of the QuickBooks company to authorize. Required.
- name: company_id
- types:
- - <xref:JSON>
-- description: The consumer key for OAuth 1.0 authentication. Required.
- name: consumer_key
- types:
- - <xref:JSON>
-- description: The consumer secret for OAuth 1.0 authentication. Required.
- name: consumer_secret
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: The access token for OAuth 1.0 authentication. Required.
- name: access_token
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: The access token secret for OAuth 1.0 authentication. Required.
- name: access_token_secret
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Specifies whether the data source endpoints are encrypted using
-
- HTTPS. The default value is true.'
- name: use_encrypted_endpoints
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksObjectDataset.yml
index a063a0638b7f..def352f7dbaa 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksObjectDataset.yml
@@ -10,109 +10,71 @@ summary: 'QuickBooks server dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'QuickBooksObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The table name. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksSource.yml
deleted file mode 100644
index d2b4d99e0109..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.QuickBooksSource
-name: QuickBooksSource
-fullName: azure.synapse.artifacts.models.QuickBooksSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity QuickBooks server source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'QuickBooksSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, query:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickbaseLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickbaseLinkedService.yml
deleted file mode 100644
index 06f648368347..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickbaseLinkedService.yml
+++ /dev/null
@@ -1,108 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.QuickbaseLinkedService
-name: QuickbaseLinkedService
-fullName: azure.synapse.artifacts.models.QuickbaseLinkedService
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.LinkedService
-summary: 'Linked service for Quickbase.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'QuickbaseLinkedService(*, url: MutableMapping[str, Any], user_token: _models.SecretBase,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, connect_via:
- _models.IntegrationRuntimeReference | None = None, description: str | None = None,
- parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations:
- List[MutableMapping[str, Any]] | None = None, encrypted_credential: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: connect_via
- description: The integration runtime reference.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- - name: description
- description: Linked service description.
- types:
- - <xref:str>
- - name: parameters
- description: Parameters for linked service.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the linked service.
- types:
- - <xref:list>[<xref:JSON>]
- - name: url
- description: 'The url to connect Quickbase source. Type: string (or Expression
- with resultType
-
- string). Required.'
- types:
- - <xref:JSON>
- - name: user_token
- description: The user token for the Quickbase source. Required.
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
- - 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).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The url to connect Quickbase source. Type: string (or Expression with
- resultType
-
- string). Required.'
- name: url
- types:
- - <xref:JSON>
-- description: The user token for the Quickbase source. Required.
- name: user_token
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RecurrenceFrequency.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RecurrenceFrequency.yml
deleted file mode 100644
index 350019644cb8..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RecurrenceFrequency.yml
+++ /dev/null
@@ -1,27 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.RecurrenceFrequency
-name: RecurrenceFrequency
-fullName: azure.synapse.artifacts.models.RecurrenceFrequency
-summary: Enumerates possible frequency option for the schedule trigger.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: RecurrenceFrequency(value, names=None, *, module=None, qualname=None, type=None,
- start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: DAY
- uid: azure.synapse.artifacts.models.RecurrenceFrequency.DAY
-- name: HOUR
- uid: azure.synapse.artifacts.models.RecurrenceFrequency.HOUR
-- name: MINUTE
- uid: azure.synapse.artifacts.models.RecurrenceFrequency.MINUTE
-- name: MONTH
- uid: azure.synapse.artifacts.models.RecurrenceFrequency.MONTH
-- name: NOT_SPECIFIED
- uid: azure.synapse.artifacts.models.RecurrenceFrequency.NOT_SPECIFIED
-- name: WEEK
- uid: azure.synapse.artifacts.models.RecurrenceFrequency.WEEK
-- name: YEAR
- uid: azure.synapse.artifacts.models.RecurrenceFrequency.YEAR
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RecurrenceSchedule.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RecurrenceSchedule.yml
deleted file mode 100644
index ef7b07ca0a6f..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RecurrenceSchedule.yml
+++ /dev/null
@@ -1,70 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.RecurrenceSchedule
-name: RecurrenceSchedule
-fullName: azure.synapse.artifacts.models.RecurrenceSchedule
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: The recurrence schedule.
-constructor:
- syntax: 'RecurrenceSchedule(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, minutes: List[int] | None = None, hours: List[int] | None
- = None, week_days: List[str | _models.DayOfWeek] | None = None, month_days: List[int]
- | None = None, monthly_occurrences: List[_models.RecurrenceScheduleOccurrence]
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: minutes
- description: The minutes.
- types:
- - <xref:list>[<xref:int>]
- - name: hours
- description: The hours.
- types:
- - <xref:list>[<xref:int>]
- - name: week_days
- description: The days of the week.
- types:
- - <xref:list>[<xref:str>
- - <xref:azure.synapse.artifacts.models.DayOfWeek>]
- - name: month_days
- description: The month days.
- types:
- - <xref:list>[<xref:int>]
- - name: monthly_occurrences
- description: The monthly occurrences.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.RecurrenceScheduleOccurrence>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The minutes.
- name: minutes
- types:
- - <xref:list>[<xref:int>]
-- description: The hours.
- name: hours
- types:
- - <xref:list>[<xref:int>]
-- description: The days of the week.
- name: week_days
- types:
- - <xref:list>[<xref:str>
- - <xref:azure.synapse.artifacts.models.DayOfWeek>]
-- description: The month days.
- name: month_days
- types:
- - <xref:list>[<xref:int>]
-- description: The monthly occurrences.
- name: monthly_occurrences
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.RecurrenceScheduleOccurrence>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RecurrenceScheduleOccurrence.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RecurrenceScheduleOccurrence.yml
deleted file mode 100644
index 2b4a46d8d64e..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RecurrenceScheduleOccurrence.yml
+++ /dev/null
@@ -1,49 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.RecurrenceScheduleOccurrence
-name: RecurrenceScheduleOccurrence
-fullName: azure.synapse.artifacts.models.RecurrenceScheduleOccurrence
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: The recurrence schedule occurrence.
-constructor:
- syntax: 'RecurrenceScheduleOccurrence(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, day: str | _models.DayOfWeek | None = None, occurrence: int
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: day
- description: 'The day of the week. Known values are: "Sunday", "Monday", "Tuesday",
-
- "Wednesday", "Thursday", "Friday", and "Saturday".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.DayOfWeek>
- - name: occurrence
- description: The occurrence.
- types:
- - <xref:int>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: 'The day of the week. Known values are: "Sunday", "Monday", "Tuesday",
- "Wednesday",
-
- "Thursday", "Friday", and "Saturday".'
- name: day
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.DayOfWeek>
-- description: The occurrence.
- name: occurrence
- types:
- - <xref:int>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RedirectIncompatibleRowSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RedirectIncompatibleRowSettings.yml
index 17ddb210cc6b..28530a18971e 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RedirectIncompatibleRowSettings.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RedirectIncompatibleRowSettings.yml
@@ -4,62 +4,40 @@ name: RedirectIncompatibleRowSettings
fullName: azure.synapse.artifacts.models.RedirectIncompatibleRowSettings
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'Redirect incompatible row settings.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'RedirectIncompatibleRowSettings(*, linked_service_name: MutableMapping[str,
- Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- path: MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: linked_service_name
- description: 'Name of the Azure Storage, Storage SAS, or Azure Data Lake Store
+ description: 'Required. Name of the Azure Storage, Storage SAS, or Azure Data
- linked service used for redirecting incompatible row. Must be specified if
+ Lake Store linked service used for redirecting incompatible row. Must be specified
+ if
redirectIncompatibleRowSettings is specified. Type: string (or Expression with
resultType
- string). Required.'
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: path
description: 'The path for storing the redirect incompatible row data. Type: string
(or
Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: '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). Required.'
- name: linked_service_name
- types:
- - <xref:JSON>
-- description: 'The path for storing the redirect incompatible row data. Type: string
- (or
-
- Expression with resultType string).'
- name: path
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RedshiftUnloadSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RedshiftUnloadSettings.yml
deleted file mode 100644
index cd7486f8560e..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RedshiftUnloadSettings.yml
+++ /dev/null
@@ -1,54 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.RedshiftUnloadSettings
-name: RedshiftUnloadSettings
-fullName: azure.synapse.artifacts.models.RedshiftUnloadSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'The Amazon S3 settings needed for the interim Amazon S3 when copying from
- Amazon Redshift with
-
- unload. With this, data from Amazon Redshift source will be unloaded into S3 first
- and then
-
- copied into the targeted sink from the interim S3.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'RedshiftUnloadSettings(*, s3_linked_service_name: _models.LinkedServiceReference,
- bucket_name: MutableMapping[str, Any], **kwargs: Any)'
- parameters:
- - name: s3_linked_service_name
- description: 'The name of the Amazon S3 linked service which will be used
-
- for the unload operation when copying from the Amazon Redshift source. Required.'
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: bucket_name
- description: 'The bucket of the interim Amazon S3 which will be used to store
- the
-
- unloaded data from Amazon Redshift source. The bucket must be in the same region
- as the Amazon
-
- Redshift source. Type: string (or Expression with resultType string). Required.'
- types:
- - <xref:JSON>
-variables:
-- description: 'The name of the Amazon S3 linked service which will be used for
-
- the unload operation when copying from the Amazon Redshift source. Required.'
- name: s3_linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: 'The bucket of the interim Amazon S3 which will be used to store the
- unloaded
-
- data from Amazon Redshift source. The bucket must be in the same region as the
- Amazon Redshift
-
- source. Type: string (or Expression with resultType string). Required.'
- name: bucket_name
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RelationalSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RelationalSource.yml
deleted file mode 100644
index 9477b33bea1e..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RelationalSource.yml
+++ /dev/null
@@ -1,93 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.RelationalSource
-name: RelationalSource
-fullName: azure.synapse.artifacts.models.RelationalSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity source for various relational databases.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'RelationalSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, additional_columns: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query
- description: 'Database query. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Database query. Type: string (or Expression with resultType string).'
- name: query
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RelationalTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RelationalTableDataset.yml
index 79732b0f245d..a69870d08c56 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RelationalTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RelationalTableDataset.yml
@@ -10,113 +10,73 @@ summary: 'The relational table dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'RelationalTableDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The relational table name. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The relational table name. Type: string (or Expression with resultType
-
- string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RequestStatus.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RequestStatus.yml
deleted file mode 100644
index e725de36328e..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RequestStatus.yml
+++ /dev/null
@@ -1,19 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.RequestStatus
-name: RequestStatus
-fullName: azure.synapse.artifacts.models.RequestStatus
-summary: Enumerates possible request statuses.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: RequestStatus(value, names=None, *, module=None, qualname=None, type=None,
- start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: COMPLETED
- uid: azure.synapse.artifacts.models.RequestStatus.COMPLETED
-- name: FAILED
- uid: azure.synapse.artifacts.models.RequestStatus.FAILED
-- name: RUNNING
- uid: azure.synapse.artifacts.models.RequestStatus.RUNNING
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTriggerListResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTriggerListResponse.yml
index b777756d9bc3..23cb5c24dc7c 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTriggerListResponse.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTriggerListResponse.yml
@@ -4,7 +4,7 @@ name: RerunTriggerListResponse
fullName: azure.synapse.artifacts.models.RerunTriggerListResponse
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'A list of rerun triggers.
@@ -13,18 +13,14 @@ summary: 'A list of rerun triggers.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'RerunTriggerListResponse(*, value: List[_models.RerunTriggerResource],
- **kwargs: Any)'
+ syntax: 'RerunTriggerListResponse(*, value: List[RerunTriggerResource], **kwargs)'
parameters:
- name: value
- description: List of rerun triggers. Required.
+ description: Required. List of rerun triggers.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.RerunTriggerResource>]
variables:
-- description: List of rerun triggers. Required.
- name: value
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.RerunTriggerResource>]
- description: 'The continuation token for getting the next page of results, if any
remaining
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTriggerResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTriggerResource.yml
index bf0ad4b2a0d5..69679d9ba93c 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTriggerResource.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTriggerResource.yml
@@ -13,36 +13,27 @@ summary: 'RerunTrigger resource type.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'RerunTriggerResource(*, properties: _models.RerunTumblingWindowTrigger,
- **kwargs: Any)'
+ syntax: 'RerunTriggerResource(*, properties: RerunTumblingWindowTrigger, **kwargs)'
parameters:
- name: properties
- description: Properties of the rerun trigger. Required.
+ description: Required. Properties of the rerun trigger.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.RerunTumblingWindowTrigger>
variables:
-- description: 'Fully qualified resource ID for the resource. Ex -
-
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.'
+- description: The resource identifier.
name: id
types:
- <xref:str>
-- description: The name of the resource.
+- description: The resource name.
name: name
types:
- <xref:str>
-- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines"
- or
-
- "Microsoft.Storage/storageAccounts".'
+- description: The resource type.
name: type
types:
- <xref:str>
-- description: Resource Etag.
+- description: Etag identifies change in the resource.
name: etag
types:
- <xref:str>
-- description: Properties of the rerun trigger. Required.
- name: properties
- types:
- - <xref:azure.synapse.artifacts.models.RerunTumblingWindowTrigger>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTumblingWindowTrigger.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTumblingWindowTrigger.yml
index 0aaeda1feaf3..79b11d0d8598 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTumblingWindowTrigger.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTumblingWindowTrigger.yml
@@ -6,9 +6,7 @@ module: azure.synapse.artifacts.models
inheritances:
- azure.synapse.artifacts.models._models_py3.Trigger
summary: 'Trigger that schedules pipeline reruns for all fixed time interval windows
- from a requested
-
- start time to requested end time.
+ from a requested start time to requested end time.
Variables are only populated by the server, and will be ignored when sending a request.
@@ -16,94 +14,66 @@ summary: 'Trigger that schedules pipeline reruns for all fixed time interval win
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'RerunTumblingWindowTrigger(*, parent_trigger: MutableMapping[str, Any],
- requested_start_time: datetime, requested_end_time: datetime, rerun_concurrency:
- int, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- description: str | None = None, annotations: List[MutableMapping[str, Any]] |
- None = None, **kwargs: Any)'
+ 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:
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Trigger type.Constant filled by server.
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:str>
- name: description
description: Trigger description.
+ isRequired: true
types:
- <xref:str>
- name: annotations
description: List of tags that can be used for describing the trigger.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: parent_trigger
- description: The parent trigger reference. Required.
+ description: The parent trigger reference.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: requested_start_time
- description: 'The start time for the time period for which restatement is
+ description: 'Required. The start time for the time period for which restatement
- initiated. Only UTC time is currently supported. Required.'
+ is initiated. Only UTC time is currently supported.'
+ isRequired: true
types:
- <xref:datetime.datetime>
- name: requested_end_time
- description: 'The end time for the time period for which restatement is
+ description: 'Required. The end time for the time period for which restatement
+ is
- initiated. Only UTC time is currently supported. Required.'
+ initiated. Only UTC time is currently supported.'
+ isRequired: true
types:
- <xref:datetime.datetime>
- - name: rerun_concurrency
- description: 'The max number of parallel time windows (ready for execution) for
+ - name: max_concurrency
+ description: 'Required. The max number of parallel time windows (ready for execution)
- which a rerun is triggered. Required.'
+ for which a rerun is triggered.'
+ isRequired: true
types:
- <xref:int>
variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Trigger type. Required.
- name: type
- types:
- - <xref:str>
-- description: Trigger description.
- name: description
- types:
- - <xref:str>
- description: 'Indicates if trigger is running or not. Updated when Start/Stop APIs
are
- called on the Trigger. Known values are: "Started", "Stopped", and "Disabled".'
+ called on the Trigger. Possible values include: "Started", "Stopped", "Disabled".'
name: runtime_state
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.TriggerRuntimeState>
-- description: List of tags that can be used for describing the trigger.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The parent trigger reference. Required.
- name: parent_trigger
- types:
- - <xref:JSON>
-- description: 'The start time for the time period for which restatement is
-
- initiated. Only UTC time is currently supported. Required.'
- name: requested_start_time
- types:
- - <xref:datetime.datetime>
-- description: 'The end time for the time period for which restatement is initiated.
-
- Only UTC time is currently supported. Required.'
- name: requested_end_time
- types:
- - <xref:datetime.datetime>
-- description: 'The max number of parallel time windows (ready for execution) for
-
- which a rerun is triggered. Required.'
- name: rerun_concurrency
- types:
- - <xref:int>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTumblingWindowTriggerActionParameters.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTumblingWindowTriggerActionParameters.yml
index ea01a871d89b..b44021036a4a 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTumblingWindowTriggerActionParameters.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTumblingWindowTriggerActionParameters.yml
@@ -4,53 +4,35 @@ name: RerunTumblingWindowTriggerActionParameters
fullName: azure.synapse.artifacts.models.RerunTumblingWindowTriggerActionParameters
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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: Any)'
+ datetime, max_concurrency: int, **kwargs)'
parameters:
- name: start_time
- description: 'The start time for the time period for which restatement is initiated.
+ description: 'Required. The start time for the time period for which restatement
+ is
- Only UTC time is currently supported. Required.'
+ initiated. Only UTC time is currently supported.'
+ isRequired: true
types:
- <xref:datetime.datetime>
- name: end_time
- description: 'The end time for the time period for which restatement is initiated.
- Only
+ description: 'Required. The end time for the time period for which restatement
+ is initiated.
- UTC time is currently supported. Required.'
+ Only UTC time is currently supported.'
+ isRequired: true
types:
- <xref:datetime.datetime>
- name: max_concurrency
- description: 'The max number of parallel time windows (ready for execution) for
+ description: 'Required. The max number of parallel time windows (ready for execution)
- which a rerun is triggered. Required.'
+ for which a rerun is triggered.'
+ isRequired: true
types:
- <xref:int>
-variables:
-- description: 'The start time for the time period for which restatement is initiated.
- Only
-
- UTC time is currently supported. Required.'
- name: start_time
- types:
- - <xref:datetime.datetime>
-- description: 'The end time for the time period for which restatement is initiated.
- Only UTC
-
- time is currently supported. Required.'
- name: end_time
- types:
- - <xref:datetime.datetime>
-- description: 'The max number of parallel time windows (ready for execution) for
- which
-
- a rerun is triggered. Required.'
- name: max_concurrency
- types:
- - <xref:int>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Resource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Resource.yml
index ddb6816e350a..2f3ad48e2d28 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Resource.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Resource.yml
@@ -4,29 +4,39 @@ name: Resource
fullName: azure.synapse.artifacts.models.Resource
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Common fields that are returned in the response for all Azure Resource Manager
- resources.
+- msrest.serialization.Model
+summary: 'Azure Synapse top-level resource.
Variables are only populated by the server, and will be ignored when sending a request.'
constructor:
- syntax: 'Resource(**kwargs: Any)'
+ syntax: 'Resource(*, location: str | None = None, tags: Dict[str, str] | None =
+ None, **kwargs)'
+ parameters:
+ - name: location
+ description: The resource location.
+ isRequired: true
+ types:
+ - <xref:str>
+ - name: tags
+ description: A set of tags. The resource tags.
+ isRequired: true
+ types:
+ - <xref:dict>[<xref:str>, <xref:str>]
variables:
-- description: 'Fully qualified resource ID for the resource. Ex -
-
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.'
+- description: The resource identifier.
name: id
types:
- <xref:str>
-- description: The name of the resource.
+- description: The resource name.
name: name
types:
- <xref:str>
-- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines"
- or
-
- "Microsoft.Storage/storageAccounts".'
+- description: The resource type.
name: type
types:
- <xref:str>
+- description: Etag identifies change in the resource.
+ name: e_tag
+ types:
+ - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResourceIdentityType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResourceIdentityType.yml
deleted file mode 100644
index 0a34350f91b4..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResourceIdentityType.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.ResourceIdentityType
-name: ResourceIdentityType
-fullName: azure.synapse.artifacts.models.ResourceIdentityType
-summary: The type of managed identity for the workspace.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: ResourceIdentityType(value, names=None, *, module=None, qualname=None, type=None,
- start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: NONE
- uid: azure.synapse.artifacts.models.ResourceIdentityType.NONE
-- name: SYSTEM_ASSIGNED
- uid: azure.synapse.artifacts.models.ResourceIdentityType.SYSTEM_ASSIGNED
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResourceStatus.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResourceStatus.yml
deleted file mode 100644
index ba173d8a5462..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResourceStatus.yml
+++ /dev/null
@@ -1,19 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.ResourceStatus
-name: ResourceStatus
-fullName: azure.synapse.artifacts.models.ResourceStatus
-summary: Enumerates possible Status of the resource.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: ResourceStatus(value, names=None, *, module=None, qualname=None, type=None,
- start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: CREATED
- uid: azure.synapse.artifacts.models.ResourceStatus.CREATED
-- name: CREATING
- uid: azure.synapse.artifacts.models.ResourceStatus.CREATING
-- name: FAILED
- uid: azure.synapse.artifacts.models.ResourceStatus.FAILED
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysLinkedService.yml
index cb351a424cfb..df49058d818b 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysLinkedService.yml
@@ -10,62 +10,75 @@ summary: 'Responsys linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'ResponsysLinkedService(*, endpoint: MutableMapping[str, Any], client_id:
- MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, client_secret:
- _models.SecretBase | None = None, use_encrypted_endpoints: MutableMapping[str,
- Any] | None = None, use_host_verification: MutableMapping[str, Any] | None = None,
- use_peer_verification: MutableMapping[str, Any] | None = None, encrypted_credential:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: endpoint
- description: The endpoint of the Responsys server. Required.
+ description: Required. The endpoint of the Responsys server.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: client_id
- description: 'The client ID associated with the Responsys application. Type: string
- (or
+ description: 'Required. The client ID associated with the Responsys application.
+ Type:
- Expression with resultType string). Required.'
+ string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: client_secret
description: 'The client secret associated with the Responsys application. Type:
+ string
- string (or Expression with resultType string).'
+ (or Expression with resultType string).'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: use_encrypted_endpoints
- description: 'Specifies whether the data source endpoints are encrypted
+ description: 'Specifies whether the data source endpoints are encrypted using
- using HTTPS. The default value is true. Type: boolean (or Expression with resultType
+ HTTPS. The default value is true. Type: boolean (or Expression with resultType
boolean).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_host_verification
description: 'Specifies whether to require the host name in the server''s
@@ -73,8 +86,9 @@ constructor:
default value is
true. Type: boolean (or Expression with resultType boolean).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_peer_verification
description: 'Specifies whether to verify the identity of the server when
@@ -82,93 +96,16 @@ constructor:
with resultType
boolean).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The endpoint of the Responsys server. Required.
- name: endpoint
- types:
- - <xref:JSON>
-- description: 'The client ID associated with the Responsys application. Type: string
- (or
-
- Expression with resultType string). Required.'
- name: client_id
- types:
- - <xref:JSON>
-- description: 'The client secret associated with the Responsys application. Type:
- string
-
- (or Expression with resultType string).'
- name: client_secret
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Specifies whether the data source endpoints are encrypted using
-
- HTTPS. The default value is true. Type: boolean (or Expression with resultType
- boolean).'
- name: use_encrypted_endpoints
- types:
- - <xref:JSON>
-- 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).'
- name: use_host_verification
- types:
- - <xref:JSON>
-- 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).'
- name: use_peer_verification
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysObjectDataset.yml
index cf3b9ee021f4..884039c73c4e 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysObjectDataset.yml
@@ -10,109 +10,71 @@ summary: 'Responsys dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'ResponsysObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The table name. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysSource.yml
deleted file mode 100644
index 12afc09d35a2..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ResponsysSource
-name: ResponsysSource
-fullName: azure.synapse.artifacts.models.ResponsysSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Responsys source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ResponsysSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, query:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestResourceDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestResourceDataset.yml
index 11cda5324db3..b382da93ab1e 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestResourceDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestResourceDataset.yml
@@ -10,57 +10,68 @@ summary: 'A Rest service dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'RestResourceDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, relative_url: MutableMapping[str, Any] |
- None = None, request_method: MutableMapping[str, Any] | None = None, request_body:
- MutableMapping[str, Any] | None = None, additional_headers: MutableMapping[str,
- Any] | None = None, pagination_rules: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: relative_url
@@ -68,111 +79,37 @@ constructor:
Type:
string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: request_method
description: 'The HTTP method used to call the RESTful API. The default is GET.
+ Type:
- Type: string (or Expression with resultType string).'
+ string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: additional_headers
- description: 'The additional HTTP headers in the request to the RESTful API.
+ description: 'The additional HTTP headers in the request to the RESTful API. Type:
- Type: string (or Expression with resultType string).'
+ string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: pagination_rules
description: 'The pagination rules to compose next page requests. Type: string
(or
Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The relative URL to the resource that the RESTful API provides. Type:
-
- string (or Expression with resultType string).'
- name: relative_url
- types:
- - <xref:JSON>
-- description: 'The HTTP method used to call the RESTful API. The default is GET.
- Type:
-
- string (or Expression with resultType string).'
- name: request_method
- types:
- - <xref:JSON>
-- description: 'The HTTP request body to the RESTful API if requestMethod is POST.
- Type:
-
- string (or Expression with resultType string).'
- name: request_body
- types:
- - <xref:JSON>
-- description: 'The additional HTTP headers in the request to the RESTful API. Type:
-
- string (or Expression with resultType string).'
- name: additional_headers
- types:
- - <xref:JSON>
-- description: 'The pagination rules to compose next page requests. Type: string (or
-
- Expression with resultType string).'
- name: pagination_rules
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestServiceAuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestServiceAuthenticationType.yml
index 8b24fcdef65f..77b965f67708 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestServiceAuthenticationType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestServiceAuthenticationType.yml
@@ -11,13 +11,11 @@ inheritances:
- builtins.str
- enum.Enum
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
-- name: O_AUTH2_CLIENT_CREDENTIAL
- uid: azure.synapse.artifacts.models.RestServiceAuthenticationType.O_AUTH2_CLIENT_CREDENTIAL
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestServiceLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestServiceLinkedService.yml
index 7beaf130b99e..f9815a7a0cd3 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestServiceLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestServiceLinkedService.yml
@@ -10,49 +10,52 @@ summary: 'Rest Service linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'RestServiceLinkedService(*, url: MutableMapping[str, Any], authentication_type:
- str | _models.RestServiceAuthenticationType, additional_properties: Dict[str,
- MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, enable_server_certificate_validation:
- MutableMapping[str, Any] | None = None, user_name: MutableMapping[str, Any] |
- None = None, password: _models.SecretBase | None = None, auth_headers: MutableMapping[str,
- Any] | None = None, service_principal_id: MutableMapping[str, Any] | None = None,
- service_principal_key: _models.SecretBase | None = None, tenant: MutableMapping[str,
- Any] | None = None, azure_cloud_type: MutableMapping[str, Any] | None = None,
- aad_resource_id: MutableMapping[str, Any] | None = None, encrypted_credential:
- MutableMapping[str, Any] | None = None, credential: _models.CredentialReference
- | None = None, client_id: MutableMapping[str, Any] | None = None, client_secret:
- _models.SecretBase | None = None, token_endpoint: MutableMapping[str, Any] | None
- = None, resource: MutableMapping[str, Any] | None = None, scope: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: url
- description: The base URL of the REST service. Required.
+ description: Required. The base URL of the REST service.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: enable_server_certificate_validation
description: 'Whether to validate server side SSL certificate
@@ -60,241 +63,62 @@ constructor:
Expression with
resultType boolean).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: authentication_type
- description: 'Type of authentication used to connect to the REST service.
+ description: 'Required. Type of authentication used to connect to the REST
- Required. Known values are: "Anonymous", "Basic", "AadServicePrincipal",
+ service. Possible values include: "Anonymous", "Basic", "AadServicePrincipal",
- "ManagedServiceIdentity", and "OAuth2ClientCredential".'
+ "ManagedServiceIdentity".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.RestServiceAuthenticationType>
- name: user_name
description: The user name used in Basic authentication type.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: The password used in Basic authentication type.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- - name: auth_headers
- description: 'The additional HTTP headers in the request to RESTful API used for
-
- authorization. Type: object (or Expression with resultType object).'
- types:
- - <xref:JSON>
- name: service_principal_id
description: 'The application''s client ID used in AadServicePrincipal
authentication type.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: service_principal_key
- description: 'The application''s key used in AadServicePrincipal
+ description: 'The application''s key used in AadServicePrincipal authentication
- authentication type.'
+ type.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: tenant
description: 'The tenant information (domain name or tenant ID) used in AadServicePrincipal
authentication type under which your application resides.'
+ isRequired: true
types:
- - <xref:JSON>
- - name: azure_cloud_type
- description: 'Indicates the azure cloud type of the service principle auth.
-
- Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany.
- Default value is
-
- the data factory regions'' cloud type. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
+ - <xref:object>
- name: aad_resource_id
description: The resource you are requesting authorization to use.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
-
- with resultType string).'
- types:
- - <xref:JSON>
- - name: credential
- description: The credential reference containing authentication information.
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
- - name: client_id
- description: 'The client ID associated with your application. Type: string (or
- Expression
-
- with resultType string).'
- types:
- - <xref:JSON>
- - name: client_secret
- description: The client secret associated with your application.
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
- - name: token_endpoint
- description: 'The token endpoint of the authorization server to acquire access
-
- token. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: resource
- description: 'The target service or resource to which the access will be requested.
- Type:
-
- string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: scope
- description: 'The scope of the access required. It describes what kind of access
- will be
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- requested. Type: string (or Expression with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The base URL of the REST service. Required.
- name: url
- types:
- - <xref:JSON>
-- 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).'
- name: enable_server_certificate_validation
- types:
- - <xref:JSON>
-- description: 'Type of authentication used to connect to the REST service.
-
- Required. Known values are: "Anonymous", "Basic", "AadServicePrincipal",
-
- "ManagedServiceIdentity", and "OAuth2ClientCredential".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.RestServiceAuthenticationType>
-- description: The user name used in Basic authentication type.
- name: user_name
- types:
- - <xref:JSON>
-- description: The password used in Basic authentication type.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The additional HTTP headers in the request to RESTful API used for
-
- authorization. Type: object (or Expression with resultType object).'
- name: auth_headers
- types:
- - <xref:JSON>
-- description: 'The application''s client ID used in AadServicePrincipal
-
- authentication type.'
- name: service_principal_id
- types:
- - <xref:JSON>
-- description: 'The application''s key used in AadServicePrincipal authentication
-
- type.'
- name: service_principal_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The tenant information (domain name or tenant ID) used in AadServicePrincipal
-
- authentication type under which your application resides.'
- name: tenant
- types:
- - <xref:JSON>
-- description: 'Indicates the azure cloud type of the service principle auth. Allowed
-
- values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value
- is the data
-
- factory regions'' cloud type. Type: string (or Expression with resultType string).'
- name: azure_cloud_type
- types:
- - <xref:JSON>
-- description: The resource you are requesting authorization to use.
- name: aad_resource_id
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
-- description: The credential reference containing authentication information.
- name: credential
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
-- description: 'The client ID associated with your application. Type: string (or Expression
-
- with resultType string).'
- name: client_id
- types:
- - <xref:JSON>
-- description: The client secret associated with your application.
- name: client_secret
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The token endpoint of the authorization server to acquire access token.
-
- Type: string (or Expression with resultType string).'
- name: token_endpoint
- types:
- - <xref:JSON>
-- description: 'The target service or resource to which the access will be requested.
- Type:
-
- string (or Expression with resultType string).'
- name: resource
- types:
- - <xref:JSON>
-- description: 'The scope of the access required. It describes what kind of access
- will be
-
- requested. Type: string (or Expression with resultType string).'
- name: scope
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestSink.yml
deleted file mode 100644
index be668cb50fe7..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestSink.yml
+++ /dev/null
@@ -1,167 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.RestSink
-name: RestSink
-fullName: azure.synapse.artifacts.models.RestSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Rest service Sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'RestSink(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, write_batch_size: MutableMapping[str, Any] | None = None, write_batch_timeout:
- MutableMapping[str, Any] | None = None, sink_retry_count: MutableMapping[str,
- Any] | None = None, sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, request_method: MutableMapping[str, Any]
- | None = None, additional_headers: MutableMapping[str, Any] | None = None, http_request_timeout:
- MutableMapping[str, Any] | None = None, request_interval: MutableMapping[str,
- Any] | None = None, http_compression_type: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: request_method
- description: 'The HTTP method used to call the RESTful API. The default is POST.
-
- Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: additional_headers
- description: 'The additional HTTP headers in the request to the RESTful API.
-
- Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: http_request_timeout
- description: 'The timeout (TimeSpan) to get an HTTP response. It is the
-
- timeout to get a response, not the timeout to read response data. Default value:
- 00:01:40.
-
- Type: string (or Expression with resultType string), pattern:
-
- ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: request_interval
- description: The time to await before sending next request, in milliseconds.
- types:
- - <xref:JSON>
- - name: http_compression_type
- description: 'Http Compression Type to Send data in compressed format with
-
- Optimal Compression Level, Default is None. And The Only Supported option is
- Gzip.'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'The HTTP method used to call the RESTful API. The default is POST.
- Type:
-
- string (or Expression with resultType string).'
- name: request_method
- types:
- - <xref:JSON>
-- description: 'The additional HTTP headers in the request to the RESTful API. Type:
-
- string (or Expression with resultType string).'
- name: additional_headers
- types:
- - <xref:JSON>
-- description: 'The timeout (TimeSpan) to get an HTTP response. It is the timeout
-
- to get a response, not the timeout to read response data. Default value: 00:01:40.
- Type: string
-
- (or Expression with resultType string), pattern:
-
- ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: http_request_timeout
- types:
- - <xref:JSON>
-- description: The time to await before sending next request, in milliseconds.
- name: request_interval
- types:
- - <xref:JSON>
-- description: 'Http Compression Type to Send data in compressed format with
-
- Optimal Compression Level, Default is None. And The Only Supported option is Gzip.'
- name: http_compression_type
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestSource.yml
deleted file mode 100644
index aab51f386121..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestSource.yml
+++ /dev/null
@@ -1,170 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.RestSource
-name: RestSource
-fullName: azure.synapse.artifacts.models.RestSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity Rest service source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'RestSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, request_method: MutableMapping[str, Any] | None = None, request_body:
- MutableMapping[str, Any] | None = None, additional_headers: MutableMapping[str,
- Any] | None = None, pagination_rules: MutableMapping[str, Any] | None = None,
- http_request_timeout: MutableMapping[str, Any] | None = None, request_interval:
- MutableMapping[str, Any] | None = None, additional_columns: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: request_method
- description: 'The HTTP method used to call the RESTful API. The default is GET.
-
- Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: request_body
- description: 'The HTTP request body to the RESTful API if requestMethod is POST.
- Type:
-
- string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: additional_headers
- description: 'The additional HTTP headers in the request to the RESTful API.
-
- Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: pagination_rules
- description: 'The pagination rules to compose next page requests. Type: string
- (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: http_request_timeout
- description: 'The timeout (TimeSpan) to get an HTTP response. It is the
-
- timeout to get a response, not the timeout to read response data. Default value:
- 00:01:40.
-
- Type: string (or Expression with resultType string), pattern:
-
- ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: request_interval
- description: The time to await before sending next page request.
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'The HTTP method used to call the RESTful API. The default is GET.
- Type:
-
- string (or Expression with resultType string).'
- name: request_method
- types:
- - <xref:JSON>
-- description: 'The HTTP request body to the RESTful API if requestMethod is POST.
- Type:
-
- string (or Expression with resultType string).'
- name: request_body
- types:
- - <xref:JSON>
-- description: 'The additional HTTP headers in the request to the RESTful API. Type:
-
- string (or Expression with resultType string).'
- name: additional_headers
- types:
- - <xref:JSON>
-- description: 'The pagination rules to compose next page requests. Type: string (or
-
- Expression with resultType string).'
- name: pagination_rules
- types:
- - <xref:JSON>
-- description: 'The timeout (TimeSpan) to get an HTTP response. It is the timeout
-
- to get a response, not the timeout to read response data. Default value: 00:01:40.
- Type: string
-
- (or Expression with resultType string), pattern:
-
- ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: http_request_timeout
- types:
- - <xref:JSON>
-- description: The time to await before sending next page request.
- name: request_interval
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RetryPolicy.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RetryPolicy.yml
deleted file mode 100644
index c46ca06b260a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RetryPolicy.yml
+++ /dev/null
@@ -1,35 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.RetryPolicy
-name: RetryPolicy
-fullName: azure.synapse.artifacts.models.RetryPolicy
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Execution policy for an activity.
-constructor:
- syntax: 'RetryPolicy(*, count: MutableMapping[str, Any] | None = None, interval_in_seconds:
- int | None = None, **kwargs: Any)'
- parameters:
- - name: count
- description: 'Maximum ordinary retry attempts. Default is 0. Type: integer (or
- Expression
-
- with resultType integer), minimum: 0.'
- types:
- - <xref:JSON>
- - name: interval_in_seconds
- description: Interval between retries in seconds. Default is 30.
- types:
- - <xref:int>
-variables:
-- description: 'Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression
- with
-
- resultType integer), minimum: 0.'
- name: count
- types:
- - <xref:JSON>
-- description: Interval between retries in seconds. Default is 30.
- name: interval_in_seconds
- types:
- - <xref:int>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunFilterParameters.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunFilterParameters.yml
index c99c3c6420cf..4b0cd270cd80 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunFilterParameters.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunFilterParameters.yml
@@ -4,68 +4,45 @@ name: RunFilterParameters
fullName: azure.synapse.artifacts.models.RunFilterParameters
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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[_models.RunQueryFilter]
- | None = None, order_by: List[_models.RunQueryOrderBy] | None = None, **kwargs:
- Any)'
+ 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:
- <xref:str>
- name: last_updated_after
- description: 'The time at or after which the run event was updated in ''ISO 8601''
+ description: 'Required. The time at or after which the run event was updated in
- format. Required.'
+ ''ISO 8601'' format.'
+ isRequired: true
types:
- <xref:datetime.datetime>
- name: last_updated_before
- description: 'The time at or before which the run event was updated in ''ISO
+ description: 'Required. The time at or before which the run event was updated
+ in
- 8601'' format. Required.'
+ ''ISO 8601'' format.'
+ isRequired: true
types:
- <xref:datetime.datetime>
- name: filters
description: List of filters.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.RunQueryFilter>]
- name: order_by
description: List of OrderBy option.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.RunQueryOrderBy>]
-variables:
-- description: 'The continuation token for getting the next page of results. Null
- for
-
- first page.'
- name: continuation_token
- types:
- - <xref:str>
-- description: 'The time at or after which the run event was updated in ''ISO 8601''
-
- format. Required.'
- name: last_updated_after
- types:
- - <xref:datetime.datetime>
-- description: 'The time at or before which the run event was updated in ''ISO 8601''
-
- format. Required.'
- name: last_updated_before
- types:
- - <xref:datetime.datetime>
-- description: List of filters.
- name: filters
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.RunQueryFilter>]
-- description: List of OrderBy option.
- name: order_by
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.RunQueryOrderBy>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookError.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookError.yml
deleted file mode 100644
index b5bf57bcb391..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookError.yml
+++ /dev/null
@@ -1,31 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.RunNotebookError
-name: RunNotebookError
-fullName: azure.synapse.artifacts.models.RunNotebookError
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Run notebook error.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.'
-constructor:
- syntax: 'RunNotebookError(*, traceback: List[str] | None = None, **kwargs: Any)'
- parameters:
- - name: traceback
- description: Error trace.
- types:
- - <xref:list>[<xref:str>]
-variables:
-- description: Error name.
- name: ename
- types:
- - <xref:str>
-- description: Error message.
- name: evalue
- types:
- - <xref:str>
-- description: Error trace.
- name: traceback
- types:
- - <xref:list>[<xref:str>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookParameter.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookParameter.yml
deleted file mode 100644
index 4951480fb249..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookParameter.yml
+++ /dev/null
@@ -1,29 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.RunNotebookParameter
-name: RunNotebookParameter
-fullName: azure.synapse.artifacts.models.RunNotebookParameter
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Run notebook parameter.
-constructor:
- syntax: 'RunNotebookParameter(*, type: str | None = None, value: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: type
- description: Parameter type.
- types:
- - <xref:str>
- - name: value
- description: Parameter value.
- types:
- - <xref:JSON>
-variables:
-- description: Parameter type.
- name: type
- types:
- - <xref:str>
-- description: Parameter value.
- name: value
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookRequest.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookRequest.yml
deleted file mode 100644
index 60da2c54e0fc..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookRequest.yml
+++ /dev/null
@@ -1,59 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.RunNotebookRequest
-name: RunNotebookRequest
-fullName: azure.synapse.artifacts.models.RunNotebookRequest
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Run notebook request.
-constructor:
- syntax: 'RunNotebookRequest(*, notebook: str | None = None, spark_pool: str | None
- = None, session_options: _models.RunNotebookSparkSessionOptions | None = None,
- honor_session_time_to_live: bool | None = None, parameters: Dict[str, _models.RunNotebookParameter]
- | None = None, **kwargs: Any)'
- parameters:
- - name: notebook
- description: Notebook name.
- types:
- - <xref:str>
- - name: spark_pool
- description: SparkPool name.
- types:
- - <xref:str>
- - name: session_options
- description: Session properties.
- types:
- - <xref:azure.synapse.artifacts.models.RunNotebookSparkSessionOptions>
- - name: honor_session_time_to_live
- description: 'Whether session should run till time to live after run
-
- completes.'
- types:
- - <xref:bool>
- - name: parameters
- description: Run notebook parameters.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.RunNotebookParameter>]
-variables:
-- description: Notebook name.
- name: notebook
- types:
- - <xref:str>
-- description: SparkPool name.
- name: spark_pool
- types:
- - <xref:str>
-- description: Session properties.
- name: session_options
- types:
- - <xref:azure.synapse.artifacts.models.RunNotebookSparkSessionOptions>
-- description: 'Whether session should run till time to live after run
-
- completes.'
- name: honor_session_time_to_live
- types:
- - <xref:bool>
-- description: Run notebook parameters.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.RunNotebookParameter>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookResponse.yml
deleted file mode 100644
index 25aad626d2d7..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookResponse.yml
+++ /dev/null
@@ -1,28 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.RunNotebookResponse
-name: RunNotebookResponse
-fullName: azure.synapse.artifacts.models.RunNotebookResponse
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Run notebook response.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.'
-constructor:
- syntax: 'RunNotebookResponse(*, result: _models.RunNotebookResult | None = None,
- **kwargs: Any)'
- parameters:
- - name: result
- description: Result of run notebook.
- types:
- - <xref:azure.synapse.artifacts.models.RunNotebookResult>
-variables:
-- description: Response message.
- name: message
- types:
- - <xref:str>
-- description: Result of run notebook.
- name: result
- types:
- - <xref:azure.synapse.artifacts.models.RunNotebookResult>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookResult.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookResult.yml
deleted file mode 100644
index 2b14d3a830c2..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookResult.yml
+++ /dev/null
@@ -1,79 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.RunNotebookResult
-name: RunNotebookResult
-fullName: azure.synapse.artifacts.models.RunNotebookResult
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Result of run notebook.
-constructor:
- syntax: 'RunNotebookResult(*, run_id: str | None = None, run_status: str | None
- = None, last_checked_on: str | None = None, session_id: int | None = None, spark_pool:
- str | None = None, session_detail: MutableMapping[str, Any] | None = None, exit_value:
- str | None = None, error: _models.RunNotebookError | None = None, **kwargs: Any)'
- parameters:
- - name: run_id
- description: Run id.
- types:
- - <xref:str>
- - name: run_status
- description: Status of the run notebook.
- types:
- - <xref:str>
- - name: last_checked_on
- description: Timestamp of last update.
- types:
- - <xref:str>
- - name: session_id
- description: Livy session id.
- types:
- - <xref:int>
- - name: spark_pool
- description: SparkPool name.
- types:
- - <xref:str>
- - name: session_detail
- description: Run notebook session details.
- types:
- - <xref:JSON>
- - name: exit_value
- description: Output of exit command.
- types:
- - <xref:str>
- - name: error
- description: Run notebook error.
- types:
- - <xref:azure.synapse.artifacts.models.RunNotebookError>
-variables:
-- description: Run id.
- name: run_id
- types:
- - <xref:str>
-- description: Status of the run notebook.
- name: run_status
- types:
- - <xref:str>
-- description: Timestamp of last update.
- name: last_checked_on
- types:
- - <xref:str>
-- description: Livy session id.
- name: session_id
- types:
- - <xref:int>
-- description: SparkPool name.
- name: spark_pool
- types:
- - <xref:str>
-- description: Run notebook session details.
- name: session_detail
- types:
- - <xref:JSON>
-- description: Output of exit command.
- name: exit_value
- types:
- - <xref:str>
-- description: Run notebook error.
- name: error
- types:
- - <xref:azure.synapse.artifacts.models.RunNotebookError>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookSnapshot.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookSnapshot.yml
deleted file mode 100644
index a0b90c358b33..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookSnapshot.yml
+++ /dev/null
@@ -1,95 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.RunNotebookSnapshot
-name: RunNotebookSnapshot
-fullName: azure.synapse.artifacts.models.RunNotebookSnapshot
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Run notebook snapshot.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'RunNotebookSnapshot(*, id: str, notebook: str, exit_value: str | None =
- None, session_options: _models.RunNotebookSparkSessionOptions | None = None, honor_session_time_to_live:
- bool | None = None, session_id: int | None = None, spark_pool: str | None = None,
- parameters: Dict[str, _models.RunNotebookParameter] | None = None, notebook_content:
- _models.NotebookResource | None = None, **kwargs: Any)'
- parameters:
- - name: exit_value
- description: Output of exit command.
- types:
- - <xref:str>
- - name: id
- description: Run notebook runId. Required.
- types:
- - <xref:str>
- - name: notebook
- description: Notebook name. Required.
- types:
- - <xref:str>
- - name: session_options
- description: Session properties.
- types:
- - <xref:azure.synapse.artifacts.models.RunNotebookSparkSessionOptions>
- - name: honor_session_time_to_live
- description: 'Whether session should run till time to live after run
-
- completes.'
- types:
- - <xref:bool>
- - name: session_id
- description: Livy session id.
- types:
- - <xref:int>
- - name: spark_pool
- description: SparkPool name.
- types:
- - <xref:str>
- - name: parameters
- description: Run notebook parameters.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.RunNotebookParameter>]
- - name: notebook_content
- description: Notebook resource type.
- types:
- - <xref:azure.synapse.artifacts.models.NotebookResource>
-variables:
-- description: Output of exit command.
- name: exit_value
- types:
- - <xref:str>
-- description: Run notebook runId. Required.
- name: id
- types:
- - <xref:str>
-- description: Notebook name. Required.
- name: notebook
- types:
- - <xref:str>
-- description: Session properties.
- name: session_options
- types:
- - <xref:azure.synapse.artifacts.models.RunNotebookSparkSessionOptions>
-- description: 'Whether session should run till time to live after run
-
- completes.'
- name: honor_session_time_to_live
- types:
- - <xref:bool>
-- description: Livy session id.
- name: session_id
- types:
- - <xref:int>
-- description: SparkPool name.
- name: spark_pool
- types:
- - <xref:str>
-- description: Run notebook parameters.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.RunNotebookParameter>]
-- description: Notebook resource type.
- name: notebook_content
- types:
- - <xref:azure.synapse.artifacts.models.NotebookResource>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookSnapshotResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookSnapshotResponse.yml
deleted file mode 100644
index 0485262aecc4..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookSnapshotResponse.yml
+++ /dev/null
@@ -1,28 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.RunNotebookSnapshotResponse
-name: RunNotebookSnapshotResponse
-fullName: azure.synapse.artifacts.models.RunNotebookSnapshotResponse
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Run notebook snapshot response.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.'
-constructor:
- syntax: 'RunNotebookSnapshotResponse(*, result: _models.RunNotebookSnapshotResult
- | None = None, **kwargs: Any)'
- parameters:
- - name: result
- description: Run notebook snapshot result.
- types:
- - <xref:azure.synapse.artifacts.models.RunNotebookSnapshotResult>
-variables:
-- description: Response message.
- name: message
- types:
- - <xref:str>
-- description: Run notebook snapshot result.
- name: result
- types:
- - <xref:azure.synapse.artifacts.models.RunNotebookSnapshotResult>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookSnapshotResult.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookSnapshotResult.yml
deleted file mode 100644
index 8ef4613d3559..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookSnapshotResult.yml
+++ /dev/null
@@ -1,74 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.RunNotebookSnapshotResult
-name: RunNotebookSnapshotResult
-fullName: azure.synapse.artifacts.models.RunNotebookSnapshotResult
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Run notebook snapshot result.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'RunNotebookSnapshotResult(*, snapshot: _models.RunNotebookSnapshot, run_id:
- str, run_status: str, error: _models.RunNotebookError | None = None, last_checked_on:
- str | None = None, session_id: int | None = None, spark_pool: str | None = None,
- **kwargs: Any)'
- parameters:
- - name: snapshot
- description: Run notebook snapshot. Required.
- types:
- - <xref:azure.synapse.artifacts.models.RunNotebookSnapshot>
- - name: error
- description: Run notebook error.
- types:
- - <xref:azure.synapse.artifacts.models.RunNotebookError>
- - name: run_id
- description: Run id. Required.
- types:
- - <xref:str>
- - name: run_status
- description: Status of the run notebook. Required.
- types:
- - <xref:str>
- - name: last_checked_on
- description: Timestamp of last update.
- types:
- - <xref:str>
- - name: session_id
- description: Livy session id.
- types:
- - <xref:int>
- - name: spark_pool
- description: SparkPool name.
- types:
- - <xref:str>
-variables:
-- description: Run notebook snapshot. Required.
- name: snapshot
- types:
- - <xref:azure.synapse.artifacts.models.RunNotebookSnapshot>
-- description: Run notebook error.
- name: error
- types:
- - <xref:azure.synapse.artifacts.models.RunNotebookError>
-- description: Run id. Required.
- name: run_id
- types:
- - <xref:str>
-- description: Status of the run notebook. Required.
- name: run_status
- types:
- - <xref:str>
-- description: Timestamp of last update.
- name: last_checked_on
- types:
- - <xref:str>
-- description: Livy session id.
- name: session_id
- types:
- - <xref:int>
-- description: SparkPool name.
- name: spark_pool
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookSparkSessionOptions.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookSparkSessionOptions.yml
deleted file mode 100644
index 3aae7a175867..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunNotebookSparkSessionOptions.yml
+++ /dev/null
@@ -1,160 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.RunNotebookSparkSessionOptions
-name: RunNotebookSparkSessionOptions
-fullName: azure.synapse.artifacts.models.RunNotebookSparkSessionOptions
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: RunNotebookSparkSessionOptions.
-constructor:
- syntax: 'RunNotebookSparkSessionOptions(*, tags: Dict[str, str] | None = None, kind:
- str | None = None, proxy_user: str | None = None, name: str | None = None, jars:
- List[str] | None = None, python_files: List[str] | None = None, files: List[str]
- | None = None, archives: List[str] | None = None, queue: MutableMapping[str, Any]
- | 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, is_queueable:
- bool | None = None, heartbeat_timeout_in_second: int | None = None, **kwargs:
- Any)'
- parameters:
- - name: tags
- description: Dictionary of `<string>`.
- types:
- - <xref:dict>[<xref:str>, <xref:str>]
- - name: kind
- description: The session kind.
- types:
- - <xref:str>
- - name: proxy_user
- description: User to impersonate when starting the session.
- types:
- - <xref:str>
- - name: name
- description: The name of this session.
- types:
- - <xref:str>
- - name: jars
- description: jars to be used in this session.
- types:
- - <xref:list>[<xref:str>]
- - name: python_files
- description: Python files to be used in this session.
- types:
- - <xref:list>[<xref:str>]
- - name: files
- description: files to be used in this session.
- types:
- - <xref:list>[<xref:str>]
- - name: archives
- description: Archives to be used in this session.
- types:
- - <xref:list>[<xref:str>]
- - name: queue
- description: The name of the YARN queue to which submitted.
- types:
- - <xref:JSON>
- - name: configuration
- description: Spark configuration properties.
- types:
- - <xref:dict>[<xref:str>, <xref:str>]
- - name: driver_memory
- description: Amount of memory to use for the driver process.
- types:
- - <xref:str>
- - name: driver_cores
- description: Number of cores to use for the driver process.
- types:
- - <xref:int>
- - name: executor_memory
- description: Amount of memory to use per executor process.
- types:
- - <xref:str>
- - name: executor_cores
- description: Number of cores to use for each executor.
- types:
- - <xref:int>
- - name: executor_count
- description: Number of executors to launch for this session.
- types:
- - <xref:int>
- - name: is_queueable
- description: 'Whether to queue session creation if Spark pool doesn''t have enough
-
- capacity. Default value is true in notebook runs API.'
- types:
- - <xref:bool>
- - name: heartbeat_timeout_in_second
- description: Timeout in second to which session be orphaned.
- types:
- - <xref:int>
-variables:
-- description: Dictionary of `<string>`.
- name: tags
- types:
- - <xref:dict>[<xref:str>, <xref:str>]
-- description: The session kind.
- name: kind
- types:
- - <xref:str>
-- description: User to impersonate when starting the session.
- name: proxy_user
- types:
- - <xref:str>
-- description: The name of this session.
- name: name
- types:
- - <xref:str>
-- description: jars to be used in this session.
- name: jars
- types:
- - <xref:list>[<xref:str>]
-- description: Python files to be used in this session.
- name: python_files
- types:
- - <xref:list>[<xref:str>]
-- description: files to be used in this session.
- name: files
- types:
- - <xref:list>[<xref:str>]
-- description: Archives to be used in this session.
- name: archives
- types:
- - <xref:list>[<xref:str>]
-- description: The name of the YARN queue to which submitted.
- name: queue
- types:
- - <xref:JSON>
-- description: Spark configuration properties.
- name: configuration
- types:
- - <xref:dict>[<xref:str>, <xref:str>]
-- description: Amount of memory to use for the driver process.
- name: driver_memory
- types:
- - <xref:str>
-- description: Number of cores to use for the driver process.
- name: driver_cores
- types:
- - <xref:int>
-- description: Amount of memory to use per executor process.
- name: executor_memory
- types:
- - <xref:str>
-- description: Number of cores to use for each executor.
- name: executor_cores
- types:
- - <xref:int>
-- description: Number of executors to launch for this session.
- name: executor_count
- types:
- - <xref:int>
-- description: 'Whether to queue session creation if Spark pool doesn''t have enough
-
- capacity. Default value is true in notebook runs API.'
- name: is_queueable
- types:
- - <xref:bool>
-- description: Timeout in second to which session be orphaned.
- name: heartbeat_timeout_in_second
- types:
- - <xref:int>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilter.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilter.yml
index c2ae65410c0f..fdd6a15f0e56 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilter.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilter.yml
@@ -4,71 +4,46 @@ name: RunQueryFilter
fullName: azure.synapse.artifacts.models.RunQueryFilter
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'Query filter option for listing runs.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'RunQueryFilter(*, operand: str | _models.RunQueryFilterOperand, operator:
- str | _models.RunQueryFilterOperator, values: List[str], **kwargs: Any)'
+ syntax: 'RunQueryFilter(*, operand: str | RunQueryFilterOperand, operator: str |
+ RunQueryFilterOperator, values: List[str], **kwargs)'
parameters:
- name: operand
- description: 'Parameter name to be used for filter. The allowed operands to query
- pipeline
+ description: 'Required. Parameter name to be used for filter. The allowed operands
+ to query
- runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are
- ActivityName,
-
- ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger
+ pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity
runs are
- TriggerName, TriggerRunTimestamp and Status. Required. Known values are: "PipelineName",
+ 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", and "LatestOnly".'
+ "ActivityType", "TriggerName", "TriggerRunTimestamp", "RunGroupId", "LatestOnly".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.RunQueryFilterOperand>
- name: operator
- description: 'Operator to be used for filter. Required. Known values are: "Equals",
+ description: 'Required. Operator to be used for filter. Possible values include:
+ "Equals",
- "NotEquals", "In", "NotIn", and "In".'
+ "NotEquals", "In", "NotIn".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.RunQueryFilterOperator>
- name: values
- description: List of filter values. Required.
+ description: Required. List of filter values.
+ isRequired: true
types:
- <xref:list>[<xref:str>]
-variables:
-- description: '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. Required. Known values are: "PipelineName",
-
- "Status", "RunStart", "RunEnd", "ActivityName", "ActivityRunStart", "ActivityRunEnd",
-
- "ActivityType", "TriggerName", "TriggerRunTimestamp", "RunGroupId", and "LatestOnly".'
- name: operand
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.RunQueryFilterOperand>
-- description: 'Operator to be used for filter. Required. Known values are: "Equals",
-
- "NotEquals", "In", "NotIn", and "In".'
- name: operator
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.RunQueryFilterOperator>
-- description: List of filter values. Required.
- name: values
- types:
- - <xref:list>[<xref:str>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilterOperand.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilterOperand.yml
index 5a6558bb75c9..5db513e2a399 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilterOperand.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilterOperand.yml
@@ -19,27 +19,27 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilterOperator.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilterOperator.yml
index a2cf35c31320..cf7885aec5c4 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilterOperator.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilterOperator.yml
@@ -11,13 +11,11 @@ inheritances:
- builtins.str
- enum.Enum
fields:
-- name: EQUALS
- uid: azure.synapse.artifacts.models.RunQueryFilterOperator.EQUALS
-- name: IN
- uid: azure.synapse.artifacts.models.RunQueryFilterOperator.IN
-- 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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrder.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrder.yml
index 3e5bccfe8b31..36dafc39ac36 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrder.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrder.yml
@@ -11,7 +11,7 @@ inheritances:
- builtins.str
- enum.Enum
fields:
-- name: ASC
- uid: azure.synapse.artifacts.models.RunQueryOrder.ASC
-- name: DESC
- uid: azure.synapse.artifacts.models.RunQueryOrder.DESC
+- name: asc
+ uid: azure.synapse.artifacts.models.RunQueryOrder.asc
+- name: desc
+ uid: azure.synapse.artifacts.models.RunQueryOrder.desc
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrderBy.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrderBy.yml
index f34ef4604962..925de4c30bd4 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrderBy.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrderBy.yml
@@ -4,63 +4,39 @@ name: RunQueryOrderBy
fullName: azure.synapse.artifacts.models.RunQueryOrderBy
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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 | _models.RunQueryOrderByField, order:
- str | _models.RunQueryOrder, **kwargs: Any)'
+ syntax: 'RunQueryOrderBy(*, order_by: str | RunQueryOrderByField, order: str | RunQueryOrder,
+ **kwargs)'
parameters:
- name: order_by
- description: 'Parameter name to be used for order by. The allowed parameters to
- order by
+ description: 'Required. Parameter name to be used for order by. The allowed parameters
+ to
- for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity
- runs are
+ 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. Required. Known values are: "RunStart", "RunEnd",
+ TriggerRunTimestamp and Status. Possible values include: "RunStart", "RunEnd",
+ "PipelineName",
- "PipelineName", "Status", "ActivityName", "ActivityRunStart", "ActivityRunEnd",
- "TriggerName",
+ "Status", "ActivityName", "ActivityRunStart", "ActivityRunEnd", "TriggerName",
- and "TriggerRunTimestamp".'
+ "TriggerRunTimestamp".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.RunQueryOrderByField>
- name: order
- description: 'Sorting order of the parameter. Required. Known values are: "ASC"
- and "DESC".'
+ description: 'Required. Sorting order of the parameter. Possible values include:
+ "ASC", "DESC".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.RunQueryOrder>
-variables:
-- description: '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. Required. Known values are: "RunStart", "RunEnd",
-
- "PipelineName", "Status", "ActivityName", "ActivityRunStart", "ActivityRunEnd",
- "TriggerName",
-
- and "TriggerRunTimestamp".'
- name: order_by
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.RunQueryOrderByField>
-- description: 'Sorting order of the parameter. Required. Known values are: "ASC"
- and "DESC".'
- name: order
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.RunQueryOrder>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrderByField.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrderByField.yml
index 5c655dc3c131..2774d430e889 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrderByField.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrderByField.yml
@@ -18,21 +18,21 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISAccessCredential.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISAccessCredential.yml
index a811347fbbc1..88c46cd9f297 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISAccessCredential.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISAccessCredential.yml
@@ -4,37 +4,27 @@ name: SSISAccessCredential
fullName: azure.synapse.artifacts.models.SSISAccessCredential
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'SSIS access credential.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SSISAccessCredential(*, domain: MutableMapping[str, Any], user_name: MutableMapping[str,
- Any], password: _models.SecretBase, **kwargs: Any)'
+ syntax: 'SSISAccessCredential(*, domain: object, user_name: object, password: SecretBase,
+ **kwargs)'
parameters:
- name: domain
- description: Domain for windows authentication. Required.
+ description: Required. Domain for windows authentication.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: user_name
- description: UseName for windows authentication. Required.
+ description: Required. UseName for windows authentication.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
- description: Password for windows authentication. Required.
+ description: Required. Password for windows authentication.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
-variables:
-- description: Domain for windows authentication. Required.
- name: domain
- types:
- - <xref:JSON>
-- description: UseName for windows authentication. Required.
- name: user_name
- types:
- - <xref:JSON>
-- description: Password for windows authentication. Required.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISChildPackage.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISChildPackage.yml
index b6c75fdeb5a0..5ed12fd86675 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISChildPackage.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISChildPackage.yml
@@ -4,55 +4,36 @@ name: SSISChildPackage
fullName: azure.synapse.artifacts.models.SSISChildPackage
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'SSIS embedded child package.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SSISChildPackage(*, package_path: MutableMapping[str, Any], package_content:
- MutableMapping[str, Any], package_name: str | None = None, package_last_modified_date:
- str | None = None, **kwargs: Any)'
+ 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: 'Path for embedded child package. Type: string (or Expression with
+ description: 'Required. Path for embedded child package. Type: string (or Expression
- resultType string). Required.'
+ with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: package_name
description: Name for embedded child package.
+ isRequired: true
types:
- <xref:str>
- name: package_content
- description: 'Content for embedded child package. Type: string (or Expression
- with
+ description: 'Required. Content for embedded child package. Type: string (or
- resultType string). Required.'
+ Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: package_last_modified_date
description: Last modified date for embedded child package.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: 'Path for embedded child package. Type: string (or Expression with
-
- resultType string). Required.'
- name: package_path
- types:
- - <xref:JSON>
-- description: Name for embedded child package.
- name: package_name
- types:
- - <xref:str>
-- description: 'Content for embedded child package. Type: string (or Expression with
-
- resultType string). Required.'
- name: package_content
- types:
- - <xref:JSON>
-- description: Last modified date for embedded child package.
- name: package_last_modified_date
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISExecutionCredential.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISExecutionCredential.yml
index 50d2864f5ae5..acb52d278bf7 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISExecutionCredential.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISExecutionCredential.yml
@@ -4,37 +4,27 @@ name: SSISExecutionCredential
fullName: azure.synapse.artifacts.models.SSISExecutionCredential
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'SSIS package execution credential.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SSISExecutionCredential(*, domain: MutableMapping[str, Any], user_name:
- MutableMapping[str, Any], password: _models.SecureString, **kwargs: Any)'
+ syntax: 'SSISExecutionCredential(*, domain: object, user_name: object, password:
+ SecureString, **kwargs)'
parameters:
- name: domain
- description: Domain for windows authentication. Required.
+ description: Required. Domain for windows authentication.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: user_name
- description: UseName for windows authentication. Required.
+ description: Required. UseName for windows authentication.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
- description: Password for windows authentication. Required.
+ description: Required. Password for windows authentication.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecureString>
-variables:
-- description: Domain for windows authentication. Required.
- name: domain
- types:
- - <xref:JSON>
-- description: UseName for windows authentication. Required.
- name: user_name
- types:
- - <xref:JSON>
-- description: Password for windows authentication. Required.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecureString>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISExecutionParameter.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISExecutionParameter.yml
index ca255104501a..385af9c8c08d 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISExecutionParameter.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISExecutionParameter.yml
@@ -4,26 +4,19 @@ name: SSISExecutionParameter
fullName: azure.synapse.artifacts.models.SSISExecutionParameter
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'SSIS execution parameter.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SSISExecutionParameter(*, value: MutableMapping[str, Any], **kwargs: Any)'
+ syntax: 'SSISExecutionParameter(*, value: object, **kwargs)'
parameters:
- name: value
- description: 'SSIS package execution parameter value. Type: string (or Expression
- with
+ description: 'Required. SSIS package execution parameter value. Type: string (or
+ Expression
- resultType string). Required.'
+ with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'SSIS package execution parameter value. Type: string (or Expression
- with
-
- resultType string). Required.'
- name: value
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISLogLocation.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISLogLocation.yml
index b30f39700c2c..e524e61f680c 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISLogLocation.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISLogLocation.yml
@@ -4,30 +4,29 @@ name: SSISLogLocation
fullName: azure.synapse.artifacts.models.SSISLogLocation
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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: MutableMapping[str, Any], type: str | _models.SsisLogLocationType,
- access_credential: _models.SSISAccessCredential | None = None, log_refresh_interval:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ syntax: 'SSISLogLocation(*, log_path: object, access_credential: SSISAccessCredential
+ | None = None, log_refresh_interval: object | None = None, **kwargs)'
parameters:
- name: log_path
- description: 'The SSIS package execution log path. Type: string (or Expression
- with
+ description: 'Required. The SSIS package execution log path. Type: string (or
+ Expression
- resultType string). Required.'
- types:
- - <xref:JSON>
- - name: type
- description: The type of SSIS log location. Required. "File"
+ with resultType string).'
+ isRequired: true
types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SsisLogLocationType>
+ - <xref:object>
- name: access_credential
description: The package execution log access credential.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SSISAccessCredential>
- name: log_refresh_interval
@@ -36,29 +35,15 @@ constructor:
minutes. Type: string (or Expression with resultType string), pattern:
((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
variables:
-- description: 'The SSIS package execution log path. Type: string (or Expression with
-
- resultType string). Required.'
- name: log_path
- types:
- - <xref:JSON>
-- description: The type of SSIS log location. Required. "File"
+- description: 'Required. The type of SSIS log location. Default value: "File".'
name: type
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.SsisLogLocationType>
-- description: The package execution log access credential.
- name: access_credential
- types:
- - <xref:azure.synapse.artifacts.models.SSISAccessCredential>
-- 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])).'
- name: log_refresh_interval
- types:
- - <xref:JSON>
+attributes:
+- uid: azure.synapse.artifacts.models.SSISLogLocation.type
+ name: type
+ signature: type = 'File'
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPackageLocation.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPackageLocation.yml
index f525b3ff9f4e..7073249d324e 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPackageLocation.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPackageLocation.yml
@@ -4,113 +4,68 @@ name: SSISPackageLocation
fullName: azure.synapse.artifacts.models.SSISPackageLocation
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: SSIS package location.
constructor:
- syntax: 'SSISPackageLocation(*, package_path: MutableMapping[str, Any] | None =
- None, type: str | _models.SsisPackageLocationType | None = None, package_password:
- _models.SecretBase | None = None, access_credential: _models.SSISAccessCredential
- | None = None, configuration_path: MutableMapping[str, Any] | None = None, configuration_access_credential:
- _models.SSISAccessCredential | None = None, package_name: str | None = None, package_content:
- MutableMapping[str, Any] | None = None, package_last_modified_date: str | None
- = None, child_packages: List[_models.SSISChildPackage] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:JSON>
+ - <xref:object>
- name: type
- description: 'The type of SSIS package location. Known values are: "SSISDB", "File",
+ description: 'The type of SSIS package location. Possible values include: "SSISDB",
+ "File",
- "InlinePackage", and "PackageStore".'
+ "InlinePackage".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.SsisPackageLocationType>
- name: package_password
description: Password of the package.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: access_credential
description: The package access credential.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SSISAccessCredential>
- name: configuration_path
description: 'The configuration file of the package execution. Type: string (or
Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
- - name: configuration_access_credential
- description: The configuration file access credential.
- types:
- - <xref:azure.synapse.artifacts.models.SSISAccessCredential>
+ - <xref:object>
- name: package_name
description: The package name.
+ isRequired: true
types:
- <xref:str>
- name: package_content
description: 'The embedded package content. Type: string (or Expression with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: package_last_modified_date
description: The embedded package last modified date.
+ isRequired: true
types:
- <xref:str>
- name: child_packages
description: The embedded child package list.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.SSISChildPackage>]
-variables:
-- description: 'The SSIS package path. Type: string (or Expression with resultType
- string).'
- name: package_path
- types:
- - <xref:JSON>
-- description: 'The type of SSIS package location. Known values are: "SSISDB", "File",
-
- "InlinePackage", and "PackageStore".'
- name: type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SsisPackageLocationType>
-- description: Password of the package.
- name: package_password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: The package access credential.
- name: access_credential
- types:
- - <xref:azure.synapse.artifacts.models.SSISAccessCredential>
-- description: 'The configuration file of the package execution. Type: string (or
-
- Expression with resultType string).'
- name: configuration_path
- types:
- - <xref:JSON>
-- description: The configuration file access credential.
- name: configuration_access_credential
- types:
- - <xref:azure.synapse.artifacts.models.SSISAccessCredential>
-- description: The package name.
- name: package_name
- types:
- - <xref:str>
-- description: 'The embedded package content. Type: string (or Expression with
-
- resultType string).'
- name: package_content
- types:
- - <xref:JSON>
-- description: The embedded package last modified date.
- name: package_last_modified_date
- types:
- - <xref:str>
-- description: The embedded child package list.
- name: child_packages
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.SSISChildPackage>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPropertyOverride.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPropertyOverride.yml
index fe109aa8e4bf..bd4071577109 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPropertyOverride.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPropertyOverride.yml
@@ -4,41 +4,28 @@ name: SSISPropertyOverride
fullName: azure.synapse.artifacts.models.SSISPropertyOverride
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'SSIS property override.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SSISPropertyOverride(*, value: MutableMapping[str, Any], is_sensitive:
- bool | None = None, **kwargs: Any)'
+ syntax: 'SSISPropertyOverride(*, value: object, is_sensitive: bool | None = None,
+ **kwargs)'
parameters:
- name: value
- description: 'SSIS package property override value. Type: string (or Expression
- with
+ description: 'Required. SSIS package property override value. Type: string (or
+ Expression with
- resultType string). Required.'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: is_sensitive
description: 'Whether SSIS package property override value is sensitive data.
- Value
+ Value will
- will be encrypted in SSISDB if it is true.'
+ be encrypted in SSISDB if it is true.'
+ isRequired: true
types:
- <xref:bool>
-variables:
-- description: 'SSIS package property override value. Type: string (or Expression
- with resultType
-
- string). Required.'
- name: value
- types:
- - <xref:JSON>
-- description: 'Whether SSIS package property override value is sensitive data. Value
- will
-
- be encrypted in SSISDB if it is true.'
- name: is_sensitive
- types:
- - <xref:bool>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceLinkedService.yml
index 8b2ef5aa5aec..64c107bc3040 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceLinkedService.yml
@@ -10,37 +10,45 @@ summary: 'Linked service for Salesforce.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SalesforceLinkedService(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, environment_url:
- MutableMapping[str, Any] | None = None, username: MutableMapping[str, Any] | None
- = None, password: _models.SecretBase | None = None, security_token: _models.SecretBase
- | None = None, api_version: MutableMapping[str, Any] | None = None, encrypted_credential:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: environment_url
description: 'The URL of Salesforce instance. Default is
@@ -52,107 +60,34 @@ constructor:
''[https://[domain].my.salesforce.com](https://[domain].my.salesforce.com)''.
Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: username
description: 'The username for Basic authentication of the Salesforce instance.
- Type:
+ Type: string
- string (or Expression with resultType string).'
+ (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: The password for Basic authentication of the Salesforce instance.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: security_token
- description: The security token is optional to remotely access Salesforce instance.
+ description: The security token is required to remotely access Salesforce instance.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- - name: api_version
- description: 'The Salesforce API version used in ADF. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- 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).'
- name: environment_url
- types:
- - <xref:JSON>
-- description: 'The username for Basic authentication of the Salesforce instance.
- Type: string
-
- (or Expression with resultType string).'
- name: username
- types:
- - <xref:JSON>
-- description: The password for Basic authentication of the Salesforce instance.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: The security token is optional to remotely access Salesforce instance.
- name: security_token
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The Salesforce API version used in ADF. Type: string (or Expression
- with
-
- resultType string).'
- name: api_version
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService.yml
index 3b3483ba6317..3f2008bcb5df 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService.yml
@@ -10,64 +10,69 @@ summary: 'Salesforce Marketing Cloud linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SalesforceMarketingCloudLinkedService(*, client_id: MutableMapping[str,
- Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- connect_via: _models.IntegrationRuntimeReference | None = None, description: str
- | None = None, parameters: Dict[str, _models.ParameterSpecification] | None =
- None, annotations: List[MutableMapping[str, Any]] | None = None, connection_properties:
- MutableMapping[str, Any] | None = None, client_secret: _models.SecretBase | None
- = None, use_encrypted_endpoints: MutableMapping[str, Any] | None = None, use_host_verification:
- MutableMapping[str, Any] | None = None, use_peer_verification: MutableMapping[str,
- Any] | None = None, encrypted_credential: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
- - name: connection_properties
- description: 'Properties used to connect to Salesforce Marketing Cloud. It is
-
- mutually exclusive with any other properties in the linked service. Type: object.'
- types:
- - <xref:JSON>
+ - <xref:list>[<xref:object>]
- name: client_id
- description: 'The client ID associated with the Salesforce Marketing Cloud application.
+ description: 'Required. The client ID associated with the Salesforce Marketing
+ Cloud
- Type: string (or Expression with resultType string). Required.'
+ application. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: client_secret
description: 'The client secret associated with the Salesforce Marketing Cloud
application. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: use_encrypted_endpoints
- description: 'Specifies whether the data source endpoints are encrypted
+ description: 'Specifies whether the data source endpoints are encrypted using
- using HTTPS. The default value is true. Type: boolean (or Expression with resultType
+ HTTPS. The default value is true. Type: boolean (or Expression with resultType
boolean).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_host_verification
description: 'Specifies whether to require the host name in the server''s
@@ -75,8 +80,9 @@ constructor:
default value is
true. Type: boolean (or Expression with resultType boolean).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_peer_verification
description: 'Specifies whether to verify the identity of the server when
@@ -84,93 +90,16 @@ constructor:
with resultType
boolean).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Properties used to connect to Salesforce Marketing Cloud. It is
-
- mutually exclusive with any other properties in the linked service. Type: object.'
- name: connection_properties
- types:
- - <xref:JSON>
-- description: 'The client ID associated with the Salesforce Marketing Cloud application.
-
- Type: string (or Expression with resultType string). Required.'
- name: client_id
- types:
- - <xref:JSON>
-- description: 'The client secret associated with the Salesforce Marketing Cloud
-
- application. Type: string (or Expression with resultType string).'
- name: client_secret
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Specifies whether the data source endpoints are encrypted using
-
- HTTPS. The default value is true. Type: boolean (or Expression with resultType
- boolean).'
- name: use_encrypted_endpoints
- types:
- - <xref:JSON>
-- 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).'
- name: use_host_verification
- types:
- - <xref:JSON>
-- 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).'
- name: use_peer_verification
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset.yml
index ddce27560011..056f87d30913 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset.yml
@@ -10,109 +10,71 @@ summary: 'Salesforce Marketing Cloud dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SalesforceMarketingCloudObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The table name. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudSource.yml
deleted file mode 100644
index 67049c89ed94..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SalesforceMarketingCloudSource
-name: SalesforceMarketingCloudSource
-fullName: azure.synapse.artifacts.models.SalesforceMarketingCloudSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Salesforce Marketing Cloud source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SalesforceMarketingCloudSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, query:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceObjectDataset.yml
index d60bec0ccdaf..b78ae6504287 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceObjectDataset.yml
@@ -10,113 +10,73 @@ summary: 'The Salesforce object dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SalesforceObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, object_api_name: MutableMapping[str, Any]
- | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: object_api_name
description: 'The Salesforce object API name. Type: string (or Expression with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The Salesforce object API name. Type: string (or Expression with
-
- resultType string).'
- name: object_api_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService.yml
index ee56a59eb779..d83d346c40c1 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService.yml
@@ -11,37 +11,45 @@ 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,
- MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, environment_url:
- MutableMapping[str, Any] | None = None, username: MutableMapping[str, Any] | None
- = None, password: _models.SecretBase | None = None, security_token: _models.SecretBase
- | None = None, api_version: MutableMapping[str, Any] | None = None, extended_properties:
- MutableMapping[str, Any] | None = None, encrypted_credential: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: environment_url
description: 'The URL of Salesforce Service Cloud instance. Default is
@@ -53,119 +61,41 @@ constructor:
''[https://[domain].my.salesforce.com](https://[domain].my.salesforce.com)''.
Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: username
description: 'The username for Basic authentication of the Salesforce instance.
- Type:
+ Type: string
- string (or Expression with resultType string).'
+ (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: The password for Basic authentication of the Salesforce instance.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: security_token
- description: The security token is optional to remotely access Salesforce instance.
+ description: The security token is required to remotely access Salesforce instance.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- - name: api_version
- description: 'The Salesforce API version used in ADF. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- name: extended_properties
- description: 'Extended properties appended to the connection string. Type:
+ description: 'Extended properties appended to the connection string. Type: string
- string (or Expression with resultType string).'
+ (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- 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).'
- name: environment_url
- types:
- - <xref:JSON>
-- description: 'The username for Basic authentication of the Salesforce instance.
- Type: string
-
- (or Expression with resultType string).'
- name: username
- types:
- - <xref:JSON>
-- description: The password for Basic authentication of the Salesforce instance.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: The security token is optional to remotely access Salesforce instance.
- name: security_token
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The Salesforce API version used in ADF. Type: string (or Expression
- with
-
- resultType string).'
- name: api_version
- types:
- - <xref:JSON>
-- description: 'Extended properties appended to the connection string. Type: string
-
- (or Expression with resultType string).'
- name: extended_properties
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset.yml
index 9405fda92487..385cb2ca9b5c 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset.yml
@@ -10,113 +10,73 @@ 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: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, object_api_name: MutableMapping[str, Any]
- | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: object_api_name
description: 'The Salesforce Service Cloud object API name. Type: string (or
Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The Salesforce Service Cloud object API name. Type: string (or
-
- Expression with resultType string).'
- name: object_api_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudSink.yml
deleted file mode 100644
index 095c32606b6a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudSink.yml
+++ /dev/null
@@ -1,165 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SalesforceServiceCloudSink
-name: SalesforceServiceCloudSink
-fullName: azure.synapse.artifacts.models.SalesforceServiceCloudSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Salesforce Service Cloud sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SalesforceServiceCloudSink(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, write_batch_size: MutableMapping[str, Any] | None = None,
- write_batch_timeout: MutableMapping[str, Any] | None = None, sink_retry_count:
- MutableMapping[str, Any] | None = None, sink_retry_wait: MutableMapping[str, Any]
- | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None,
- write_behavior: str | _models.SalesforceSinkWriteBehavior | None = None, external_id_field_name:
- MutableMapping[str, Any] | None = None, ignore_null_values: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: write_behavior
- description: 'The write behavior for the operation. Default is Insert. Known values
-
- are: "Insert" and "Upsert".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SalesforceSinkWriteBehavior>
- - name: external_id_field_name
- description: 'The name of the external ID field for upsert operation.
-
- Default value is ''Id'' column. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
- - name: ignore_null_values
- description: 'The flag indicating whether or not to ignore null values from
-
- input dataset (except key fields) during write operation. Default value is false.
- If set it to
-
- true, it means ADF will leave the data in the destination object unchanged when
- doing
-
- upsert/update operation and insert defined default value when doing insert operation,
- versus
-
- ADF will update the data in the destination object to NULL when doing upsert/update
- operation
-
- and insert NULL value when doing insert operation. Type: boolean (or Expression
- with resultType
-
- boolean).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'The write behavior for the operation. Default is Insert. Known values
-
- are: "Insert" and "Upsert".'
- name: write_behavior
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SalesforceSinkWriteBehavior>
-- description: 'The name of the external ID field for upsert operation. Default
-
- value is ''Id'' column. Type: string (or Expression with resultType string).'
- name: external_id_field_name
- types:
- - <xref:JSON>
-- description: 'The flag indicating whether or not to ignore null values from input
-
- dataset (except key fields) during write operation. Default value is false. If
- set it to true,
-
- it means ADF will leave the data in the destination object unchanged when doing
- upsert/update
-
- operation and insert defined default value when doing insert operation, versus
- ADF will update
-
- the data in the destination object to NULL when doing upsert/update operation
- and insert NULL
-
- value when doing insert operation. Type: boolean (or Expression with resultType
- boolean).'
- name: ignore_null_values
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudSource.yml
deleted file mode 100644
index 43768ab68df4..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudSource.yml
+++ /dev/null
@@ -1,105 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SalesforceServiceCloudSource
-name: SalesforceServiceCloudSource
-fullName: azure.synapse.artifacts.models.SalesforceServiceCloudSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity Salesforce Service Cloud source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SalesforceServiceCloudSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, read_behavior: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query
- description: 'Database query. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: read_behavior
- description: 'The read behavior for the operation. Default is Query. Allowed values:
-
- Query/QueryAll. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Database query. Type: string (or Expression with resultType string).'
- name: query
- types:
- - <xref:JSON>
-- description: 'The read behavior for the operation. Default is Query. Allowed values:
-
- Query/QueryAll. Type: string (or Expression with resultType string).'
- name: read_behavior
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceSink.yml
deleted file mode 100644
index 562e4ee4fa6f..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceSink.yml
+++ /dev/null
@@ -1,165 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SalesforceSink
-name: SalesforceSink
-fullName: azure.synapse.artifacts.models.SalesforceSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Salesforce sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SalesforceSink(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, write_batch_size: MutableMapping[str, Any] | None = None,
- write_batch_timeout: MutableMapping[str, Any] | None = None, sink_retry_count:
- MutableMapping[str, Any] | None = None, sink_retry_wait: MutableMapping[str, Any]
- | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None,
- write_behavior: str | _models.SalesforceSinkWriteBehavior | None = None, external_id_field_name:
- MutableMapping[str, Any] | None = None, ignore_null_values: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: write_behavior
- description: 'The write behavior for the operation. Default is Insert. Known values
-
- are: "Insert" and "Upsert".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SalesforceSinkWriteBehavior>
- - name: external_id_field_name
- description: 'The name of the external ID field for upsert operation.
-
- Default value is ''Id'' column. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
- - name: ignore_null_values
- description: 'The flag indicating whether or not to ignore null values from
-
- input dataset (except key fields) during write operation. Default value is false.
- If set it to
-
- true, it means ADF will leave the data in the destination object unchanged when
- doing
-
- upsert/update operation and insert defined default value when doing insert operation,
- versus
-
- ADF will update the data in the destination object to NULL when doing upsert/update
- operation
-
- and insert NULL value when doing insert operation. Type: boolean (or Expression
- with resultType
-
- boolean).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'The write behavior for the operation. Default is Insert. Known values
-
- are: "Insert" and "Upsert".'
- name: write_behavior
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SalesforceSinkWriteBehavior>
-- description: 'The name of the external ID field for upsert operation. Default
-
- value is ''Id'' column. Type: string (or Expression with resultType string).'
- name: external_id_field_name
- types:
- - <xref:JSON>
-- description: 'The flag indicating whether or not to ignore null values from input
-
- dataset (except key fields) during write operation. Default value is false. If
- set it to true,
-
- it means ADF will leave the data in the destination object unchanged when doing
- upsert/update
-
- operation and insert defined default value when doing insert operation, versus
- ADF will update
-
- the data in the destination object to NULL when doing upsert/update operation
- and insert NULL
-
- value when doing insert operation. Type: boolean (or Expression with resultType
- boolean).'
- name: ignore_null_values
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceSinkWriteBehavior.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceSinkWriteBehavior.yml
deleted file mode 100644
index 6bfeb62eddb4..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceSinkWriteBehavior.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.SalesforceSinkWriteBehavior
-name: SalesforceSinkWriteBehavior
-fullName: azure.synapse.artifacts.models.SalesforceSinkWriteBehavior
-summary: The write behavior for the operation. Default is Insert.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: SalesforceSinkWriteBehavior(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: INSERT
- uid: azure.synapse.artifacts.models.SalesforceSinkWriteBehavior.INSERT
-- name: UPSERT
- uid: azure.synapse.artifacts.models.SalesforceSinkWriteBehavior.UPSERT
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceSource.yml
deleted file mode 100644
index 060c850bbedb..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceSource.yml
+++ /dev/null
@@ -1,118 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SalesforceSource
-name: SalesforceSource
-fullName: azure.synapse.artifacts.models.SalesforceSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Salesforce source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SalesforceSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, query:
- MutableMapping[str, Any] | None = None, read_behavior: MutableMapping[str, Any]
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'Database query. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: read_behavior
- description: 'The read behavior for the operation. Default is Query. Allowed values:
-
- Query/QueryAll. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'Database query. Type: string (or Expression with resultType string).'
- name: query
- types:
- - <xref:JSON>
-- description: 'The read behavior for the operation. Default is Query. Allowed values:
-
- Query/QueryAll. Type: string (or Expression with resultType string).'
- name: read_behavior
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceSourceReadBehavior.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceSourceReadBehavior.yml
deleted file mode 100644
index dc8e2c16df8e..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceSourceReadBehavior.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.SalesforceSourceReadBehavior
-name: SalesforceSourceReadBehavior
-fullName: azure.synapse.artifacts.models.SalesforceSourceReadBehavior
-summary: The Salesforce read behavior for the operation.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: SalesforceSourceReadBehavior(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: QUERY
- uid: azure.synapse.artifacts.models.SalesforceSourceReadBehavior.QUERY
-- name: QUERY_ALL
- uid: azure.synapse.artifacts.models.SalesforceSourceReadBehavior.QUERY_ALL
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBWLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBWLinkedService.yml
index f332acb4bf76..f3860646b9bf 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBWLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBWLinkedService.yml
@@ -10,144 +10,89 @@ summary: 'SAP Business Warehouse Linked Service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SapBWLinkedService(*, server: MutableMapping[str, Any], system_number:
- MutableMapping[str, Any], client_id: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, user_name:
- MutableMapping[str, Any] | None = None, password: _models.SecretBase | None =
- None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: server
- description: 'Host name of the SAP BW instance. Type: string (or Expression with
- resultType
+ description: 'Required. Host name of the SAP BW instance. Type: string (or Expression
+ with
- string). Required.'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: system_number
- description: 'System number of the BW system. (Usually a two-digit decimal number
+ description: 'Required. System number of the BW system. (Usually a two-digit decimal
- represented as a string.) Type: string (or Expression with resultType string).
- Required.'
+ number represented as a string.) Type: string (or Expression with resultType
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: client_id
- description: 'Client ID of the client on the BW system. (Usually a three-digit
- decimal
+ description: 'Required. Client ID of the client on the BW system. (Usually a three-digit
- number represented as a string) Type: string (or Expression with resultType
- string). Required.'
+ decimal number represented as a string) Type: string (or Expression with resultType
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: user_name
description: 'Username to access the SAP BW server. Type: string (or Expression
with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: Password to access the SAP BW server.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Host name of the SAP BW instance. Type: string (or Expression with
- resultType
-
- string). Required.'
- name: server
- types:
- - <xref:JSON>
-- description: 'System number of the BW system. (Usually a two-digit decimal number
-
- represented as a string.) Type: string (or Expression with resultType string).
- Required.'
- name: system_number
- types:
- - <xref:JSON>
-- description: '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).
- Required.'
- name: client_id
- types:
- - <xref:JSON>
-- description: 'Username to access the SAP BW server. Type: string (or Expression
- with
-
- resultType string).'
- name: user_name
- types:
- - <xref:JSON>
-- description: Password to access the SAP BW server.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBwCubeDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBwCubeDataset.yml
index c36cdc805107..3c9575c587b7 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBwCubeDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBwCubeDataset.yml
@@ -10,100 +10,65 @@ summary: 'The SAP BW cube dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SapBwCubeDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBwSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBwSource.yml
deleted file mode 100644
index bc12b36ceef6..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBwSource.yml
+++ /dev/null
@@ -1,105 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SapBwSource
-name: SapBwSource
-fullName: azure.synapse.artifacts.models.SapBwSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity source for SapBW server via MDX.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SapBwSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'MDX query. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'MDX query. Type: string (or Expression with resultType string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerLinkedService.yml
index 96e111f66158..e8199f22fcfd 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerLinkedService.yml
@@ -10,120 +10,76 @@ summary: 'Linked service for SAP Cloud for Customer.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SapCloudForCustomerLinkedService(*, url: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, username:
- MutableMapping[str, Any] | None = None, password: _models.SecretBase | None =
- None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: url
- description: 'The URL of SAP Cloud for Customer OData API. For example,
+ 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). Required.'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: username
description: 'The username for Basic authentication. Type: string (or Expression
with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: The password for Basic authentication.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Either encryptedCredential
+ 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:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: '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). Required.'
- name: url
- types:
- - <xref:JSON>
-- description: 'The username for Basic authentication. Type: string (or Expression
- with
-
- resultType string).'
- name: username
- types:
- - <xref:JSON>
-- description: The password for Basic authentication.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- 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).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset.yml
index ef0d059b5dca..e2e8cb9913e0 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset.yml
@@ -10,114 +10,73 @@ 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: _models.LinkedServiceReference,
- path: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, structure: MutableMapping[str,
- Any] | None = None, schema: MutableMapping[str, Any] | None = None, parameters:
- Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str,
- Any]] | None = None, folder: _models.DatasetFolder | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: path
- description: 'The path of the SAP Cloud for Customer OData entity. Type: string
- (or Expression
+ description: 'Required. The path of the SAP Cloud for Customer OData entity. Type:
+ string (or
- with resultType string). Required.'
+ Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The path of the SAP Cloud for Customer OData entity. Type: string
- (or Expression
-
- with resultType string). Required.'
- name: path
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerSink.yml
deleted file mode 100644
index 531f12e34fc7..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerSink.yml
+++ /dev/null
@@ -1,134 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SapCloudForCustomerSink
-name: SapCloudForCustomerSink
-fullName: azure.synapse.artifacts.models.SapCloudForCustomerSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity SAP Cloud for Customer sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SapCloudForCustomerSink(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, write_batch_size: MutableMapping[str, Any] | None = None,
- write_batch_timeout: MutableMapping[str, Any] | None = None, sink_retry_count:
- MutableMapping[str, Any] | None = None, sink_retry_wait: MutableMapping[str, Any]
- | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None,
- write_behavior: str | _models.SapCloudForCustomerSinkWriteBehavior | None = None,
- http_request_timeout: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: write_behavior
- description: 'The write behavior for the operation. Default is ''Insert''. Known
-
- values are: "Insert" and "Update".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SapCloudForCustomerSinkWriteBehavior>
- - name: http_request_timeout
- description: 'The timeout (TimeSpan) to get an HTTP response. It is the
-
- timeout to get a response, not the timeout to read response data. Default value:
- 00:05:00.
-
- Type: string (or Expression with resultType string), pattern:
-
- ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'The write behavior for the operation. Default is ''Insert''. Known
- values
-
- are: "Insert" and "Update".'
- name: write_behavior
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SapCloudForCustomerSinkWriteBehavior>
-- description: 'The timeout (TimeSpan) to get an HTTP response. It is the timeout
-
- to get a response, not the timeout to read response data. Default value: 00:05:00.
- Type: string
-
- (or Expression with resultType string), pattern:
-
- ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: http_request_timeout
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerSinkWriteBehavior.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerSinkWriteBehavior.yml
deleted file mode 100644
index eb6707e0b8a5..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerSinkWriteBehavior.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.SapCloudForCustomerSinkWriteBehavior
-name: SapCloudForCustomerSinkWriteBehavior
-fullName: azure.synapse.artifacts.models.SapCloudForCustomerSinkWriteBehavior
-summary: The write behavior for the operation. Default is 'Insert'.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: SapCloudForCustomerSinkWriteBehavior(value, names=None, *, module=None,
- qualname=None, type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: INSERT
- uid: azure.synapse.artifacts.models.SapCloudForCustomerSinkWriteBehavior.INSERT
-- name: UPDATE
- uid: azure.synapse.artifacts.models.SapCloudForCustomerSinkWriteBehavior.UPDATE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerSource.yml
deleted file mode 100644
index 8119d3c91cc2..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerSource.yml
+++ /dev/null
@@ -1,134 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SapCloudForCustomerSource
-name: SapCloudForCustomerSource
-fullName: azure.synapse.artifacts.models.SapCloudForCustomerSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity source for SAP Cloud for Customer source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SapCloudForCustomerSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, query:
- MutableMapping[str, Any] | None = None, http_request_timeout: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'SAP Cloud for Customer OData query. For example, "$top=1". Type:
- string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: http_request_timeout
- description: 'The timeout (TimeSpan) to get an HTTP response. It is the
-
- timeout to get a response, not the timeout to read response data. Default value:
- 00:05:00.
-
- Type: string (or Expression with resultType string), pattern:
-
- ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'SAP Cloud for Customer OData query. For example, "$top=1". Type: string
- (or
-
- Expression with resultType string).'
- name: query
- types:
- - <xref:JSON>
-- description: 'The timeout (TimeSpan) to get an HTTP response. It is the timeout
-
- to get a response, not the timeout to read response data. Default value: 00:05:00.
- Type: string
-
- (or Expression with resultType string), pattern:
-
- ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: http_request_timeout
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccLinkedService.yml
index 1dc0b5820e90..71d7453146e5 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccLinkedService.yml
@@ -10,42 +10,52 @@ 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, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, username:
- str | None = None, password: _models.SecretBase | None = None, encrypted_credential:
- str | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: url
- description: 'The URL of SAP ECC OData API. For example,
+ 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). Required.'
+ resultType string).'
+ isRequired: true
types:
- <xref:str>
- name: username
@@ -53,76 +63,22 @@ constructor:
with
resultType string).'
+ isRequired: true
types:
- <xref:str>
- name: password
description: The password for Basic authentication.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Either encryptedCredential
+ 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:
- <xref:str>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: '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). Required.'
- name: url
- types:
- - <xref:str>
-- description: 'The username for Basic authentication. Type: string (or Expression
- with
-
- resultType string).'
- name: username
- types:
- - <xref:str>
-- description: The password for Basic authentication.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- 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).'
- name: encrypted_credential
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccResourceDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccResourceDataset.yml
index c2a95ce431f4..3fa480e0f94d 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccResourceDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccResourceDataset.yml
@@ -10,114 +10,73 @@ 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: _models.LinkedServiceReference,
- path: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, structure: MutableMapping[str,
- Any] | None = None, schema: MutableMapping[str, Any] | None = None, parameters:
- Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str,
- Any]] | None = None, folder: _models.DatasetFolder | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: path
- description: 'The path of the SAP ECC OData entity. Type: string (or Expression
- with
+ description: 'Required. The path of the SAP ECC OData entity. Type: string (or
+ Expression with
- resultType string). Required.'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The path of the SAP ECC OData entity. Type: string (or Expression
- with resultType
-
- string). Required.'
- name: path
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccSource.yml
deleted file mode 100644
index e3ba682a4127..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccSource.yml
+++ /dev/null
@@ -1,134 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SapEccSource
-name: SapEccSource
-fullName: azure.synapse.artifacts.models.SapEccSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity source for SAP ECC source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SapEccSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, http_request_timeout: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'SAP ECC OData query. For example, "$top=1". Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: http_request_timeout
- description: 'The timeout (TimeSpan) to get an HTTP response. It is the
-
- timeout to get a response, not the timeout to read response data. Default value:
- 00:05:00.
-
- Type: string (or Expression with resultType string), pattern:
-
- ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'SAP ECC OData query. For example, "$top=1". Type: string (or Expression
- with
-
- resultType string).'
- name: query
- types:
- - <xref:JSON>
-- description: 'The timeout (TimeSpan) to get an HTTP response. It is the timeout
-
- to get a response, not the timeout to read response data. Default value: 00:05:00.
- Type: string
-
- (or Expression with resultType string), pattern:
-
- ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: http_request_timeout
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaAuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaAuthenticationType.yml
index ac73b0cc2fb6..0efe47987c2e 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaAuthenticationType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaAuthenticationType.yml
@@ -11,7 +11,7 @@ inheritances:
- builtins.str
- enum.Enum
fields:
-- name: BASIC
- uid: azure.synapse.artifacts.models.SapHanaAuthenticationType.BASIC
-- name: WINDOWS
- uid: azure.synapse.artifacts.models.SapHanaAuthenticationType.WINDOWS
+- name: basic
+ uid: azure.synapse.artifacts.models.SapHanaAuthenticationType.basic
+- name: windows
+ uid: azure.synapse.artifacts.models.SapHanaAuthenticationType.windows
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaLinkedService.yml
index eb0ea8d775b9..bd5c1ef84a91 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaLinkedService.yml
@@ -10,54 +10,66 @@ summary: 'SAP HANA Linked Service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SapHanaLinkedService(*, server: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, connection_string:
- MutableMapping[str, Any] | None = None, authentication_type: str | _models.SapHanaAuthenticationType
- | None = None, user_name: MutableMapping[str, Any] | None = None, password: _models.SecretBase
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
description: 'SAP HANA ODBC connection string. Type: string, SecureString or
AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: server
- description: 'Host name of the SAP HANA server. Type: string (or Expression with
- resultType
+ description: 'Required. Host name of the SAP HANA server. Type: string (or Expression
+ with
- string). Required.'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: authentication_type
description: 'The authentication type to be used to connect to the SAP HANA
- server. Known values are: "Basic" and "Windows".'
+ server. Possible values include: "Basic", "Windows".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.SapHanaAuthenticationType>
@@ -66,85 +78,21 @@ constructor:
with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: Password to access the SAP HANA server.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'SAP HANA ODBC connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: 'Host name of the SAP HANA server. Type: string (or Expression with
- resultType
-
- string). Required.'
- name: server
- types:
- - <xref:JSON>
-- description: 'The authentication type to be used to connect to the SAP HANA
-
- server. Known values are: "Basic" and "Windows".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SapHanaAuthenticationType>
-- description: 'Username to access the SAP HANA server. Type: string (or Expression
- with
-
- resultType string).'
- name: user_name
- types:
- - <xref:JSON>
-- description: Password to access the SAP HANA server.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaPartitionOption.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaPartitionOption.yml
deleted file mode 100644
index 28075b632066..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaPartitionOption.yml
+++ /dev/null
@@ -1,19 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.SapHanaPartitionOption
-name: SapHanaPartitionOption
-fullName: azure.synapse.artifacts.models.SapHanaPartitionOption
-summary: The partition mechanism that will be used for SAP HANA read in parallel.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: SapHanaPartitionOption(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: NONE
- uid: azure.synapse.artifacts.models.SapHanaPartitionOption.NONE
-- name: PHYSICAL_PARTITIONS_OF_TABLE
- uid: azure.synapse.artifacts.models.SapHanaPartitionOption.PHYSICAL_PARTITIONS_OF_TABLE
-- name: SAP_HANA_DYNAMIC_RANGE
- uid: azure.synapse.artifacts.models.SapHanaPartitionOption.SAP_HANA_DYNAMIC_RANGE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaPartitionSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaPartitionSettings.yml
deleted file mode 100644
index 72def64bd5eb..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaPartitionSettings.yml
+++ /dev/null
@@ -1,25 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SapHanaPartitionSettings
-name: SapHanaPartitionSettings
-fullName: azure.synapse.artifacts.models.SapHanaPartitionSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: The settings that will be leveraged for SAP HANA source partitioning.
-constructor:
- syntax: 'SapHanaPartitionSettings(*, partition_column_name: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: partition_column_name
- description: 'The name of the column that will be used for proceeding range
-
- partitioning. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'The name of the column that will be used for proceeding range
-
- partitioning. Type: string (or Expression with resultType string).'
- name: partition_column_name
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaSource.yml
deleted file mode 100644
index 5b46aee4a7c6..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaSource.yml
+++ /dev/null
@@ -1,145 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SapHanaSource
-name: SapHanaSource
-fullName: azure.synapse.artifacts.models.SapHanaSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity source for SAP HANA source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SapHanaSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, packet_size: MutableMapping[str, Any] | None = None, partition_option:
- str | _models.SapHanaPartitionOption | None = None, partition_settings: _models.SapHanaPartitionSettings
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'SAP HANA Sql query. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
- - name: packet_size
- description: 'The packet size of data read from SAP HANA. Type: integer(or Expression
-
- with resultType integer).'
- types:
- - <xref:JSON>
- - name: partition_option
- description: 'The partition mechanism that will be used for SAP HANA read in
-
- parallel. Known values are: "None", "PhysicalPartitionsOfTable", and "SapHanaDynamicRange".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SapHanaPartitionOption>
- - name: partition_settings
- description: 'The settings that will be leveraged for SAP HANA source
-
- partitioning.'
- types:
- - <xref:azure.synapse.artifacts.models.SapHanaPartitionSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'SAP HANA Sql query. Type: string (or Expression with resultType string).'
- name: query
- types:
- - <xref:JSON>
-- description: 'The packet size of data read from SAP HANA. Type: integer(or Expression
- with
-
- resultType integer).'
- name: packet_size
- types:
- - <xref:JSON>
-- description: 'The partition mechanism that will be used for SAP HANA read in
-
- parallel. Known values are: "None", "PhysicalPartitionsOfTable", and "SapHanaDynamicRange".'
- name: partition_option
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SapHanaPartitionOption>
-- description: The settings that will be leveraged for SAP HANA source partitioning.
- name: partition_settings
- types:
- - <xref:azure.synapse.artifacts.models.SapHanaPartitionSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaTableDataset.yml
index 7eaab086d0b2..1c6fe95c6f78 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaTableDataset.yml
@@ -10,124 +10,79 @@ summary: 'SAP HANA Table properties.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SapHanaTableDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, schema_type_properties_schema: MutableMapping[str,
- Any] | None = None, table: MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: schema_type_properties_schema
- description: 'The schema name of SAP HANA. Type: string (or
+ description: 'The schema name of SAP HANA. Type: string (or Expression
- Expression with resultType string).'
+ with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: table
description: 'The table name of SAP HANA. Type: string (or Expression with resultType
-
string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The schema name of SAP HANA. Type: string (or Expression
-
- with resultType string).'
- name: schema_type_properties_schema
- types:
- - <xref:JSON>
-- description: 'The table name of SAP HANA. Type: string (or Expression with resultType
- string).'
- name: table
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOdpLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOdpLinkedService.yml
deleted file mode 100644
index a7fba2d4d378..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOdpLinkedService.yml
+++ /dev/null
@@ -1,331 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SapOdpLinkedService
-name: SapOdpLinkedService
-fullName: azure.synapse.artifacts.models.SapOdpLinkedService
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.LinkedService
-summary: 'SAP ODP Linked Service.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SapOdpLinkedService(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, server:
- MutableMapping[str, Any] | None = None, system_number: MutableMapping[str, Any]
- | None = None, client_id: MutableMapping[str, Any] | None = None, language: MutableMapping[str,
- Any] | None = None, system_id: MutableMapping[str, Any] | None = None, user_name:
- MutableMapping[str, Any] | None = None, password: _models.SecretBase | None =
- None, message_server: MutableMapping[str, Any] | None = None, message_server_service:
- MutableMapping[str, Any] | None = None, snc_mode: MutableMapping[str, Any] | None
- = None, snc_my_name: MutableMapping[str, Any] | None = None, snc_partner_name:
- MutableMapping[str, Any] | None = None, snc_library_path: MutableMapping[str,
- Any] | None = None, snc_qop: MutableMapping[str, Any] | None = None, x509_certificate_path:
- MutableMapping[str, Any] | None = None, logon_group: MutableMapping[str, Any]
- | None = None, subscriber_name: MutableMapping[str, Any] | None = None, encrypted_credential:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: connect_via
- description: The integration runtime reference.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- - name: description
- description: Linked service description.
- types:
- - <xref:str>
- - name: parameters
- description: Parameters for linked service.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the linked service.
- types:
- - <xref:list>[<xref:JSON>]
- - name: server
- description: 'Host name of the SAP instance where the table is located. Type:
- string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - 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).'
- types:
- - <xref:JSON>
- - 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).'
- types:
- - <xref:JSON>
- - 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).'
- types:
- - <xref:JSON>
- - name: system_id
- description: 'SystemID of the SAP system where the table is located. Type: string
- (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: user_name
- description: 'Username to access the SAP server where the table is located. Type:
- string
-
- (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: password
- description: Password to access the SAP server where the table is located.
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
- - name: message_server
- description: 'The hostname of the SAP Message Server. Type: string (or Expression
-
- with resultType string).'
- types:
- - <xref:JSON>
- - name: message_server_service
- description: 'The service name or port number of the Message Server. Type:
-
- string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - 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).'
- types:
- - <xref:JSON>
- - 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).'
- types:
- - <xref:JSON>
- - 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).'
- types:
- - <xref:JSON>
- - 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).'
- types:
- - <xref:JSON>
- - name: snc_qop
- description: 'SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9.
- Type: string
-
- (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: x509_certificate_path
- description: 'SNC X509 certificate file path. Type: string (or Expression
-
- with resultType string).'
- types:
- - <xref:JSON>
- - name: logon_group
- description: 'The Logon Group for the SAP System. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: subscriber_name
- description: 'The subscriber name. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - 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).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Host name of the SAP instance where the table is located. Type: string
- (or
-
- Expression with resultType string).'
- name: server
- types:
- - <xref:JSON>
-- 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).'
- name: system_number
- types:
- - <xref:JSON>
-- 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).'
- name: client_id
- types:
- - <xref:JSON>
-- description: 'Language of the SAP system where the table is located. The default
- value is EN.
-
- Type: string (or Expression with resultType string).'
- name: language
- types:
- - <xref:JSON>
-- description: 'SystemID of the SAP system where the table is located. Type: string
- (or
-
- Expression with resultType string).'
- name: system_id
- types:
- - <xref:JSON>
-- description: 'Username to access the SAP server where the table is located. Type:
- string (or
-
- Expression with resultType string).'
- name: user_name
- types:
- - <xref:JSON>
-- description: Password to access the SAP server where the table is located.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The hostname of the SAP Message Server. Type: string (or Expression
- with
-
- resultType string).'
- name: message_server
- types:
- - <xref:JSON>
-- description: 'The service name or port number of the Message Server. Type:
-
- string (or Expression with resultType string).'
- name: message_server_service
- types:
- - <xref:JSON>
-- 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).'
- name: snc_mode
- types:
- - <xref:JSON>
-- description: 'Initiator''s SNC name to access the SAP server where the table is
- located.
-
- Type: string (or Expression with resultType string).'
- name: snc_my_name
- types:
- - <xref:JSON>
-- description: 'Communication partner''s SNC name to access the SAP server where the
-
- table is located. Type: string (or Expression with resultType string).'
- name: snc_partner_name
- types:
- - <xref:JSON>
-- description: 'External security product''s library to access the SAP server where
- the
-
- table is located. Type: string (or Expression with resultType string).'
- name: snc_library_path
- types:
- - <xref:JSON>
-- description: 'SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type:
- string
-
- (or Expression with resultType string).'
- name: snc_qop
- types:
- - <xref:JSON>
-- description: 'SNC X509 certificate file path. Type: string (or Expression with
-
- resultType string).'
- name: x509_certificate_path
- types:
- - <xref:JSON>
-- description: 'The Logon Group for the SAP System. Type: string (or Expression with
-
- resultType string).'
- name: logon_group
- types:
- - <xref:JSON>
-- description: 'The subscriber name. Type: string (or Expression with resultType
-
- string).'
- name: subscriber_name
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOdpResourceDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOdpResourceDataset.yml
deleted file mode 100644
index 5fe591a45a30..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOdpResourceDataset.yml
+++ /dev/null
@@ -1,135 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SapOdpResourceDataset
-name: SapOdpResourceDataset
-fullName: azure.synapse.artifacts.models.SapOdpResourceDataset
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.Dataset
-summary: 'SAP ODP Resource properties.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SapOdpResourceDataset(*, linked_service_name: _models.LinkedServiceReference,
- context: MutableMapping[str, Any], object_name: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None,
- structure: MutableMapping[str, Any] | None = None, schema: MutableMapping[str,
- Any] | None = None, parameters: Dict[str, _models.ParameterSpecification] | None
- = None, annotations: List[MutableMapping[str, Any]] | None = None, folder: _models.DatasetFolder
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Dataset description.
- types:
- - <xref:str>
- - name: structure
- description: 'Columns that define the structure of the dataset. Type: array (or
-
- Expression with resultType array), itemType: DatasetDataElement.'
- types:
- - <xref:JSON>
- - name: schema
- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- types:
- - <xref:JSON>
- - name: linked_service_name
- description: Linked service reference. Required.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: parameters
- description: Parameters for dataset.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the Dataset.
- types:
- - <xref:list>[<xref:JSON>]
- - name: folder
- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
-
- the root level.'
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
- - name: context
- description: 'The context of the SAP ODP Object. Type: string (or Expression with
-
- resultType string). Required.'
- types:
- - <xref:JSON>
- - name: object_name
- description: 'The name of the SAP ODP Object. Type: string (or Expression with
-
- resultType string). Required.'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The context of the SAP ODP Object. Type: string (or Expression with
- resultType
-
- string). Required.'
- name: context
- types:
- - <xref:JSON>
-- description: 'The name of the SAP ODP Object. Type: string (or Expression with resultType
-
- string). Required.'
- name: object_name
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOdpSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOdpSource.yml
deleted file mode 100644
index 218a6ea4b3e9..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOdpSource.yml
+++ /dev/null
@@ -1,150 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SapOdpSource
-name: SapOdpSource
-fullName: azure.synapse.artifacts.models.SapOdpSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity source for SAP ODP source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SapOdpSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, extraction_mode: MutableMapping[str, Any]
- | None = None, subscriber_process: MutableMapping[str, Any] | None = None, selection:
- MutableMapping[str, Any] | None = None, projection: MutableMapping[str, Any] |
- None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: extraction_mode
- description: 'The extraction mode. Allowed value include: Full, Delta and Recovery.
-
- The default value is Full. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: subscriber_process
- description: 'The subscriber process to manage the delta process. Type: string
-
- (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: selection
- description: 'Specifies the selection conditions from source data. Type: array
- of
-
- objects(selection) (or Expression with resultType array of objects).'
- types:
- - <xref:JSON>
- - name: projection
- description: 'Specifies the columns to be selected from source data. Type: array
- of
-
- objects(projection) (or Expression with resultType array of objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'The extraction mode. Allowed value include: Full, Delta and Recovery.
-
- The default value is Full. Type: string (or Expression with resultType string).'
- name: extraction_mode
- types:
- - <xref:JSON>
-- description: 'The subscriber process to manage the delta process. Type: string (or
-
- Expression with resultType string).'
- name: subscriber_process
- types:
- - <xref:JSON>
-- description: 'Specifies the selection conditions from source data. Type: array of
-
- objects(selection) (or Expression with resultType array of objects).'
- name: selection
- types:
- - <xref:JSON>
-- description: 'Specifies the columns to be selected from source data. Type: array
- of
-
- objects(projection) (or Expression with resultType array of objects).'
- name: projection
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubLinkedService.yml
index beeb7f29d028..3040da4d3279 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubLinkedService.yml
@@ -10,226 +10,105 @@ 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: MutableMapping[str, Any], system_number:
- MutableMapping[str, Any], client_id: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, language:
- MutableMapping[str, Any] | None = None, system_id: MutableMapping[str, Any] |
- None = None, user_name: MutableMapping[str, Any] | None = None, password: _models.SecretBase
- | None = None, message_server: MutableMapping[str, Any] | None = None, message_server_service:
- MutableMapping[str, Any] | None = None, logon_group: MutableMapping[str, Any]
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: server
- description: 'Host name of the SAP BW instance where the open hub destination
- is located.
+ description: 'Required. Host name of the SAP BW instance where the open hub destination
+ is
- Type: string (or Expression with resultType string). Required.'
+ located. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: system_number
- description: 'System number of the BW system where the open hub destination is
+ description: 'Required. System number of the BW system where the open hub destination
- located. (Usually a two-digit decimal number represented as a string.) Type:
+ is located. (Usually a two-digit decimal number represented as a string.) Type:
string (or
- Expression with resultType string). Required.'
+ Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: client_id
- description: 'Client ID of the client on the BW system where the open hub destination
- is
+ description: 'Required. Client ID of the client on the BW system where the open
+ hub
- located. (Usually a three-digit decimal number represented as a string) Type:
- string (or
+ destination is located. (Usually a three-digit decimal number represented as
+ a string) Type:
- Expression with resultType string). Required.'
+ string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
- - name: system_id
- description: 'SystemID of the SAP system where the table is located. Type: string
- (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: 'Password to access the SAP BW server where the open hub destination
is
located.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- - name: message_server
- description: 'The hostname of the SAP Message Server. Type: string (or Expression
-
- with resultType string).'
- types:
- - <xref:JSON>
- - name: message_server_service
- description: 'The service name or port number of the Message Server. Type:
-
- string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: logon_group
- description: 'The Logon Group for the SAP System. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Host name of the SAP BW instance where the open hub destination is
- located. Type:
-
- string (or Expression with resultType string). Required.'
- name: server
- types:
- - <xref:JSON>
-- description: '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). Required.'
- name: system_number
- types:
- - <xref:JSON>
-- description: '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). Required.'
- name: client_id
- types:
- - <xref:JSON>
-- 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).'
- name: language
- types:
- - <xref:JSON>
-- description: 'SystemID of the SAP system where the table is located. Type: string
- (or
-
- Expression with resultType string).'
- name: system_id
- types:
- - <xref:JSON>
-- description: 'Username to access the SAP BW server where the open hub destination
- is
-
- located. Type: string (or Expression with resultType string).'
- name: user_name
- types:
- - <xref:JSON>
-- description: Password to access the SAP BW server where the open hub destination
- is located.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The hostname of the SAP Message Server. Type: string (or Expression
- with
-
- resultType string).'
- name: message_server
- types:
- - <xref:JSON>
-- description: 'The service name or port number of the Message Server. Type:
-
- string (or Expression with resultType string).'
- name: message_server_service
- types:
- - <xref:JSON>
-- description: 'The Logon Group for the SAP System. Type: string (or Expression with
-
- resultType string).'
- name: logon_group
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubSource.yml
deleted file mode 100644
index 6418deb53871..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubSource.yml
+++ /dev/null
@@ -1,162 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SapOpenHubSource
-name: SapOpenHubSource
-fullName: azure.synapse.artifacts.models.SapOpenHubSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity source for SAP Business Warehouse Open Hub Destination source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SapOpenHubSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, exclude_last_request:
- MutableMapping[str, Any] | None = None, base_request_id: MutableMapping[str, Any]
- | None = None, custom_rfc_read_table_function_module: MutableMapping[str, Any]
- | None = None, sap_data_column_delimiter: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - 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).'
- types:
- - <xref:JSON>
- - 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 ).'
- types:
- - <xref:JSON>
- - name: custom_rfc_read_table_function_module
- description: 'Specifies the custom RFC function module that
-
- will be used to read data from SAP Table. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
- - name: sap_data_column_delimiter
- description: 'The single character that will be used as delimiter passed
-
- to SAP RFC as well as splitting the output data retrieved. Type: string (or
- Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'Whether to exclude the records of the last request. The default
-
- value is true. Type: boolean (or Expression with resultType boolean).'
- name: exclude_last_request
- types:
- - <xref:JSON>
-- 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 ).'
- name: base_request_id
- types:
- - <xref:JSON>
-- description: 'Specifies the custom RFC function module that will
-
- be used to read data from SAP Table. Type: string (or Expression with resultType
- string).'
- name: custom_rfc_read_table_function_module
- types:
- - <xref:JSON>
-- description: 'The single character that will be used as delimiter passed to
-
- SAP RFC as well as splitting the output data retrieved. Type: string (or Expression
- with
-
- resultType string).'
- name: sap_data_column_delimiter
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubTableDataset.yml
index d06fe9545203..9372bfab8e33 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubTableDataset.yml
@@ -10,69 +10,85 @@ 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: _models.LinkedServiceReference,
- open_hub_destination_name: MutableMapping[str, Any], additional_properties: Dict[str,
- MutableMapping[str, Any]] | None = None, description: str | None = None, structure:
- MutableMapping[str, Any] | None = None, schema: MutableMapping[str, Any] | None
- = None, parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations:
- List[MutableMapping[str, Any]] | None = None, folder: _models.DatasetFolder |
- None = None, exclude_last_request: MutableMapping[str, Any] | None = None, base_request_id:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: open_hub_destination_name
- description: 'The name of the Open Hub Destination with destination type
+ description: 'Required. The name of the Open Hub Destination with
- as Database Table. Type: string (or Expression with resultType string). Required.'
+ destination type as Database Table. Type: string (or Expression with resultType
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: base_request_id
description: 'The ID of request for delta loading. Once it is set, only data with
@@ -80,74 +96,6 @@ constructor:
value is 0.
Type: integer (or Expression with resultType integer ).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The name of the Open Hub Destination with destination type as
-
- Database Table. Type: string (or Expression with resultType string). Required.'
- name: open_hub_destination_name
- types:
- - <xref:JSON>
-- description: 'Whether to exclude the records of the last request. The default
-
- value is true. Type: boolean (or Expression with resultType boolean).'
- name: exclude_last_request
- types:
- - <xref:JSON>
-- 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 ).'
- name: base_request_id
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableLinkedService.yml
index 887be2e0dc98..3698074f91cb 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableLinkedService.yml
@@ -10,51 +10,58 @@ summary: 'SAP Table Linked Service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SapTableLinkedService(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, server:
- MutableMapping[str, Any] | None = None, system_number: MutableMapping[str, Any]
- | None = None, client_id: MutableMapping[str, Any] | None = None, language: MutableMapping[str,
- Any] | None = None, system_id: MutableMapping[str, Any] | None = None, user_name:
- MutableMapping[str, Any] | None = None, password: _models.SecretBase | None =
- None, message_server: MutableMapping[str, Any] | None = None, message_server_service:
- MutableMapping[str, Any] | None = None, snc_mode: MutableMapping[str, Any] | None
- = None, snc_my_name: MutableMapping[str, Any] | None = None, snc_partner_name:
- MutableMapping[str, Any] | None = None, snc_library_path: MutableMapping[str,
- Any] | None = None, snc_qop: MutableMapping[str, Any] | None = None, logon_group:
- MutableMapping[str, Any] | None = None, encrypted_credential: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: server
description: 'Host name of the SAP instance where the table is located. Type:
string (or
Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: system_number
description: 'System number of the SAP system where the table is located. (Usually
a
@@ -63,8 +70,9 @@ constructor:
with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: client_id
description: 'Client ID of the client on the SAP system where the table is located.
@@ -72,235 +80,109 @@ constructor:
(or Expression with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: system_id
description: 'SystemID of the SAP system where the table is located. Type: string
(or
Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: Password to access the SAP server where the table is located.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: message_server
description: 'The hostname of the SAP Message Server. Type: string (or Expression
+ with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: snc_mode
description: 'SNC activation indicator to access the SAP server where the table
- is
+ is located.
- located. Must be either 0 (off) or 1 (on). Type: string (or Expression with
- resultType string).'
+ Must be either 0 (off) or 1 (on). Type: string (or Expression with resultType
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: snc_library_path
description: 'External security product''s library to access the SAP server where
+ the
- the table is located. Type: string (or Expression with resultType string).'
+ table is located. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: logon_group
description: 'The Logon Group for the SAP System. Type: string (or Expression
with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Host name of the SAP instance where the table is located. Type: string
- (or
-
- Expression with resultType string).'
- name: server
- types:
- - <xref:JSON>
-- 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).'
- name: system_number
- types:
- - <xref:JSON>
-- 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).'
- name: client_id
- types:
- - <xref:JSON>
-- description: 'Language of the SAP system where the table is located. The default
- value is EN.
-
- Type: string (or Expression with resultType string).'
- name: language
- types:
- - <xref:JSON>
-- description: 'SystemID of the SAP system where the table is located. Type: string
- (or
-
- Expression with resultType string).'
- name: system_id
- types:
- - <xref:JSON>
-- description: 'Username to access the SAP server where the table is located. Type:
- string (or
-
- Expression with resultType string).'
- name: user_name
- types:
- - <xref:JSON>
-- description: Password to access the SAP server where the table is located.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The hostname of the SAP Message Server. Type: string (or Expression
- with
-
- resultType string).'
- name: message_server
- types:
- - <xref:JSON>
-- description: 'The service name or port number of the Message Server. Type:
-
- string (or Expression with resultType string).'
- name: message_server_service
- types:
- - <xref:JSON>
-- 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).'
- name: snc_mode
- types:
- - <xref:JSON>
-- description: 'Initiator''s SNC name to access the SAP server where the table is
- located.
-
- Type: string (or Expression with resultType string).'
- name: snc_my_name
- types:
- - <xref:JSON>
-- description: 'Communication partner''s SNC name to access the SAP server where the
-
- table is located. Type: string (or Expression with resultType string).'
- name: snc_partner_name
- types:
- - <xref:JSON>
-- description: 'External security product''s library to access the SAP server where
- the
-
- table is located. Type: string (or Expression with resultType string).'
- name: snc_library_path
- types:
- - <xref:JSON>
-- description: 'SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type:
- string
-
- (or Expression with resultType string).'
- name: snc_qop
- types:
- - <xref:JSON>
-- description: 'The Logon Group for the SAP System. Type: string (or Expression with
-
- resultType string).'
- name: logon_group
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTablePartitionOption.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTablePartitionOption.yml
deleted file mode 100644
index 50b9b43c5701..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTablePartitionOption.yml
+++ /dev/null
@@ -1,25 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.SapTablePartitionOption
-name: SapTablePartitionOption
-fullName: azure.synapse.artifacts.models.SapTablePartitionOption
-summary: The partition mechanism that will be used for SAP table read in parallel.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: SapTablePartitionOption(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: NONE
- uid: azure.synapse.artifacts.models.SapTablePartitionOption.NONE
-- name: PARTITION_ON_CALENDAR_DATE
- uid: azure.synapse.artifacts.models.SapTablePartitionOption.PARTITION_ON_CALENDAR_DATE
-- name: PARTITION_ON_CALENDAR_MONTH
- uid: azure.synapse.artifacts.models.SapTablePartitionOption.PARTITION_ON_CALENDAR_MONTH
-- name: PARTITION_ON_CALENDAR_YEAR
- uid: azure.synapse.artifacts.models.SapTablePartitionOption.PARTITION_ON_CALENDAR_YEAR
-- name: PARTITION_ON_INT
- uid: azure.synapse.artifacts.models.SapTablePartitionOption.PARTITION_ON_INT
-- name: PARTITION_ON_TIME
- uid: azure.synapse.artifacts.models.SapTablePartitionOption.PARTITION_ON_TIME
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTablePartitionSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTablePartitionSettings.yml
deleted file mode 100644
index 4865e011ed26..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTablePartitionSettings.yml
+++ /dev/null
@@ -1,75 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SapTablePartitionSettings
-name: SapTablePartitionSettings
-fullName: azure.synapse.artifacts.models.SapTablePartitionSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: The settings that will be leveraged for SAP table source partitioning.
-constructor:
- syntax: 'SapTablePartitionSettings(*, partition_column_name: MutableMapping[str,
- Any] | None = None, partition_upper_bound: MutableMapping[str, Any] | None = None,
- partition_lower_bound: MutableMapping[str, Any] | None = None, max_partitions_number:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: partition_column_name
- description: 'The name of the column that will be used for proceeding range
-
- partitioning. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: partition_upper_bound
- description: 'The maximum value of column specified in partitionColumnName
-
- that will be used for proceeding range partitioning. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: partition_lower_bound
- description: 'The minimum value of column specified in partitionColumnName
-
- that will be used for proceeding range partitioning. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: max_partitions_number
- description: 'The maximum value of partitions the table will be split into.
-
- Type: integer (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'The name of the column that will be used for proceeding range
-
- partitioning. Type: string (or Expression with resultType string).'
- name: partition_column_name
- types:
- - <xref:JSON>
-- description: 'The maximum value of column specified in partitionColumnName that
-
- will be used for proceeding range partitioning. Type: string (or Expression with
- resultType
-
- string).'
- name: partition_upper_bound
- types:
- - <xref:JSON>
-- description: 'The minimum value of column specified in partitionColumnName that
-
- will be used for proceeding range partitioning. Type: string (or Expression with
- resultType
-
- string).'
- name: partition_lower_bound
- types:
- - <xref:JSON>
-- description: 'The maximum value of partitions the table will be split into.
-
- Type: integer (or Expression with resultType string).'
- name: max_partitions_number
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableResourceDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableResourceDataset.yml
index db28d0a812bf..99c58c03a4f2 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableResourceDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableResourceDataset.yml
@@ -10,112 +10,73 @@ summary: 'SAP Table Resource properties.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SapTableResourceDataset(*, linked_service_name: _models.LinkedServiceReference,
- table_name: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, structure: MutableMapping[str,
- Any] | None = None, schema: MutableMapping[str, Any] | None = None, parameters:
- Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str,
- Any]] | None = None, folder: _models.DatasetFolder | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
- description: 'The name of the SAP Table. Type: string (or Expression with resultType
+ description: 'Required. The name of the SAP Table. Type: string (or Expression
+ with
- string). Required.'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The name of the SAP Table. Type: string (or Expression with resultType
-
- string). Required.'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableSource.yml
deleted file mode 100644
index 8a27806a8e4d..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableSource.yml
+++ /dev/null
@@ -1,231 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SapTableSource
-name: SapTableSource
-fullName: azure.synapse.artifacts.models.SapTableSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity source for SAP Table source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SapTableSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, row_count:
- MutableMapping[str, Any] | None = None, row_skips: MutableMapping[str, Any] |
- None = None, rfc_table_fields: MutableMapping[str, Any] | None = None, rfc_table_options:
- MutableMapping[str, Any] | None = None, batch_size: MutableMapping[str, Any] |
- None = None, custom_rfc_read_table_function_module: MutableMapping[str, Any] |
- None = None, sap_data_column_delimiter: MutableMapping[str, Any] | None = None,
- partition_option: str | _models.SapTablePartitionOption | None = None, partition_settings:
- _models.SapTablePartitionSettings | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: row_count
- description: 'The number of rows to be retrieved. Type: integer(or Expression
- with
-
- resultType integer).'
- types:
- - <xref:JSON>
- - name: row_skips
- description: 'The number of rows that will be skipped. Type: integer (or Expression
- with
-
- resultType integer).'
- types:
- - <xref:JSON>
- - name: rfc_table_fields
- description: 'The fields of the SAP table that will be retrieved. For example,
-
- column0, column1. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: rfc_table_options
- description: 'The options for the filtering of the SAP Table. For example,
-
- COLUMN0 EQ SOME VALUE. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: batch_size
- description: 'Specifies the maximum number of rows that will be retrieved at a
- time when
-
- retrieving data from SAP Table. Type: integer (or Expression with resultType
- integer).'
- types:
- - <xref:JSON>
- - name: custom_rfc_read_table_function_module
- description: 'Specifies the custom RFC function module that
-
- will be used to read data from SAP Table. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
- - name: sap_data_column_delimiter
- description: 'The single character that will be used as delimiter passed
-
- to SAP RFC as well as splitting the output data retrieved. Type: string (or
- Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: partition_option
- description: 'The partition mechanism that will be used for SAP table read in
-
- parallel. Known values are: "None", "PartitionOnInt", "PartitionOnCalendarYear",
-
- "PartitionOnCalendarMonth", "PartitionOnCalendarDate", and "PartitionOnTime".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SapTablePartitionOption>
- - name: partition_settings
- description: 'The settings that will be leveraged for SAP table source
-
- partitioning.'
- types:
- - <xref:azure.synapse.artifacts.models.SapTablePartitionSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'The number of rows to be retrieved. Type: integer(or Expression with
-
- resultType integer).'
- name: row_count
- types:
- - <xref:JSON>
-- description: 'The number of rows that will be skipped. Type: integer (or Expression
- with
-
- resultType integer).'
- name: row_skips
- types:
- - <xref:JSON>
-- description: 'The fields of the SAP table that will be retrieved. For example,
-
- column0, column1. Type: string (or Expression with resultType string).'
- name: rfc_table_fields
- types:
- - <xref:JSON>
-- description: 'The options for the filtering of the SAP Table. For example, COLUMN0
-
- EQ SOME VALUE. Type: string (or Expression with resultType string).'
- name: rfc_table_options
- types:
- - <xref:JSON>
-- description: 'Specifies the maximum number of rows that will be retrieved at a time
- when
-
- retrieving data from SAP Table. Type: integer (or Expression with resultType integer).'
- name: batch_size
- types:
- - <xref:JSON>
-- description: 'Specifies the custom RFC function module that will
-
- be used to read data from SAP Table. Type: string (or Expression with resultType
- string).'
- name: custom_rfc_read_table_function_module
- types:
- - <xref:JSON>
-- description: 'The single character that will be used as delimiter passed to
-
- SAP RFC as well as splitting the output data retrieved. Type: string (or Expression
- with
-
- resultType string).'
- name: sap_data_column_delimiter
- types:
- - <xref:JSON>
-- description: 'The partition mechanism that will be used for SAP table read in
-
- parallel. Known values are: "None", "PartitionOnInt", "PartitionOnCalendarYear",
-
- "PartitionOnCalendarMonth", "PartitionOnCalendarDate", and "PartitionOnTime".'
- name: partition_option
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SapTablePartitionOption>
-- description: 'The settings that will be leveraged for SAP table source
-
- partitioning.'
- name: partition_settings
- types:
- - <xref:azure.synapse.artifacts.models.SapTablePartitionSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScheduleTrigger.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScheduleTrigger.yml
deleted file mode 100644
index 47a613bee723..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScheduleTrigger.yml
+++ /dev/null
@@ -1,77 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ScheduleTrigger
-name: ScheduleTrigger
-fullName: azure.synapse.artifacts.models.ScheduleTrigger
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.MultiplePipelineTrigger
-summary: 'Trigger that creates pipeline runs periodically, on schedule.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ScheduleTrigger(*, recurrence: _models.ScheduleTriggerRecurrence, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None,
- annotations: List[MutableMapping[str, Any]] | None = None, pipelines: List[_models.TriggerPipelineReference]
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Trigger description.
- types:
- - <xref:str>
- - name: annotations
- description: List of tags that can be used for describing the trigger.
- types:
- - <xref:list>[<xref:JSON>]
- - name: pipelines
- description: Pipelines that need to be started.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.TriggerPipelineReference>]
- - name: recurrence
- description: Recurrence schedule configuration. Required.
- types:
- - <xref:azure.synapse.artifacts.models.ScheduleTriggerRecurrence>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Trigger type. Required.
- name: type
- types:
- - <xref:str>
-- description: Trigger description.
- name: description
- types:
- - <xref:str>
-- description: 'Indicates if trigger is running or not. Updated when Start/Stop APIs
- are
-
- called on the Trigger. Known values are: "Started", "Stopped", and "Disabled".'
- name: runtime_state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.TriggerRuntimeState>
-- description: List of tags that can be used for describing the trigger.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: Pipelines that need to be started.
- name: pipelines
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.TriggerPipelineReference>]
-- description: Recurrence schedule configuration. Required.
- name: recurrence
- types:
- - <xref:azure.synapse.artifacts.models.ScheduleTriggerRecurrence>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScheduleTriggerRecurrence.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScheduleTriggerRecurrence.yml
deleted file mode 100644
index 0ffddf12af3b..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScheduleTriggerRecurrence.yml
+++ /dev/null
@@ -1,84 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ScheduleTriggerRecurrence
-name: ScheduleTriggerRecurrence
-fullName: azure.synapse.artifacts.models.ScheduleTriggerRecurrence
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: The workflow trigger recurrence.
-constructor:
- syntax: 'ScheduleTriggerRecurrence(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, frequency: str | _models.RecurrenceFrequency | None = None,
- interval: int | None = None, start_time: datetime | None = None, end_time: datetime
- | None = None, time_zone: str | None = None, schedule: _models.RecurrenceSchedule
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: frequency
- description: 'The frequency. Known values are: "NotSpecified", "Minute", "Hour",
- "Day",
-
- "Week", "Month", and "Year".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.RecurrenceFrequency>
- - name: interval
- description: The interval.
- types:
- - <xref:int>
- - name: start_time
- description: The start time.
- types:
- - <xref:datetime.datetime>
- - name: end_time
- description: The end time.
- types:
- - <xref:datetime.datetime>
- - name: time_zone
- description: The time zone.
- types:
- - <xref:str>
- - name: schedule
- description: The recurrence schedule.
- types:
- - <xref:azure.synapse.artifacts.models.RecurrenceSchedule>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: 'The frequency. Known values are: "NotSpecified", "Minute", "Hour",
- "Day",
-
- "Week", "Month", and "Year".'
- name: frequency
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.RecurrenceFrequency>
-- description: The interval.
- name: interval
- types:
- - <xref:int>
-- description: The start time.
- name: start_time
- types:
- - <xref:datetime.datetime>
-- description: The end time.
- name: end_time
- types:
- - <xref:datetime.datetime>
-- description: The time zone.
- name: time_zone
- types:
- - <xref:str>
-- description: The recurrence schedule.
- name: schedule
- types:
- - <xref:azure.synapse.artifacts.models.RecurrenceSchedule>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SchedulerCurrentState.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SchedulerCurrentState.yml
index 61acadf9b3a5..6a1adf0a82e7 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SchedulerCurrentState.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SchedulerCurrentState.yml
@@ -2,7 +2,6 @@
uid: azure.synapse.artifacts.models.SchedulerCurrentState
name: SchedulerCurrentState
fullName: azure.synapse.artifacts.models.SchedulerCurrentState
-summary: SchedulerCurrentState.
module: azure.synapse.artifacts.models
constructor:
syntax: SchedulerCurrentState(value, names=None, *, module=None, qualname=None,
@@ -11,9 +10,9 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptAction.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptAction.yml
index 804c2611db5a..2a1c3ec27f69 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptAction.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptAction.yml
@@ -4,45 +4,36 @@ name: ScriptAction
fullName: azure.synapse.artifacts.models.ScriptAction
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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: MutableMapping[str, Any], parameters:
- str | None = None, **kwargs: Any)'
+ syntax: 'ScriptAction(*, name: str, uri: str, roles: str | HdiNodeTypes, parameters:
+ str | None = None, **kwargs)'
parameters:
- name: name
- description: The user provided name of the script action. Required.
+ description: Required. The user provided name of the script action.
+ isRequired: true
types:
- <xref:str>
- name: uri
- description: The URI for the script action. Required.
+ description: Required. The URI for the script action.
+ isRequired: true
types:
- <xref:str>
- name: roles
- description: The node types on which the script action should be executed. Required.
+ description: 'Required. The node types on which the script action should be executed.
+ Possible
+
+ values include: "Headnode", "Workernode", "Zookeeper".'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:str>
+ - <xref:azure.synapse.artifacts.models.HdiNodeTypes>
- name: parameters
description: The parameters for the script action.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: The user provided name of the script action. Required.
- name: name
- types:
- - <xref:str>
-- description: The URI for the script action. Required.
- name: uri
- types:
- - <xref:str>
-- description: The node types on which the script action should be executed. Required.
- name: roles
- types:
- - <xref:JSON>
-- description: The parameters for the script action.
- name: parameters
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptActivity.yml
deleted file mode 100644
index 6b5ba61c2e3e..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptActivity.yml
+++ /dev/null
@@ -1,138 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ScriptActivity
-name: ScriptActivity
-fullName: azure.synapse.artifacts.models.ScriptActivity
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.ExecutionActivity
-summary: 'Script activity type.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ScriptActivity(*, name: str, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, state: str | _models.ActivityState
- | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None
- = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, linked_service_name: _models.LinkedServiceReference
- | None = None, policy: _models.ActivityPolicy | None = None, scripts: List[_models.ScriptActivityScriptBlock]
- | None = None, log_settings: _models.ScriptActivityTypePropertiesLogSettings |
- None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: name
- description: Activity name. Required.
- types:
- - <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- - name: depends_on
- description: Activity depends on condition.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- - name: user_properties
- description: Activity user properties.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- - name: linked_service_name
- description: Linked service reference.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: policy
- description: Activity policy.
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
- - name: scripts
- description: 'Array of script blocks. Type: array.'
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ScriptActivityScriptBlock>]
- - name: log_settings
- description: Log settings of script activity.
- types:
- - <xref:azure.synapse.artifacts.models.ScriptActivityTypePropertiesLogSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: 'Array of script blocks. Type: array.'
- name: scripts
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ScriptActivityScriptBlock>]
-- description: Log settings of script activity.
- name: log_settings
- types:
- - <xref:azure.synapse.artifacts.models.ScriptActivityTypePropertiesLogSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptActivityLogDestination.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptActivityLogDestination.yml
deleted file mode 100644
index af0efefa7f67..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptActivityLogDestination.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.ScriptActivityLogDestination
-name: ScriptActivityLogDestination
-fullName: azure.synapse.artifacts.models.ScriptActivityLogDestination
-summary: 'The destination of logs. Type: string.'
-module: azure.synapse.artifacts.models
-constructor:
- syntax: ScriptActivityLogDestination(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: ACTIVITY_OUTPUT
- uid: azure.synapse.artifacts.models.ScriptActivityLogDestination.ACTIVITY_OUTPUT
-- name: EXTERNAL_STORE
- uid: azure.synapse.artifacts.models.ScriptActivityLogDestination.EXTERNAL_STORE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptActivityParameter.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptActivityParameter.yml
deleted file mode 100644
index ac516521d709..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptActivityParameter.yml
+++ /dev/null
@@ -1,77 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ScriptActivityParameter
-name: ScriptActivityParameter
-fullName: azure.synapse.artifacts.models.ScriptActivityParameter
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Parameters of a script block.
-constructor:
- syntax: 'ScriptActivityParameter(*, name: MutableMapping[str, Any] | None = None,
- type: str | _models.ScriptActivityParameterType | None = None, value: MutableMapping[str,
- Any] | None = None, direction: str | _models.ScriptActivityParameterDirection
- | None = None, size: int | None = None, **kwargs: Any)'
- parameters:
- - name: name
- description: 'The name of the parameter. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
- - name: type
- description: 'The type of the parameter. Known values are: "Boolean", "DateTime",
-
- "DateTimeOffset", "Decimal", "Double", "Guid", "Int16", "Int32", "Int64", "Single",
- "String",
-
- and "Timespan".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ScriptActivityParameterType>
- - name: value
- description: The value of the parameter.
- types:
- - <xref:JSON>
- - name: direction
- description: 'The direction of the parameter. Known values are: "Input", "Output",
- and
-
- "InputOutput".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ScriptActivityParameterDirection>
- - name: size
- description: The size of the output direction parameter.
- types:
- - <xref:int>
-variables:
-- description: 'The name of the parameter. Type: string (or Expression with resultType
- string).'
- name: name
- types:
- - <xref:JSON>
-- description: 'The type of the parameter. Known values are: "Boolean", "DateTime",
-
- "DateTimeOffset", "Decimal", "Double", "Guid", "Int16", "Int32", "Int64", "Single",
- "String",
-
- and "Timespan".'
- name: type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ScriptActivityParameterType>
-- description: The value of the parameter.
- name: value
- types:
- - <xref:JSON>
-- description: 'The direction of the parameter. Known values are: "Input", "Output",
- and
-
- "InputOutput".'
- name: direction
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ScriptActivityParameterDirection>
-- description: The size of the output direction parameter.
- name: size
- types:
- - <xref:int>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptActivityParameterDirection.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptActivityParameterDirection.yml
deleted file mode 100644
index da0bc091a2cf..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptActivityParameterDirection.yml
+++ /dev/null
@@ -1,19 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.ScriptActivityParameterDirection
-name: ScriptActivityParameterDirection
-fullName: azure.synapse.artifacts.models.ScriptActivityParameterDirection
-summary: The direction of the parameter.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: ScriptActivityParameterDirection(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: INPUT
- uid: azure.synapse.artifacts.models.ScriptActivityParameterDirection.INPUT
-- name: INPUT_OUTPUT
- uid: azure.synapse.artifacts.models.ScriptActivityParameterDirection.INPUT_OUTPUT
-- name: OUTPUT
- uid: azure.synapse.artifacts.models.ScriptActivityParameterDirection.OUTPUT
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptActivityParameterType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptActivityParameterType.yml
deleted file mode 100644
index d5b75d98e4f8..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptActivityParameterType.yml
+++ /dev/null
@@ -1,37 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.ScriptActivityParameterType
-name: ScriptActivityParameterType
-fullName: azure.synapse.artifacts.models.ScriptActivityParameterType
-summary: The type of the parameter.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: ScriptActivityParameterType(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: BOOLEAN
- uid: azure.synapse.artifacts.models.ScriptActivityParameterType.BOOLEAN
-- name: DATE_TIME
- uid: azure.synapse.artifacts.models.ScriptActivityParameterType.DATE_TIME
-- name: DATE_TIME_OFFSET
- uid: azure.synapse.artifacts.models.ScriptActivityParameterType.DATE_TIME_OFFSET
-- name: DECIMAL
- uid: azure.synapse.artifacts.models.ScriptActivityParameterType.DECIMAL
-- name: DOUBLE
- uid: azure.synapse.artifacts.models.ScriptActivityParameterType.DOUBLE
-- name: GUID
- uid: azure.synapse.artifacts.models.ScriptActivityParameterType.GUID
-- name: INT16
- uid: azure.synapse.artifacts.models.ScriptActivityParameterType.INT16
-- name: INT32
- uid: azure.synapse.artifacts.models.ScriptActivityParameterType.INT32
-- name: INT64
- uid: azure.synapse.artifacts.models.ScriptActivityParameterType.INT64
-- name: SINGLE
- uid: azure.synapse.artifacts.models.ScriptActivityParameterType.SINGLE
-- name: STRING
- uid: azure.synapse.artifacts.models.ScriptActivityParameterType.STRING
-- name: TIMESPAN
- uid: azure.synapse.artifacts.models.ScriptActivityParameterType.TIMESPAN
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptActivityScriptBlock.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptActivityScriptBlock.yml
deleted file mode 100644
index 72d9e107be77..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptActivityScriptBlock.yml
+++ /dev/null
@@ -1,51 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ScriptActivityScriptBlock
-name: ScriptActivityScriptBlock
-fullName: azure.synapse.artifacts.models.ScriptActivityScriptBlock
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Script block of scripts.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ScriptActivityScriptBlock(*, text: MutableMapping[str, Any], type: str
- | _models.ScriptType, parameters: List[_models.ScriptActivityParameter] | None
- = None, **kwargs: Any)'
- parameters:
- - name: text
- description: 'The query text. Type: string (or Expression with resultType string).
- Required.'
- types:
- - <xref:JSON>
- - name: type
- description: 'The type of the query. Type: string. Required. Known values are:
- "Query" and
-
- "NonQuery".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ScriptType>
- - name: parameters
- description: 'Array of script parameters. Type: array.'
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ScriptActivityParameter>]
-variables:
-- description: 'The query text. Type: string (or Expression with resultType string).
- Required.'
- name: text
- types:
- - <xref:JSON>
-- description: 'The type of the query. Type: string. Required. Known values are: "Query"
- and
-
- "NonQuery".'
- name: type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ScriptType>
-- description: 'Array of script parameters. Type: array.'
- name: parameters
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ScriptActivityParameter>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptActivityTypePropertiesLogSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptActivityTypePropertiesLogSettings.yml
deleted file mode 100644
index 3c8eac35d4f9..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptActivityTypePropertiesLogSettings.yml
+++ /dev/null
@@ -1,40 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ScriptActivityTypePropertiesLogSettings
-name: ScriptActivityTypePropertiesLogSettings
-fullName: azure.synapse.artifacts.models.ScriptActivityTypePropertiesLogSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Log settings of script activity.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ScriptActivityTypePropertiesLogSettings(*, log_destination: str | _models.ScriptActivityLogDestination,
- log_location_settings: _models.LogLocationSettings | None = None, **kwargs: Any)'
- parameters:
- - name: log_destination
- description: 'The destination of logs. Type: string. Required. Known values are:
-
- "ActivityOutput" and "ExternalStore".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ScriptActivityLogDestination>
- - name: log_location_settings
- description: 'Log location settings customer needs to provide when enabling
-
- log.'
- types:
- - <xref:azure.synapse.artifacts.models.LogLocationSettings>
-variables:
-- description: 'The destination of logs. Type: string. Required. Known values are:
-
- "ActivityOutput" and "ExternalStore".'
- name: log_destination
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ScriptActivityLogDestination>
-- description: Log location settings customer needs to provide when enabling log.
- name: log_location_settings
- types:
- - <xref:azure.synapse.artifacts.models.LogLocationSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptType.yml
deleted file mode 100644
index 4996488e0ad6..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptType.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.ScriptType
-name: ScriptType
-fullName: azure.synapse.artifacts.models.ScriptType
-summary: 'The type of the query. Type: string.'
-module: azure.synapse.artifacts.models
-constructor:
- syntax: ScriptType(value, names=None, *, module=None, qualname=None, type=None,
- start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: NON_QUERY
- uid: azure.synapse.artifacts.models.ScriptType.NON_QUERY
-- name: QUERY
- uid: azure.synapse.artifacts.models.ScriptType.QUERY
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SecretBase.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SecretBase.yml
index 959fb05417c8..ab098b521627 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SecretBase.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SecretBase.yml
@@ -4,21 +4,21 @@ name: SecretBase
fullName: azure.synapse.artifacts.models.SecretBase
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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:
+ You probably want to use the sub-classes and not this class directly. Known
- AzureKeyVaultSecretReference, SecureString
+ sub-classes are: AzureKeyVaultSecretReference, SecureString.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SecretBase(**kwargs: Any)'
-variables:
-- description: Type of the secret. Required.
- name: type
- types:
- - <xref:str>
+ syntax: SecretBase(**kwargs)
+ parameters:
+ - name: type
+ description: Required. Type of the secret.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SecureInputOutputPolicy.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SecureInputOutputPolicy.yml
deleted file mode 100644
index 8c1a68c39d4f..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SecureInputOutputPolicy.yml
+++ /dev/null
@@ -1,41 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SecureInputOutputPolicy
-name: SecureInputOutputPolicy
-fullName: azure.synapse.artifacts.models.SecureInputOutputPolicy
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Execution policy for an activity that supports secure input and output.
-constructor:
- syntax: 'SecureInputOutputPolicy(*, secure_input: bool | None = None, secure_output:
- bool | None = None, **kwargs: Any)'
- parameters:
- - name: secure_input
- description: 'When set to true, Input from activity is considered as secure and
- will
-
- not be logged to monitoring.'
- types:
- - <xref:bool>
- - name: secure_output
- description: 'When set to true, Output from activity is considered as secure and
- will
-
- not be logged to monitoring.'
- types:
- - <xref:bool>
-variables:
-- description: 'When set to true, Input from activity is considered as secure and
- will not
-
- be logged to monitoring.'
- name: secure_input
- types:
- - <xref:bool>
-- description: 'When set to true, Output from activity is considered as secure and
- will
-
- not be logged to monitoring.'
- name: secure_output
- types:
- - <xref:bool>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SecureString.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SecureString.yml
index c5ea21281868..94ba16c1fc0a 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SecureString.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SecureString.yml
@@ -6,25 +6,20 @@ module: azure.synapse.artifacts.models
inheritances:
- azure.synapse.artifacts.models._models_py3.SecretBase
summary: 'Azure Synapse secure string definition. The string value will be masked
- with asterisks ''*''
-
- during Get or List API calls.
+ 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: Any)'
+ syntax: 'SecureString(*, value: str, **kwargs)'
parameters:
+ - name: type
+ description: Required. Type of the secret.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: value
- description: Value of secure string. Required.
+ description: Required. Value of secure string.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: Type of the secret. Required.
- name: type
- types:
- - <xref:str>
-- description: Value of secure string. Required.
- name: value
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SelfDependencyTumblingWindowTriggerReference.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SelfDependencyTumblingWindowTriggerReference.yml
deleted file mode 100644
index 79f6de1f31b1..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SelfDependencyTumblingWindowTriggerReference.yml
+++ /dev/null
@@ -1,46 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SelfDependencyTumblingWindowTriggerReference
-name: SelfDependencyTumblingWindowTriggerReference
-fullName: azure.synapse.artifacts.models.SelfDependencyTumblingWindowTriggerReference
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.DependencyReference
-summary: 'Self referenced tumbling window trigger dependency.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SelfDependencyTumblingWindowTriggerReference(*, offset: str, size: str
- | None = None, **kwargs: Any)'
- parameters:
- - name: offset
- description: 'Timespan applied to the start time of a tumbling window when evaluating
-
- dependency. Required.'
- types:
- - <xref:str>
- - name: size
- description: 'The size of the window when evaluating the dependency. If undefined
- the
-
- frequency of the tumbling window will be used.'
- types:
- - <xref:str>
-variables:
-- description: The type of dependency reference. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Timespan applied to the start time of a tumbling window when evaluating
-
- dependency. Required.'
- name: offset
- types:
- - <xref:str>
-- description: 'The size of the window when evaluating the dependency. If undefined
- the frequency
-
- of the tumbling window will be used.'
- name: size
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SelfHostedIntegrationRuntime.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SelfHostedIntegrationRuntime.yml
deleted file mode 100644
index ab00cd058b4f..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SelfHostedIntegrationRuntime.yml
+++ /dev/null
@@ -1,53 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SelfHostedIntegrationRuntime
-name: SelfHostedIntegrationRuntime
-fullName: azure.synapse.artifacts.models.SelfHostedIntegrationRuntime
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.IntegrationRuntime
-summary: 'Self-hosted integration runtime.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SelfHostedIntegrationRuntime(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, linked_info: _models.LinkedIntegrationRuntimeType
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Integration runtime description.
- types:
- - <xref:str>
- - name: linked_info
- description: Linked integration runtime type from data factory.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedIntegrationRuntimeType>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: 'Type of integration runtime. Required. Known values are: "Managed"
- and
-
- "SelfHosted".'
- name: type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeType>
-- description: Integration runtime description.
- name: description
- types:
- - <xref:str>
-- description: Linked integration runtime type from data factory.
- name: linked_info
- types:
- - <xref:azure.synapse.artifacts.models.LinkedIntegrationRuntimeType>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowAuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowAuthenticationType.yml
index 3fca7d8e1aee..16a6e6a3936a 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowAuthenticationType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowAuthenticationType.yml
@@ -11,7 +11,7 @@ inheritances:
- builtins.str
- enum.Enum
fields:
-- name: BASIC
- uid: azure.synapse.artifacts.models.ServiceNowAuthenticationType.BASIC
-- name: O_AUTH2
- uid: azure.synapse.artifacts.models.ServiceNowAuthenticationType.O_AUTH2
+- name: basic
+ uid: azure.synapse.artifacts.models.ServiceNowAuthenticationType.basic
+- name: o_auth2
+ uid: azure.synapse.artifacts.models.ServiceNowAuthenticationType.o_auth2
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowLinkedService.yml
index 31e4bc9b56af..b708f1a6e9f5 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowLinkedService.yml
@@ -10,50 +10,60 @@ summary: 'ServiceNow server linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'ServiceNowLinkedService(*, endpoint: MutableMapping[str, Any], authentication_type:
- str | _models.ServiceNowAuthenticationType, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, username:
- MutableMapping[str, Any] | None = None, password: _models.SecretBase | None =
- None, client_id: MutableMapping[str, Any] | None = None, client_secret: _models.SecretBase
- | None = None, use_encrypted_endpoints: MutableMapping[str, Any] | None = None,
- use_host_verification: MutableMapping[str, Any] | None = None, use_peer_verification:
- MutableMapping[str, Any] | None = None, encrypted_credential: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: endpoint
- description: 'The endpoint of the ServiceNow server. (i.e.
+ description: 'Required. The endpoint of the ServiceNow server. (i.e.
- `<instance>`.service-now.com). Required.'
+ `<instance>`.service-now.com).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: authentication_type
- description: 'The authentication type to use. Required. Known values are:
+ description: 'Required. The authentication type to use. Possible values include:
- "Basic" and "OAuth2".'
+ "Basic", "OAuth2".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.ServiceNowAuthenticationType>
@@ -62,28 +72,33 @@ constructor:
and OAuth2
authentication.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: 'The password corresponding to the user name for Basic and OAuth2
authentication.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: client_id
description: The client id for OAuth2 authentication.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: client_secret
description: The client secret for OAuth2 authentication.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: use_encrypted_endpoints
- description: 'Specifies whether the data source endpoints are encrypted
+ description: 'Specifies whether the data source endpoints are encrypted using
- using HTTPS. The default value is true.'
+ HTTPS. The default value is true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_host_verification
description: 'Specifies whether to require the host name in the server''s
@@ -91,111 +106,23 @@ constructor:
default value is
true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The endpoint of the ServiceNow server. (i.e.
-
- `<instance>`.service-now.com). Required.'
- name: endpoint
- types:
- - <xref:JSON>
-- description: 'The authentication type to use. Required. Known values are: "Basic"
-
- and "OAuth2".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ServiceNowAuthenticationType>
-- description: 'The user name used to connect to the ServiceNow server for Basic and
- OAuth2
-
- authentication.'
- name: username
- types:
- - <xref:JSON>
-- description: 'The password corresponding to the user name for Basic and OAuth2
-
- authentication.'
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: The client id for OAuth2 authentication.
- name: client_id
- types:
- - <xref:JSON>
-- description: The client secret for OAuth2 authentication.
- name: client_secret
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Specifies whether the data source endpoints are encrypted using
-
- HTTPS. The default value is true.'
- name: use_encrypted_endpoints
- types:
- - <xref:JSON>
-- 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.'
- name: use_host_verification
- types:
- - <xref:JSON>
-- description: 'Specifies whether to verify the identity of the server when
-
- connecting over SSL. The default value is true.'
- name: use_peer_verification
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowObjectDataset.yml
index 3e999b24e4c8..13decc49591b 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowObjectDataset.yml
@@ -10,109 +10,71 @@ summary: 'ServiceNow server dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'ServiceNowObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The table name. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowSource.yml
deleted file mode 100644
index 5ee030d045b9..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ServiceNowSource
-name: ServiceNowSource
-fullName: azure.synapse.artifacts.models.ServiceNowSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity ServiceNow server source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ServiceNowSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, query:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SetVariableActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SetVariableActivity.yml
index a5d08c9b9fb8..f75be4f7096f 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SetVariableActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SetVariableActivity.yml
@@ -4,134 +4,56 @@ name: SetVariableActivity
fullName: azure.synapse.artifacts.models.SetVariableActivity
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts.models._models_py3.ControlActivity
+- azure.synapse.artifacts.models._models_py3.Activity
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, MutableMapping[str,
- Any]] | None = None, description: str | None = None, state: str | _models.ActivityState
- | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None
- = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, policy: _models.SecureInputOutputPolicy
- | None = None, variable_name: str | None = None, value: MutableMapping[str, Any]
- | None = None, set_system_variable: bool | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- - name: policy
- description: Activity policy.
- types:
- - <xref:azure.synapse.artifacts.models.SecureInputOutputPolicy>
- name: variable_name
description: Name of the variable whose value needs to be set.
+ isRequired: true
types:
- <xref:str>
- name: value
description: Value to be set. Could be a static value or Expression.
+ isRequired: true
types:
- - <xref:JSON>
- - name: set_system_variable
- description: If set to true, it sets the pipeline run return value.
- types:
- - <xref:bool>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.SecureInputOutputPolicy>
-- description: Name of the variable whose value needs to be set.
- name: variable_name
- types:
- - <xref:str>
-- description: Value to be set. Could be a static value or Expression.
- name: value
- types:
- - <xref:JSON>
-- description: If set to true, it sets the pipeline run return value.
- name: set_system_variable
- types:
- - <xref:bool>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpAuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpAuthenticationType.yml
index 3006a3386e32..cdb677fb780b 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpAuthenticationType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpAuthenticationType.yml
@@ -11,7 +11,7 @@ inheritances:
- builtins.str
- enum.Enum
fields:
-- name: BASIC
- uid: azure.synapse.artifacts.models.SftpAuthenticationType.BASIC
-- name: SSH_PUBLIC_KEY
- uid: azure.synapse.artifacts.models.SftpAuthenticationType.SSH_PUBLIC_KEY
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpLocation.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpLocation.yml
deleted file mode 100644
index 95b851740ae3..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpLocation.yml
+++ /dev/null
@@ -1,59 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SftpLocation
-name: SftpLocation
-fullName: azure.synapse.artifacts.models.SftpLocation
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.DatasetLocation
-summary: 'The location of SFTP dataset.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SftpLocation(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, folder_path: MutableMapping[str, Any] | None = None, file_name:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: folder_path
- description: 'Specify the folder path of dataset. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: file_name
- description: 'Specify the file name of dataset. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset storage location. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Specify the folder path of dataset. Type: string (or Expression with
-
- resultType string).'
- name: folder_path
- types:
- - <xref:JSON>
-- description: 'Specify the file name of dataset. Type: string (or Expression with
- resultType
-
- string).'
- name: file_name
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpReadSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpReadSettings.yml
deleted file mode 100644
index 151872040a57..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpReadSettings.yml
+++ /dev/null
@@ -1,179 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SftpReadSettings
-name: SftpReadSettings
-fullName: azure.synapse.artifacts.models.SftpReadSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.StoreReadSettings
-summary: 'Sftp read settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SftpReadSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None
- = None, recursive: MutableMapping[str, Any] | None = None, wildcard_folder_path:
- MutableMapping[str, Any] | None = None, wildcard_file_name: MutableMapping[str,
- Any] | None = None, enable_partition_discovery: bool | None = None, partition_root_path:
- MutableMapping[str, Any] | None = None, file_list_path: MutableMapping[str, Any]
- | None = None, delete_files_after_completion: MutableMapping[str, Any] | None
- = None, modified_datetime_start: MutableMapping[str, Any] | None = None, modified_datetime_end:
- MutableMapping[str, Any] | None = None, disable_chunking: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: recursive
- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: wildcard_folder_path
- description: 'Sftp wildcardFolderPath. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: wildcard_file_name
- description: 'Sftp wildcardFileName. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: enable_partition_discovery
- description: Indicates whether to enable partition discovery.
- types:
- - <xref:bool>
- - name: partition_root_path
- description: 'Specify the root path where partition discovery starts from.
-
- Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: file_list_path
- description: 'Point to a text file that lists each file (relative path to the
- path
-
- configured in the dataset) that you want to copy. Type: string (or Expression
- with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: delete_files_after_completion
- description: 'Indicates whether the source files need to be deleted
-
- after copy completion. Default is false. Type: boolean (or Expression with resultType
- boolean).'
- types:
- - <xref:JSON>
- - name: modified_datetime_start
- description: 'The start of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: modified_datetime_end
- description: 'The end of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: disable_chunking
- description: 'If true, disable parallel reading within each file. Default is
-
- false. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The read setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'If true, files under the folder path will be read recursively. Default
- is
-
- true. Type: boolean (or Expression with resultType boolean).'
- name: recursive
- types:
- - <xref:JSON>
-- description: 'Sftp wildcardFolderPath. Type: string (or Expression with
-
- resultType string).'
- name: wildcard_folder_path
- types:
- - <xref:JSON>
-- description: 'Sftp wildcardFileName. Type: string (or Expression with resultType
-
- string).'
- name: wildcard_file_name
- types:
- - <xref:JSON>
-- description: Indicates whether to enable partition discovery.
- name: enable_partition_discovery
- types:
- - <xref:bool>
-- description: 'Specify the root path where partition discovery starts from. Type:
-
- string (or Expression with resultType string).'
- name: partition_root_path
- types:
- - <xref:JSON>
-- description: 'Point to a text file that lists each file (relative path to the path
-
- configured in the dataset) that you want to copy. Type: string (or Expression
- with resultType
-
- string).'
- name: file_list_path
- types:
- - <xref:JSON>
-- description: 'Indicates whether the source files need to be deleted
-
- after copy completion. Default is false. Type: boolean (or Expression with resultType
- boolean).'
- name: delete_files_after_completion
- types:
- - <xref:JSON>
-- description: 'The start of file''s modified datetime. Type: string (or
-
- Expression with resultType string).'
- name: modified_datetime_start
- types:
- - <xref:JSON>
-- description: 'The end of file''s modified datetime. Type: string (or Expression
-
- with resultType string).'
- name: modified_datetime_end
- types:
- - <xref:JSON>
-- description: 'If true, disable parallel reading within each file. Default is false.
-
- Type: boolean (or Expression with resultType boolean).'
- name: disable_chunking
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpServerLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpServerLinkedService.yml
index 2feb24e3eb7e..d2053eba2ace 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpServerLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpServerLinkedService.yml
@@ -10,59 +10,70 @@ 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: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, port:
- MutableMapping[str, Any] | None = None, authentication_type: str | _models.SftpAuthenticationType
- | None = None, user_name: MutableMapping[str, Any] | None = None, password: _models.SecretBase
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, private_key_path:
- MutableMapping[str, Any] | None = None, private_key_content: _models.SecretBase
- | None = None, pass_phrase: _models.SecretBase | None = None, skip_host_key_validation:
- MutableMapping[str, Any] | None = None, host_key_fingerprint: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: host
- description: 'The SFTP server host name. Type: string (or Expression with resultType
- string).
+ description: 'Required. The SFTP server host name. Type: string (or Expression
+ with resultType
- Required.'
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: authentication_type
description: 'The authentication type to be used to connect to the FTP server.
- Known values are: "Basic" and "SshPublicKey".'
+ Possible values include: "Basic", "SshPublicKey".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.SftpAuthenticationType>
@@ -71,21 +82,24 @@ constructor:
Expression
with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: Password to logon the SFTP server for Basic authentication.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: private_key_path
description: 'The SSH private key file path for SshPublicKey authentication. Only
@@ -96,8 +110,9 @@ constructor:
be OpenSSH
format. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: private_key_content
description: 'Base64 encoded SSH private key content for SshPublicKey
@@ -105,6 +120,7 @@ constructor:
PrivateKeyPath or
PrivateKeyContent should be specified. SSH private key should be OpenSSH format.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: pass_phrase
@@ -112,14 +128,16 @@ constructor:
is
encrypted.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: host_key_fingerprint
description: 'The host key finger-print of the SFTP server. When
@@ -127,116 +145,6 @@ constructor:
string (or
Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The SFTP server host name. Type: string (or Expression with resultType
- string).
-
- Required.'
- name: host
- types:
- - <xref:JSON>
-- 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.'
- name: port
- types:
- - <xref:JSON>
-- description: 'The authentication type to be used to connect to the FTP server.
-
- Known values are: "Basic" and "SshPublicKey".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SftpAuthenticationType>
-- description: 'The username used to log on to the SFTP server. Type: string (or Expression
-
- with resultType string).'
- name: user_name
- types:
- - <xref:JSON>
-- description: Password to logon the SFTP server for Basic authentication.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
-- 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).'
- name: private_key_path
- types:
- - <xref:JSON>
-- 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.'
- name: private_key_content
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The password to decrypt the SSH private key if the SSH private key
- is
-
- encrypted.'
- name: pass_phrase
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'If true, skip the SSH host key validation. Default value is
-
- false. Type: boolean (or Expression with resultType boolean).'
- name: skip_host_key_validation
- types:
- - <xref:JSON>
-- 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).'
- name: host_key_fingerprint
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpWriteSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpWriteSettings.yml
deleted file mode 100644
index abc68827a837..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpWriteSettings.yml
+++ /dev/null
@@ -1,86 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SftpWriteSettings
-name: SftpWriteSettings
-fullName: azure.synapse.artifacts.models.SftpWriteSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.StoreWriteSettings
-summary: 'Sftp write settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SftpWriteSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None
- = None, copy_behavior: MutableMapping[str, Any] | None = None, operation_timeout:
- MutableMapping[str, Any] | None = None, use_temp_file_rename: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: copy_behavior
- description: The type of copy behavior for copy sink.
- types:
- - <xref:JSON>
- - name: operation_timeout
- description: 'Specifies the timeout for writing each chunk to SFTP server.
-
- Default value: 01:00:00 (one hour). Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
- - name: use_temp_file_rename
- description: 'Upload to temporary file(s) and rename. Disable this option if
-
- your SFTP server doesn''t support rename operation. Type: boolean (or Expression
- with resultType
-
- boolean).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The write setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: The type of copy behavior for copy sink.
- name: copy_behavior
- types:
- - <xref:JSON>
-- description: 'Specifies the timeout for writing each chunk to SFTP server. Default
-
- value: 01:00:00 (one hour). Type: string (or Expression with resultType string).'
- name: operation_timeout
- types:
- - <xref:JSON>
-- description: 'Upload to temporary file(s) and rename. Disable this option if your
-
- SFTP server doesn''t support rename operation. Type: boolean (or Expression with
- resultType
-
- boolean).'
- name: use_temp_file_rename
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SharePointOnlineListLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SharePointOnlineListLinkedService.yml
deleted file mode 100644
index a46abed39cf4..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SharePointOnlineListLinkedService.yml
+++ /dev/null
@@ -1,155 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SharePointOnlineListLinkedService
-name: SharePointOnlineListLinkedService
-fullName: azure.synapse.artifacts.models.SharePointOnlineListLinkedService
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.LinkedService
-summary: 'SharePoint Online List linked service.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SharePointOnlineListLinkedService(*, site_url: MutableMapping[str, Any],
- tenant_id: MutableMapping[str, Any], service_principal_id: MutableMapping[str,
- Any], service_principal_key: _models.SecretBase, additional_properties: Dict[str,
- MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, encrypted_credential:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: connect_via
- description: The integration runtime reference.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- - name: description
- description: Linked service description.
- types:
- - <xref:str>
- - name: parameters
- description: Parameters for linked service.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the linked service.
- types:
- - <xref:list>[<xref:JSON>]
- - name: site_url
- description: 'The URL of the SharePoint Online site. For example,
-
- [https://contoso.sharepoint.com/sites/siteName](https://contoso.sharepoint.com/sites/siteName).
- Type: string (or Expression with resultType
-
- string). Required.'
- types:
- - <xref:JSON>
- - name: tenant_id
- description: 'The tenant ID under which your application resides. You can find
- it from
-
- Azure portal Active Directory overview page. Type: string (or Expression with
- resultType
-
- string). Required.'
- types:
- - <xref:JSON>
- - name: service_principal_id
- description: 'The application (client) ID of your application registered in
-
- Azure Active Directory. Make sure to grant SharePoint site permission to this
- application.
-
- Type: string (or Expression with resultType string). Required.'
- types:
- - <xref:JSON>
- - name: service_principal_key
- description: 'The client secret of your application registered in Azure
-
- Active Directory. Type: string (or Expression with resultType string). Required.'
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
- - 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).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The URL of the SharePoint Online site. For example,
-
- [https://contoso.sharepoint.com/sites/siteName](https://contoso.sharepoint.com/sites/siteName).
- Type: string (or Expression with resultType
-
- string). Required.'
- name: site_url
- types:
- - <xref:JSON>
-- description: 'The tenant ID under which your application resides. You can find it
- from Azure
-
- portal Active Directory overview page. Type: string (or Expression with resultType
- string).
-
- Required.'
- name: tenant_id
- types:
- - <xref:JSON>
-- description: 'The application (client) ID of your application registered in Azure
-
- Active Directory. Make sure to grant SharePoint site permission to this application.
- Type:
-
- string (or Expression with resultType string). Required.'
- name: service_principal_id
- types:
- - <xref:JSON>
-- description: 'The client secret of your application registered in Azure Active
-
- Directory. Type: string (or Expression with resultType string). Required.'
- name: service_principal_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SharePointOnlineListResourceDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SharePointOnlineListResourceDataset.yml
deleted file mode 100644
index 28ca91ae4c92..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SharePointOnlineListResourceDataset.yml
+++ /dev/null
@@ -1,124 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SharePointOnlineListResourceDataset
-name: SharePointOnlineListResourceDataset
-fullName: azure.synapse.artifacts.models.SharePointOnlineListResourceDataset
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.Dataset
-summary: 'The sharepoint online list resource dataset.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SharePointOnlineListResourceDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, list_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Dataset description.
- types:
- - <xref:str>
- - name: structure
- description: 'Columns that define the structure of the dataset. Type: array (or
-
- Expression with resultType array), itemType: DatasetDataElement.'
- types:
- - <xref:JSON>
- - name: schema
- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- types:
- - <xref:JSON>
- - name: linked_service_name
- description: Linked service reference. Required.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: parameters
- description: Parameters for dataset.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the Dataset.
- types:
- - <xref:list>[<xref:JSON>]
- - name: folder
- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
-
- the root level.'
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
- - name: list_name
- description: 'The name of the SharePoint Online list. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The name of the SharePoint Online list. Type: string (or Expression
- with
-
- resultType string).'
- name: list_name
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SharePointOnlineListSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SharePointOnlineListSource.yml
deleted file mode 100644
index d8797a29b434..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SharePointOnlineListSource.yml
+++ /dev/null
@@ -1,104 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SharePointOnlineListSource
-name: SharePointOnlineListSource
-fullName: azure.synapse.artifacts.models.SharePointOnlineListSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity source for sharePoint online list source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SharePointOnlineListSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, http_request_timeout: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query
- description: 'The OData query to filter the data in SharePoint Online list. For
- example,
-
- "$top=1". Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: http_request_timeout
- description: 'The wait time to get a response from SharePoint Online. Default
-
- value is 5 minutes (00:05:00). Type: string (or Expression with resultType string),
- pattern:
-
- ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'The OData query to filter the data in SharePoint Online list. For
- example,
-
- "$top=1". Type: string (or Expression with resultType string).'
- name: query
- types:
- - <xref:JSON>
-- description: 'The wait time to get a response from SharePoint Online. Default
-
- value is 5 minutes (00:05:00). Type: string (or Expression with resultType string),
- pattern:
-
- ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: http_request_timeout
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyLinkedService.yml
index 04f1c3712857..c3878a6c3eb7 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyLinkedService.yml
@@ -10,55 +10,66 @@ summary: 'Shopify Service linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'ShopifyLinkedService(*, host: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, access_token:
- _models.SecretBase | None = None, use_encrypted_endpoints: MutableMapping[str,
- Any] | None = None, use_host_verification: MutableMapping[str, Any] | None = None,
- use_peer_verification: MutableMapping[str, Any] | None = None, encrypted_credential:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: host
- description: The endpoint of the Shopify server. (i.e. mystore.myshopify.com).
- Required.
+ description: Required. The endpoint of the Shopify server. (i.e. mystore.myshopify.com).
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: access_token
description: 'The API access token that can be used to access Shopify''s data.
- The
+ The token
- token won''t expire if it is offline mode.'
+ won''t expire if it is offline mode.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: use_encrypted_endpoints
- description: 'Specifies whether the data source endpoints are encrypted
+ description: 'Specifies whether the data source endpoints are encrypted using
- using HTTPS. The default value is true.'
+ HTTPS. The default value is true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_host_verification
description: 'Specifies whether to require the host name in the server''s
@@ -66,88 +77,23 @@ constructor:
default value is
true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The endpoint of the Shopify server. (i.e. mystore.myshopify.com). Required.
- name: host
- types:
- - <xref:JSON>
-- description: 'The API access token that can be used to access Shopify''s data. The
- token
-
- won''t expire if it is offline mode.'
- name: access_token
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Specifies whether the data source endpoints are encrypted using
-
- HTTPS. The default value is true.'
- name: use_encrypted_endpoints
- types:
- - <xref:JSON>
-- 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.'
- name: use_host_verification
- types:
- - <xref:JSON>
-- description: 'Specifies whether to verify the identity of the server when
-
- connecting over SSL. The default value is true.'
- name: use_peer_verification
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyObjectDataset.yml
index 275287d1a9f6..45f17b88999c 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyObjectDataset.yml
@@ -10,109 +10,70 @@ summary: 'Shopify Service dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'ShopifyObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The table name. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifySource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifySource.yml
deleted file mode 100644
index 3c2c1bc9b889..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifySource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ShopifySource
-name: ShopifySource
-fullName: azure.synapse.artifacts.models.ShopifySource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Shopify Service source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ShopifySource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SkipErrorFile.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SkipErrorFile.yml
deleted file mode 100644
index cc5ca6849c76..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SkipErrorFile.yml
+++ /dev/null
@@ -1,39 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SkipErrorFile
-name: SkipErrorFile
-fullName: azure.synapse.artifacts.models.SkipErrorFile
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Skip error file.
-constructor:
- syntax: 'SkipErrorFile(*, file_missing: MutableMapping[str, Any] | None = None,
- data_inconsistency: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: file_missing
- description: 'Skip if file is deleted by other client during copy. Default is
- true.
-
- Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: data_inconsistency
- description: 'Skip if source/sink file changed by other concurrent write.
-
- Default is false. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Skip if file is deleted by other client during copy. Default is true.
- Type:
-
- boolean (or Expression with resultType boolean).'
- name: file_missing
- types:
- - <xref:JSON>
-- description: 'Skip if source/sink file changed by other concurrent write. Default
-
- is false. Type: boolean (or Expression with resultType boolean).'
- name: data_inconsistency
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Sku.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Sku.yml
deleted file mode 100644
index 74737b2c1ed2..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Sku.yml
+++ /dev/null
@@ -1,43 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.Sku
-name: Sku
-fullName: azure.synapse.artifacts.models.Sku
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: SQL pool SKU.
-constructor:
- syntax: 'Sku(*, tier: str | None = None, name: str | None = None, capacity: int
- | None = None, **kwargs: Any)'
- parameters:
- - name: tier
- description: The service tier.
- types:
- - <xref:str>
- - name: name
- description: The SKU name.
- types:
- - <xref:str>
- - name: capacity
- description: 'If the SKU supports scale out/in then the capacity integer should
- be
-
- included. If scale out/in is not possible for the resource this may be omitted.'
- types:
- - <xref:int>
-variables:
-- description: The service tier.
- name: tier
- types:
- - <xref:str>
-- description: The SKU name.
- name: name
- types:
- - <xref:str>
-- description: 'If the SKU supports scale out/in then the capacity integer should
- be included.
-
- If scale out/in is not possible for the resource this may be omitted.'
- name: capacity
- types:
- - <xref:int>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SmartsheetLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SmartsheetLinkedService.yml
deleted file mode 100644
index f4b451f29bb9..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SmartsheetLinkedService.yml
+++ /dev/null
@@ -1,93 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SmartsheetLinkedService
-name: SmartsheetLinkedService
-fullName: azure.synapse.artifacts.models.SmartsheetLinkedService
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.LinkedService
-summary: 'Linked service for Smartsheet.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SmartsheetLinkedService(*, api_token: _models.SecretBase, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, encrypted_credential:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: connect_via
- description: The integration runtime reference.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- - name: description
- description: Linked service description.
- types:
- - <xref:str>
- - name: parameters
- description: Parameters for linked service.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the linked service.
- types:
- - <xref:list>[<xref:JSON>]
- - name: api_token
- description: The api token for the Smartsheet source. Required.
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
- - 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).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The api token for the Smartsheet source. Required.
- name: api_token
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SnowflakeDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SnowflakeDataset.yml
deleted file mode 100644
index 7c28a5dbec9d..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SnowflakeDataset.yml
+++ /dev/null
@@ -1,136 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SnowflakeDataset
-name: SnowflakeDataset
-fullName: azure.synapse.artifacts.models.SnowflakeDataset
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.Dataset
-summary: 'The snowflake dataset.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SnowflakeDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, schema_type_properties_schema: MutableMapping[str,
- Any] | None = None, table: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Dataset description.
- types:
- - <xref:str>
- - name: structure
- description: 'Columns that define the structure of the dataset. Type: array (or
-
- Expression with resultType array), itemType: DatasetDataElement.'
- types:
- - <xref:JSON>
- - name: schema
- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- types:
- - <xref:JSON>
- - name: linked_service_name
- description: Linked service reference. Required.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: parameters
- description: Parameters for dataset.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the Dataset.
- types:
- - <xref:list>[<xref:JSON>]
- - name: folder
- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
-
- the root level.'
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
- - name: schema_type_properties_schema
- description: 'The schema name of the Snowflake database. Type: string
-
- (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: table
- description: 'The table name of the Snowflake database. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The schema name of the Snowflake database. Type: string
-
- (or Expression with resultType string).'
- name: schema_type_properties_schema
- types:
- - <xref:JSON>
-- description: 'The table name of the Snowflake database. Type: string (or Expression
- with
-
- resultType string).'
- name: table
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SnowflakeExportCopyCommand.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SnowflakeExportCopyCommand.yml
deleted file mode 100644
index 446882d3992e..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SnowflakeExportCopyCommand.yml
+++ /dev/null
@@ -1,80 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SnowflakeExportCopyCommand
-name: SnowflakeExportCopyCommand
-fullName: azure.synapse.artifacts.models.SnowflakeExportCopyCommand
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.ExportSettings
-summary: 'Snowflake export command settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SnowflakeExportCopyCommand(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, additional_copy_options: Dict[str, MutableMapping[str, Any]]
- | None = None, additional_format_options: Dict[str, MutableMapping[str, Any]]
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: additional_copy_options
- description: 'Additional copy options directly passed to snowflake Copy
-
- Command. Type: key value pairs (value should be string type) (or Expression
- with resultType
-
- object). Example: "additionalCopyOptions": { "DATE_FORMAT": "MM/DD/YYYY", "TIME_FORMAT":
-
- "''HH24:MI:SS.FF''" }.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: additional_format_options
- description: 'Additional format options directly passed to snowflake Copy
-
- Command. Type: key value pairs (value should be string type) (or Expression
- with resultType
-
- object). Example: "additionalFormatOptions": { "OVERWRITE": "TRUE", "MAX_FILE_SIZE":
- "''FALSE''"
-
- }.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The export setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Additional copy options directly passed to snowflake Copy
-
- Command. Type: key value pairs (value should be string type) (or Expression with
- resultType
-
- object). Example: "additionalCopyOptions": { "DATE_FORMAT": "MM/DD/YYYY", "TIME_FORMAT":
-
- "''HH24:MI:SS.FF''" }.'
- name: additional_copy_options
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: 'Additional format options directly passed to snowflake Copy
-
- Command. Type: key value pairs (value should be string type) (or Expression with
- resultType
-
- object). Example: "additionalFormatOptions": { "OVERWRITE": "TRUE", "MAX_FILE_SIZE":
- "''FALSE''"
-
- }.'
- name: additional_format_options
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SnowflakeImportCopyCommand.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SnowflakeImportCopyCommand.yml
deleted file mode 100644
index 3493b8be387d..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SnowflakeImportCopyCommand.yml
+++ /dev/null
@@ -1,78 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SnowflakeImportCopyCommand
-name: SnowflakeImportCopyCommand
-fullName: azure.synapse.artifacts.models.SnowflakeImportCopyCommand
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.ImportSettings
-summary: 'Snowflake import command settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SnowflakeImportCopyCommand(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, additional_copy_options: Dict[str, MutableMapping[str, Any]]
- | None = None, additional_format_options: Dict[str, MutableMapping[str, Any]]
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: additional_copy_options
- description: 'Additional copy options directly passed to snowflake Copy
-
- Command. Type: key value pairs (value should be string type) (or Expression
- with resultType
-
- object). Example: "additionalCopyOptions": { "DATE_FORMAT": "MM/DD/YYYY", "TIME_FORMAT":
-
- "''HH24:MI:SS.FF''" }.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: additional_format_options
- description: 'Additional format options directly passed to snowflake Copy
-
- Command. Type: key value pairs (value should be string type) (or Expression
- with resultType
-
- object). Example: "additionalFormatOptions": { "FORCE": "TRUE", "LOAD_UNCERTAIN_FILES":
-
- "''FALSE''" }.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The import setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Additional copy options directly passed to snowflake Copy
-
- Command. Type: key value pairs (value should be string type) (or Expression with
- resultType
-
- object). Example: "additionalCopyOptions": { "DATE_FORMAT": "MM/DD/YYYY", "TIME_FORMAT":
-
- "''HH24:MI:SS.FF''" }.'
- name: additional_copy_options
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: 'Additional format options directly passed to snowflake Copy
-
- Command. Type: key value pairs (value should be string type) (or Expression with
- resultType
-
- object). Example: "additionalFormatOptions": { "FORCE": "TRUE", "LOAD_UNCERTAIN_FILES":
-
- "''FALSE''" }.'
- name: additional_format_options
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SnowflakeLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SnowflakeLinkedService.yml
deleted file mode 100644
index 3e3fc8fb31a6..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SnowflakeLinkedService.yml
+++ /dev/null
@@ -1,107 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SnowflakeLinkedService
-name: SnowflakeLinkedService
-fullName: azure.synapse.artifacts.models.SnowflakeLinkedService
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.LinkedService
-summary: 'Snowflake linked service.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SnowflakeLinkedService(*, connection_string: MutableMapping[str, Any],
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, connect_via:
- _models.IntegrationRuntimeReference | None = None, description: str | None = None,
- parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations:
- List[MutableMapping[str, Any]] | None = None, password: _models.AzureKeyVaultSecretReference
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: connect_via
- description: The integration runtime reference.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- - name: description
- description: Linked service description.
- types:
- - <xref:str>
- - name: parameters
- description: Parameters for linked service.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the linked service.
- types:
- - <xref:list>[<xref:JSON>]
- - name: connection_string
- description: 'The connection string of snowflake. Type: string, SecureString.
-
- Required.'
- types:
- - <xref:JSON>
- - name: password
- description: The Azure key vault secret reference of password in connection string.
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- - 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).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The connection string of snowflake. Type: string, SecureString.
-
- Required.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of password in connection string.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SnowflakeSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SnowflakeSink.yml
deleted file mode 100644
index 8540221dd920..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SnowflakeSink.yml
+++ /dev/null
@@ -1,117 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SnowflakeSink
-name: SnowflakeSink
-fullName: azure.synapse.artifacts.models.SnowflakeSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity snowflake sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SnowflakeSink(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, write_batch_size: MutableMapping[str, Any] | None = None, write_batch_timeout:
- MutableMapping[str, Any] | None = None, sink_retry_count: MutableMapping[str,
- Any] | None = None, sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, pre_copy_script: MutableMapping[str, Any]
- | None = None, import_settings: _models.SnowflakeImportCopyCommand | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: pre_copy_script
- description: 'SQL pre-copy script. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: import_settings
- description: Snowflake import settings.
- types:
- - <xref:azure.synapse.artifacts.models.SnowflakeImportCopyCommand>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'SQL pre-copy script. Type: string (or Expression with resultType
-
- string).'
- name: pre_copy_script
- types:
- - <xref:JSON>
-- description: Snowflake import settings.
- name: import_settings
- types:
- - <xref:azure.synapse.artifacts.models.SnowflakeImportCopyCommand>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SnowflakeSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SnowflakeSource.yml
deleted file mode 100644
index 5c809db592c7..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SnowflakeSource.yml
+++ /dev/null
@@ -1,88 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SnowflakeSource
-name: SnowflakeSource
-fullName: azure.synapse.artifacts.models.SnowflakeSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity snowflake source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SnowflakeSource(*, export_settings: _models.SnowflakeExportCopyCommand,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, source_retry_count:
- MutableMapping[str, Any] | None = None, source_retry_wait: MutableMapping[str,
- Any] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None
- = None, query: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query
- description: 'Snowflake Sql query. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
- - name: export_settings
- description: Snowflake export settings. Required.
- types:
- - <xref:azure.synapse.artifacts.models.SnowflakeExportCopyCommand>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Snowflake Sql query. Type: string (or Expression with resultType string).'
- name: query
- types:
- - <xref:JSON>
-- description: Snowflake export settings. Required.
- name: export_settings
- types:
- - <xref:azure.synapse.artifacts.models.SnowflakeExportCopyCommand>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkAuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkAuthenticationType.yml
index 8c27420fe224..86ca542c6b09 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkAuthenticationType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkAuthenticationType.yml
@@ -11,11 +11,11 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJob.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJob.yml
index 4401c90f0cc4..e1672b1de803 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJob.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJob.yml
@@ -4,180 +4,113 @@ name: SparkBatchJob
fullName: azure.synapse.artifacts.models.SparkBatchJob
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'SparkBatchJob.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SparkBatchJob(*, id: int, livy_info: _models.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 | _models.SparkJobType |
- None = None, result: str | _models.SparkBatchJobResultType | None = None, scheduler:
- _models.SparkScheduler | None = None, plugin: _models.SparkServicePlugin | None
- = None, errors: List[_models.SparkServiceError] | None = None, tags: Dict[str,
- str] | None = None, app_id: str | None = None, app_info: Dict[str, str] | None
- = None, state: str | _models.LivyStates | None = None, log_lines: List[str] |
- None = None, **kwargs: Any)'
+ 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:
- <xref:azure.synapse.artifacts.models.SparkBatchJobState>
- name: name
description: The batch name.
+ isRequired: true
types:
- <xref:str>
- name: workspace_name
description: The workspace name.
+ isRequired: true
types:
- <xref:str>
- name: spark_pool_name
description: The Spark pool name.
+ isRequired: true
types:
- <xref:str>
- name: submitter_name
description: The submitter name.
+ isRequired: true
types:
- <xref:str>
- name: submitter_id
description: The submitter identifier.
+ isRequired: true
types:
- <xref:str>
- name: artifact_id
description: The artifact identifier.
+ isRequired: true
types:
- <xref:str>
- name: job_type
- description: 'The job type. Known values are: "SparkBatch" and "SparkSession".'
+ description: 'The job type. Possible values include: "SparkBatch", "SparkSession".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.SparkJobType>
- name: result
- description: 'The Spark batch job result. Known values are: "Uncertain", "Succeeded",
+ description: 'The Spark batch job result. Possible values include: "Uncertain",
+ "Succeeded",
- "Failed", and "Cancelled".'
+ "Failed", "Cancelled".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.SparkBatchJobResultType>
- name: scheduler
description: The scheduler information.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SparkScheduler>
- name: plugin
description: The plugin information.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SparkServicePlugin>
- name: errors
description: The error information.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.SparkServiceError>]
- name: tags
- description: The tags.
+ description: A set of tags. The tags.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:str>]
- name: id
- description: The session Id. Required.
+ description: Required. The session Id.
+ isRequired: true
types:
- <xref:int>
- name: app_id
description: The application id of this session.
+ isRequired: true
types:
- <xref:str>
- name: app_info
description: The detailed application info.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:str>]
- name: state
- description: 'The batch state. Known values are: "not_started", "starting", "idle",
- "busy",
-
- "shutting_down", "error", "dead", "killed", "success", "running", and "recovering".'
+ description: The batch state.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.LivyStates>
- name: log_lines
description: The log lines.
+ isRequired: true
types:
- <xref:list>[<xref:str>]
-variables:
-- name: livy_info
- types:
- - <xref:azure.synapse.artifacts.models.SparkBatchJobState>
-- description: The batch name.
- name: name
- types:
- - <xref:str>
-- description: The workspace name.
- name: workspace_name
- types:
- - <xref:str>
-- description: The Spark pool name.
- name: spark_pool_name
- types:
- - <xref:str>
-- description: The submitter name.
- name: submitter_name
- types:
- - <xref:str>
-- description: The submitter identifier.
- name: submitter_id
- types:
- - <xref:str>
-- description: The artifact identifier.
- name: artifact_id
- types:
- - <xref:str>
-- description: 'The job type. Known values are: "SparkBatch" and "SparkSession".'
- name: job_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SparkJobType>
-- description: 'The Spark batch job result. Known values are: "Uncertain", "Succeeded",
- "Failed",
-
- and "Cancelled".'
- name: result
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SparkBatchJobResultType>
-- description: The scheduler information.
- name: scheduler
- types:
- - <xref:azure.synapse.artifacts.models.SparkScheduler>
-- description: The plugin information.
- name: plugin
- types:
- - <xref:azure.synapse.artifacts.models.SparkServicePlugin>
-- description: The error information.
- name: errors
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.SparkServiceError>]
-- description: The tags.
- name: tags
- types:
- - <xref:dict>[<xref:str>, <xref:str>]
-- description: The session Id. Required.
- name: id
- types:
- - <xref:int>
-- description: The application id of this session.
- name: app_id
- types:
- - <xref:str>
-- description: The detailed application info.
- name: app_info
- types:
- - <xref:dict>[<xref:str>, <xref:str>]
-- description: 'The batch state. Known values are: "not_started", "starting", "idle",
- "busy",
-
- "shutting_down", "error", "dead", "killed", "success", "running", and "recovering".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.LivyStates>
-- description: The log lines.
- name: log_lines
- types:
- - <xref:list>[<xref:str>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJobResultType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJobResultType.yml
index 889227120508..c228e0ff84b3 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJobResultType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJobResultType.yml
@@ -11,11 +11,11 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJobState.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJobState.yml
index a36545a523c9..6cddff4504e1 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJobState.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJobState.yml
@@ -4,83 +4,56 @@ name: SparkBatchJobState
fullName: azure.synapse.artifacts.models.SparkBatchJobState
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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: _models.SparkRequest | None = None, **kwargs: Any)'
+ 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:
- <xref:datetime.datetime>
- name: starting_at
description: the time that at which "starting" livy state was first seen.
+ isRequired: true
types:
- <xref:datetime.datetime>
- name: running_at
description: the time that at which "running" livy state was first seen.
+ isRequired: true
types:
- <xref:datetime.datetime>
- name: dead_at
description: time that at which "dead" livy state was first seen.
+ isRequired: true
types:
- <xref:datetime.datetime>
- name: success_at
description: the time that at which "success" livy state was first seen.
+ isRequired: true
types:
- <xref:datetime.datetime>
- name: terminated_at
description: the time that at which "killed" livy state was first seen.
+ isRequired: true
types:
- <xref:datetime.datetime>
- name: recovering_at
description: the time that at which "recovering" livy state was first seen.
+ isRequired: true
types:
- <xref:datetime.datetime>
- name: current_state
description: the Spark job state.
+ isRequired: true
types:
- <xref:str>
- name: job_creation_request
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SparkRequest>
-variables:
-- description: the time that at which "not_started" livy state was first seen.
- name: not_started_at
- types:
- - <xref:datetime.datetime>
-- description: the time that at which "starting" livy state was first seen.
- name: starting_at
- types:
- - <xref:datetime.datetime>
-- description: the time that at which "running" livy state was first seen.
- name: running_at
- types:
- - <xref:datetime.datetime>
-- description: time that at which "dead" livy state was first seen.
- name: dead_at
- types:
- - <xref:datetime.datetime>
-- description: the time that at which "success" livy state was first seen.
- name: success_at
- types:
- - <xref:datetime.datetime>
-- description: the time that at which "killed" livy state was first seen.
- name: terminated_at
- types:
- - <xref:datetime.datetime>
-- description: the time that at which "recovering" livy state was first seen.
- name: recovering_at
- types:
- - <xref:datetime.datetime>
-- description: the Spark job state.
- name: current_state
- types:
- - <xref:str>
-- name: job_creation_request
- types:
- - <xref:azure.synapse.artifacts.models.SparkRequest>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkConfiguration.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkConfiguration.yml
deleted file mode 100644
index 29454908c7d3..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkConfiguration.yml
+++ /dev/null
@@ -1,74 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SparkConfiguration
-name: SparkConfiguration
-fullName: azure.synapse.artifacts.models.SparkConfiguration
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'SparkConfiguration Artifact information.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SparkConfiguration(*, configs: Dict[str, str], description: str | None
- = None, annotations: List[str] | None = None, notes: str | None = None, created_by:
- str | None = None, created: datetime | None = None, config_merge_rule: Dict[str,
- str] | None = None, **kwargs: Any)'
- parameters:
- - name: description
- description: Description about the SparkConfiguration.
- types:
- - <xref:str>
- - name: configs
- description: SparkConfiguration configs. Required.
- types:
- - <xref:dict>[<xref:str>, <xref:str>]
- - name: annotations
- description: Annotations for SparkConfiguration.
- types:
- - <xref:list>[<xref:str>]
- - name: notes
- description: additional Notes.
- types:
- - <xref:str>
- - name: created_by
- description: The identity that created the resource.
- types:
- - <xref:str>
- - name: created
- description: The timestamp of resource creation.
- types:
- - <xref:datetime.datetime>
- - name: config_merge_rule
- description: SparkConfiguration configMergeRule.
- types:
- - <xref:dict>[<xref:str>, <xref:str>]
-variables:
-- description: Description about the SparkConfiguration.
- name: description
- types:
- - <xref:str>
-- description: SparkConfiguration configs. Required.
- name: configs
- types:
- - <xref:dict>[<xref:str>, <xref:str>]
-- description: Annotations for SparkConfiguration.
- name: annotations
- types:
- - <xref:list>[<xref:str>]
-- description: additional Notes.
- name: notes
- types:
- - <xref:str>
-- description: The identity that created the resource.
- name: created_by
- types:
- - <xref:str>
-- description: The timestamp of resource creation.
- name: created
- types:
- - <xref:datetime.datetime>
-- description: SparkConfiguration configMergeRule.
- name: config_merge_rule
- types:
- - <xref:dict>[<xref:str>, <xref:str>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkConfigurationListResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkConfigurationListResponse.yml
deleted file mode 100644
index c6ee3d12b862..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkConfigurationListResponse.yml
+++ /dev/null
@@ -1,32 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SparkConfigurationListResponse
-name: SparkConfigurationListResponse
-fullName: azure.synapse.artifacts.models.SparkConfigurationListResponse
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'A list of sparkconfiguration resources.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SparkConfigurationListResponse(*, value: List[_models.SparkConfigurationResource],
- next_link: str | None = None, **kwargs: Any)'
- parameters:
- - name: value
- description: List of sparkconfigurations. Required.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.SparkConfigurationResource>]
- - name: next_link
- description: The link to the next page of results, if any remaining results exist.
- types:
- - <xref:str>
-variables:
-- description: List of sparkconfigurations. Required.
- name: value
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.SparkConfigurationResource>]
-- description: The link to the next page of results, if any remaining results exist.
- name: next_link
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkConfigurationParametrizationReference.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkConfigurationParametrizationReference.yml
deleted file mode 100644
index 486e3c4814a8..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkConfigurationParametrizationReference.yml
+++ /dev/null
@@ -1,39 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SparkConfigurationParametrizationReference
-name: SparkConfigurationParametrizationReference
-fullName: azure.synapse.artifacts.models.SparkConfigurationParametrizationReference
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Spark configuration reference.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SparkConfigurationParametrizationReference(*, type: str | _models.SparkConfigurationReferenceType,
- reference_name: MutableMapping[str, Any], **kwargs: Any)'
- parameters:
- - name: type
- description: Spark configuration reference type. Required. "SparkConfigurationReference"
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SparkConfigurationReferenceType>
- - name: reference_name
- description: 'Reference spark configuration name. Type: string (or Expression
- with
-
- resultType string). Required.'
- types:
- - <xref:JSON>
-variables:
-- description: Spark configuration reference type. Required. "SparkConfigurationReference"
- name: type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SparkConfigurationReferenceType>
-- description: 'Reference spark configuration name. Type: string (or Expression with
-
- resultType string). Required.'
- name: reference_name
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkConfigurationReference.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkConfigurationReference.yml
deleted file mode 100644
index e37a68bfcc84..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkConfigurationReference.yml
+++ /dev/null
@@ -1,34 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SparkConfigurationReference
-name: SparkConfigurationReference
-fullName: azure.synapse.artifacts.models.SparkConfigurationReference
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Spark configuration reference.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SparkConfigurationReference(*, type: str | _models.SparkConfigurationReferenceType,
- reference_name: str, **kwargs: Any)'
- parameters:
- - name: type
- description: Spark configuration reference type. Required. "SparkConfigurationReference"
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SparkConfigurationReferenceType>
- - name: reference_name
- description: Reference spark configuration name. Required.
- types:
- - <xref:str>
-variables:
-- description: Spark configuration reference type. Required. "SparkConfigurationReference"
- name: type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SparkConfigurationReferenceType>
-- description: Reference spark configuration name. Required.
- name: reference_name
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkConfigurationReferenceType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkConfigurationReferenceType.yml
deleted file mode 100644
index b8bb92bed803..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkConfigurationReferenceType.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.SparkConfigurationReferenceType
-name: SparkConfigurationReferenceType
-fullName: azure.synapse.artifacts.models.SparkConfigurationReferenceType
-summary: Spark configuration reference type.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: SparkConfigurationReferenceType(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: SPARK_CONFIGURATION_REFERENCE
- uid: azure.synapse.artifacts.models.SparkConfigurationReferenceType.SPARK_CONFIGURATION_REFERENCE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkConfigurationResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkConfigurationResource.yml
deleted file mode 100644
index 17f876ace5fd..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkConfigurationResource.yml
+++ /dev/null
@@ -1,48 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SparkConfigurationResource
-name: SparkConfigurationResource
-fullName: azure.synapse.artifacts.models.SparkConfigurationResource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.SubResource
-summary: 'Spark Configuration 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: 'SparkConfigurationResource(*, properties: _models.SparkConfiguration, **kwargs:
- Any)'
- parameters:
- - name: properties
- description: Properties of Spark Configuration. Required.
- types:
- - <xref:azure.synapse.artifacts.models.SparkConfiguration>
-variables:
-- description: 'Fully qualified resource ID for the resource. Ex -
-
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.'
- name: id
- types:
- - <xref:str>
-- description: The name of the resource.
- name: name
- types:
- - <xref:str>
-- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines"
- or
-
- "Microsoft.Storage/storageAccounts".'
- name: type
- types:
- - <xref:str>
-- description: Resource Etag.
- name: etag
- types:
- - <xref:str>
-- description: Properties of Spark Configuration. Required.
- name: properties
- types:
- - <xref:azure.synapse.artifacts.models.SparkConfiguration>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkErrorSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkErrorSource.yml
index cc1edbdf5eeb..c969f498d95b 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkErrorSource.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkErrorSource.yml
@@ -2,7 +2,6 @@
uid: azure.synapse.artifacts.models.SparkErrorSource
name: SparkErrorSource
fullName: azure.synapse.artifacts.models.SparkErrorSource
-summary: SparkErrorSource.
module: azure.synapse.artifacts.models
constructor:
syntax: SparkErrorSource(value, names=None, *, module=None, qualname=None, type=None,
@@ -11,11 +10,11 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinition.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinition.yml
index e8b8e59e1815..dba8d9c6d505 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinition.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinition.yml
@@ -4,91 +4,46 @@ name: SparkJobDefinition
fullName: azure.synapse.artifacts.models.SparkJobDefinition
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'Spark job definition.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SparkJobDefinition(*, target_big_data_pool: _models.BigDataPoolReference,
- job_properties: _models.SparkJobProperties, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, target_spark_configuration:
- _models.SparkConfigurationReference | None = None, required_spark_version: str
- | None = None, language: str | None = None, folder: _models.SparkJobDefinitionFolder
- | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: description
description: The description of the Spark job definition.
+ isRequired: true
types:
- <xref:str>
- name: target_big_data_pool
- description: Big data pool reference. Required.
+ description: Required. Big data pool reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.BigDataPoolReference>
- - name: target_spark_configuration
- description: The spark configuration of the spark job.
- types:
- - <xref:azure.synapse.artifacts.models.SparkConfigurationReference>
- name: required_spark_version
description: The required Spark version of the application.
+ isRequired: true
types:
- <xref:str>
- name: language
description: The language of the Spark application.
+ isRequired: true
types:
- <xref:str>
- name: job_properties
- description: The properties of the Spark job. Required.
+ description: Required. The properties of the Spark job.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SparkJobProperties>
- - name: folder
- description: 'The folder that this Spark job definition is in. If not specified,
- this Spark
-
- job definition will appear at the root level.'
- types:
- - <xref:azure.synapse.artifacts.models.SparkJobDefinitionFolder>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The description of the Spark job definition.
- name: description
- types:
- - <xref:str>
-- description: Big data pool reference. Required.
- name: target_big_data_pool
- types:
- - <xref:azure.synapse.artifacts.models.BigDataPoolReference>
-- description: The spark configuration of the spark job.
- name: target_spark_configuration
- types:
- - <xref:azure.synapse.artifacts.models.SparkConfigurationReference>
-- description: The required Spark version of the application.
- name: required_spark_version
- types:
- - <xref:str>
-- description: The language of the Spark application.
- name: language
- types:
- - <xref:str>
-- description: The properties of the Spark job. Required.
- name: job_properties
- types:
- - <xref:azure.synapse.artifacts.models.SparkJobProperties>
-- description: 'The folder that this Spark job definition is in. If not specified,
- this Spark job
-
- definition will appear at the root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.SparkJobDefinitionFolder>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinitionFolder.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinitionFolder.yml
deleted file mode 100644
index 7517c9132a78..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinitionFolder.yml
+++ /dev/null
@@ -1,23 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SparkJobDefinitionFolder
-name: SparkJobDefinitionFolder
-fullName: azure.synapse.artifacts.models.SparkJobDefinitionFolder
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'The folder that this Spark job definition is in. If not specified, this
- Spark job definition
-
- will appear at the root level.'
-constructor:
- syntax: 'SparkJobDefinitionFolder(*, name: str | None = None, **kwargs: Any)'
- parameters:
- - name: name
- description: The name of the folder that this Spark job definition is in.
- types:
- - <xref:str>
-variables:
-- description: The name of the folder that this Spark job definition is in.
- name: name
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinitionResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinitionResource.yml
index ad297a139201..94f7ab539626 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinitionResource.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinitionResource.yml
@@ -13,36 +13,27 @@ summary: 'Spark job definition resource type.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SparkJobDefinitionResource(*, properties: _models.SparkJobDefinition, **kwargs:
- Any)'
+ syntax: 'SparkJobDefinitionResource(*, properties: SparkJobDefinition, **kwargs)'
parameters:
- name: properties
- description: Properties of spark job definition. Required.
+ description: Required. Properties of spark job definition.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SparkJobDefinition>
variables:
-- description: 'Fully qualified resource ID for the resource. Ex -
-
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.'
+- description: The resource identifier.
name: id
types:
- <xref:str>
-- description: The name of the resource.
+- description: The resource name.
name: name
types:
- <xref:str>
-- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines"
- or
-
- "Microsoft.Storage/storageAccounts".'
+- description: The resource type.
name: type
types:
- <xref:str>
-- description: Resource Etag.
+- description: Etag identifies change in the resource.
name: etag
types:
- <xref:str>
-- description: Properties of spark job definition. Required.
- name: properties
- types:
- - <xref:azure.synapse.artifacts.models.SparkJobDefinition>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinitionsListResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinitionsListResponse.yml
index e7922d2e2030..7fc771695c8f 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinitionsListResponse.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinitionsListResponse.yml
@@ -4,29 +4,22 @@ name: SparkJobDefinitionsListResponse
fullName: azure.synapse.artifacts.models.SparkJobDefinitionsListResponse
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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[_models.SparkJobDefinitionResource],
- next_link: str | None = None, **kwargs: Any)'
+ syntax: 'SparkJobDefinitionsListResponse(*, value: List[SparkJobDefinitionResource],
+ next_link: str | None = None, **kwargs)'
parameters:
- name: value
- description: List of spark job definitions. Required.
+ description: Required. List of spark job definitions.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.SparkJobDefinitionResource>]
- name: next_link
description: The link to the next page of results, if any remaining results exist.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: List of spark job definitions. Required.
- name: value
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.SparkJobDefinitionResource>]
-- description: The link to the next page of results, if any remaining results exist.
- name: next_link
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobProperties.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobProperties.yml
index e7da2745a854..1cea991c3c67 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobProperties.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobProperties.yml
@@ -4,7 +4,7 @@ name: SparkJobProperties
fullName: azure.synapse.artifacts.models.SparkJobProperties
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'The properties of the Spark job.
@@ -12,125 +12,80 @@ summary: 'The properties of the Spark job.
constructor:
syntax: 'SparkJobProperties(*, file: str, driver_memory: str, driver_cores: int,
executor_memory: str, executor_cores: int, num_executors: int, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, name: str | None = None, class_name:
- str | None = None, conf: MutableMapping[str, Any] | None = None, args: List[str]
- | None = None, jars: List[str] | None = None, files: List[str] | None = None,
- archives: List[str] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
description: The name of the job.
+ isRequired: true
types:
- <xref:str>
- name: file
- description: File containing the application to execute. Required.
+ description: Required. File containing the application to execute.
+ isRequired: true
types:
- <xref:str>
- name: class_name
description: Main class for Java/Scala application.
+ isRequired: true
types:
- <xref:str>
- name: conf
description: Spark configuration properties.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: args
description: Command line arguments for the application.
+ isRequired: true
types:
- <xref:list>[<xref:str>]
- name: jars
description: Jars to be used in this job.
+ isRequired: true
types:
- <xref:list>[<xref:str>]
- name: files
description: files to be used in this job.
+ isRequired: true
types:
- <xref:list>[<xref:str>]
- name: archives
description: Archives to be used in this job.
+ isRequired: true
types:
- <xref:list>[<xref:str>]
- name: driver_memory
- description: Amount of memory to use for the driver process. Required.
+ description: Required. Amount of memory to use for the driver process.
+ isRequired: true
types:
- <xref:str>
- name: driver_cores
- description: Number of cores to use for the driver. Required.
+ description: Required. Number of cores to use for the driver.
+ isRequired: true
types:
- <xref:int>
- name: executor_memory
- description: Amount of memory to use per executor process. Required.
+ description: Required. Amount of memory to use per executor process.
+ isRequired: true
types:
- <xref:str>
- name: executor_cores
- description: Number of cores to use for each executor. Required.
+ description: Required. Number of cores to use for each executor.
+ isRequired: true
types:
- <xref:int>
- name: num_executors
- description: Number of executors to launch for this job. Required.
+ description: Required. Number of executors to launch for this job.
+ isRequired: true
types:
- <xref:int>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The name of the job.
- name: name
- types:
- - <xref:str>
-- description: File containing the application to execute. Required.
- name: file
- types:
- - <xref:str>
-- description: Main class for Java/Scala application.
- name: class_name
- types:
- - <xref:str>
-- description: Spark configuration properties.
- name: conf
- types:
- - <xref:JSON>
-- description: Command line arguments for the application.
- name: args
- types:
- - <xref:list>[<xref:str>]
-- description: Jars to be used in this job.
- name: jars
- types:
- - <xref:list>[<xref:str>]
-- description: files to be used in this job.
- name: files
- types:
- - <xref:list>[<xref:str>]
-- description: Archives to be used in this job.
- name: archives
- types:
- - <xref:list>[<xref:str>]
-- description: Amount of memory to use for the driver process. Required.
- name: driver_memory
- types:
- - <xref:str>
-- description: Number of cores to use for the driver. Required.
- name: driver_cores
- types:
- - <xref:int>
-- description: Amount of memory to use per executor process. Required.
- name: executor_memory
- types:
- - <xref:str>
-- description: Number of cores to use for each executor. Required.
- name: executor_cores
- types:
- - <xref:int>
-- description: Number of executors to launch for this job. Required.
- name: num_executors
- types:
- - <xref:int>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobReferenceType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobReferenceType.yml
deleted file mode 100644
index 45505e820254..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobReferenceType.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.SparkJobReferenceType
-name: SparkJobReferenceType
-fullName: azure.synapse.artifacts.models.SparkJobReferenceType
-summary: Synapse spark job reference type.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: SparkJobReferenceType(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: SPARK_JOB_DEFINITION_REFERENCE
- uid: azure.synapse.artifacts.models.SparkJobReferenceType.SPARK_JOB_DEFINITION_REFERENCE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobType.yml
index 3c954808320a..ac9781db9151 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobType.yml
@@ -11,7 +11,7 @@ inheritances:
- builtins.str
- enum.Enum
fields:
-- name: SPARK_BATCH
- uid: azure.synapse.artifacts.models.SparkJobType.SPARK_BATCH
-- name: SPARK_SESSION
- uid: azure.synapse.artifacts.models.SparkJobType.SPARK_SESSION
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkLinkedService.yml
index 6e8ba5afbc87..7401d03c133c 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkLinkedService.yml
@@ -10,252 +10,156 @@ summary: 'Spark Server linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SparkLinkedService(*, host: MutableMapping[str, Any], port: MutableMapping[str,
- Any], authentication_type: str | _models.SparkAuthenticationType, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, server_type:
- str | _models.SparkServerType | None = None, thrift_transport_protocol: str |
- _models.SparkThriftTransportProtocol | None = None, username: MutableMapping[str,
- Any] | None = None, password: _models.SecretBase | None = None, http_path: MutableMapping[str,
- Any] | None = None, enable_ssl: MutableMapping[str, Any] | None = None, trusted_cert_path:
- MutableMapping[str, Any] | None = None, use_system_trust_store: MutableMapping[str,
- Any] | None = None, allow_host_name_cn_mismatch: MutableMapping[str, Any] | None
- = None, allow_self_signed_server_cert: MutableMapping[str, Any] | None = None,
- encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: host
- description: IP address or host name of the Spark server. Required.
+ description: Required. IP address or host name of the Spark server.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: port
- description: 'The TCP port that the Spark server uses to listen for client connections.
+ description: 'Required. The TCP port that the Spark server uses to listen for
+ client
- Required.'
+ connections.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: server_type
- description: 'The type of Spark server. Known values are: "SharkServer",
+ description: 'The type of Spark server. Possible values include: "SharkServer",
- "SharkServer2", and "SparkThriftServer".'
+ "SharkServer2", "SparkThriftServer".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.SparkServerType>
- name: thrift_transport_protocol
- description: 'The transport protocol to use in the Thrift layer. Known
+ description: 'The transport protocol to use in the Thrift layer. Possible
- values are: "Binary", "SASL", and "HTTP ".'
+ values include: "Binary", "SASL", "HTTP ".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.SparkThriftTransportProtocol>
- name: authentication_type
- description: 'The authentication method used to access the Spark server.
+ description: 'Required. The authentication method used to access the Spark
- Required. Known values are: "Anonymous", "Username", "UsernameAndPassword",
- and
+ server. Possible values include: "Anonymous", "Username", "UsernameAndPassword",
"WindowsAzureHDInsightService".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.SparkAuthenticationType>
- name: username
description: The user name that you use to access Spark Server.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: 'The password corresponding to the user name that you provided in
- the
+ the Username
- Username field.'
+ field.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: http_path
description: The partial URL corresponding to the Spark server.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: enable_ssl
description: 'Specifies whether the connections to the server are encrypted using
- SSL.
+ SSL. The
- The default value is false.'
+ default value is false.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: trusted_cert_path
description: 'The full path of the .pem file containing trusted CA certificates
+ for
- for verifying the server when connecting over SSL. This property can only be
- set when using SSL
+ verifying the server when connecting over SSL. This property can only be set
+ when using SSL on
- on self-hosted IR. The default value is the cacerts.pem file installed with
- the IR.'
+ self-hosted IR. The default value is the cacerts.pem file installed with the
+ IR.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_system_trust_store
- description: 'Specifies whether to use a CA certificate from the system
+ description: 'Specifies whether to use a CA certificate from the system trust
- trust store or from a specified PEM file. The default value is false.'
+ store or from a specified PEM file. The default value is false.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: allow_self_signed_server_cert
- description: 'Specifies whether to allow self-signed certificates
+ description: 'Specifies whether to allow self-signed certificates from
- from the server. The default value is false.'
+ the server. The default value is false.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: IP address or host name of the Spark server. Required.
- name: host
- types:
- - <xref:JSON>
-- description: The TCP port that the Spark server uses to listen for client connections.
- Required.
- name: port
- types:
- - <xref:JSON>
-- description: 'The type of Spark server. Known values are: "SharkServer", "SharkServer2",
-
- and "SparkThriftServer".'
- name: server_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SparkServerType>
-- description: 'The transport protocol to use in the Thrift layer. Known
-
- values are: "Binary", "SASL", and "HTTP ".'
- name: thrift_transport_protocol
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SparkThriftTransportProtocol>
-- description: 'The authentication method used to access the Spark server. Required.
-
- Known values are: "Anonymous", "Username", "UsernameAndPassword", and
-
- "WindowsAzureHDInsightService".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SparkAuthenticationType>
-- description: The user name that you use to access Spark Server.
- name: username
- types:
- - <xref:JSON>
-- description: 'The password corresponding to the user name that you provided in the
- Username
-
- field.'
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: The partial URL corresponding to the Spark server.
- name: http_path
- types:
- - <xref:JSON>
-- description: 'Specifies whether the connections to the server are encrypted using
- SSL. The
-
- default value is false.'
- name: enable_ssl
- types:
- - <xref:JSON>
-- 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.'
- name: trusted_cert_path
- types:
- - <xref:JSON>
-- description: 'Specifies whether to use a CA certificate from the system trust
-
- store or from a specified PEM file. The default value is false.'
- name: use_system_trust_store
- types:
- - <xref:JSON>
-- 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.'
- name: allow_host_name_cn_mismatch
- types:
- - <xref:JSON>
-- description: 'Specifies whether to allow self-signed certificates from
-
- the server. The default value is false.'
- name: allow_self_signed_server_cert
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkObjectDataset.yml
index 0ced4189c2d1..f2e37464e96e 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkObjectDataset.yml
@@ -10,137 +10,86 @@ summary: 'Spark Server dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SparkObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, table: MutableMapping[str, Any] | None = None, schema_type_properties_schema:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'This property will be retired. Please consider using schema + table
properties instead.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: table
description: 'The table name of the Spark. Type: string (or Expression with resultType
-
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: schema_type_properties_schema
- description: 'The schema name of the Spark. Type: string (or
+ description: 'The schema name of the Spark. Type: string (or Expression
- Expression with resultType string).'
+ with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'This property will be retired. Please consider using schema + table
-
- properties instead.'
- name: table_name
- types:
- - <xref:JSON>
-- description: 'The table name of the Spark. Type: string (or Expression with resultType
- string).'
- name: table
- types:
- - <xref:JSON>
-- description: 'The schema name of the Spark. Type: string (or Expression
-
- with resultType string).'
- name: schema_type_properties_schema
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkRequest.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkRequest.yml
index d542735b76d4..c9659a2f05e2 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkRequest.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkRequest.yml
@@ -4,7 +4,7 @@ name: SparkRequest
fullName: azure.synapse.artifacts.models.SparkRequest
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: SparkRequest.
constructor:
syntax: 'SparkRequest(*, name: str | None = None, file: str | None = None, class_name:
@@ -13,92 +13,62 @@ constructor:
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: Any)'
+ = None, **kwargs)'
parameters:
- name: name
+ isRequired: true
types:
- <xref:str>
- name: file
+ isRequired: true
types:
- <xref:str>
- name: class_name
+ isRequired: true
types:
- <xref:str>
- name: arguments
+ isRequired: true
types:
- <xref:list>[<xref:str>]
- name: jars
+ isRequired: true
types:
- <xref:list>[<xref:str>]
- name: python_files
+ isRequired: true
types:
- <xref:list>[<xref:str>]
- name: files
+ isRequired: true
types:
- <xref:list>[<xref:str>]
- name: archives
+ isRequired: true
types:
- <xref:list>[<xref:str>]
- name: configuration
description: Dictionary of `<string>`.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:str>]
- name: driver_memory
+ isRequired: true
types:
- <xref:str>
- name: driver_cores
+ isRequired: true
types:
- <xref:int>
- name: executor_memory
+ isRequired: true
types:
- <xref:str>
- name: executor_cores
+ isRequired: true
types:
- <xref:int>
- name: executor_count
+ isRequired: true
types:
- <xref:int>
-variables:
-- name: name
- types:
- - <xref:str>
-- name: file
- types:
- - <xref:str>
-- name: class_name
- types:
- - <xref:str>
-- name: arguments
- types:
- - <xref:list>[<xref:str>]
-- name: jars
- types:
- - <xref:list>[<xref:str>]
-- name: python_files
- types:
- - <xref:list>[<xref:str>]
-- name: files
- types:
- - <xref:list>[<xref:str>]
-- name: archives
- types:
- - <xref:list>[<xref:str>]
-- description: Dictionary of `<string>`.
- name: configuration
- types:
- - <xref:dict>[<xref:str>, <xref:str>]
-- name: driver_memory
- types:
- - <xref:str>
-- name: driver_cores
- types:
- - <xref:int>
-- name: executor_memory
- types:
- - <xref:str>
-- name: executor_cores
- types:
- - <xref:int>
-- name: executor_count
- types:
- - <xref:int>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkScheduler.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkScheduler.yml
index e689472548f1..fd2397ae2931 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkScheduler.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkScheduler.yml
@@ -4,46 +4,32 @@ name: SparkScheduler
fullName: azure.synapse.artifacts.models.SparkScheduler
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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 | _models.SchedulerCurrentState | None = None,
- **kwargs: Any)'
+ | None = None, current_state: str | SchedulerCurrentState | None = None, **kwargs)'
parameters:
- name: submitted_at
+ isRequired: true
types:
- <xref:datetime.datetime>
- name: scheduled_at
+ isRequired: true
types:
- <xref:datetime.datetime>
- name: ended_at
+ isRequired: true
types:
- <xref:datetime.datetime>
- name: cancellation_requested_at
+ isRequired: true
types:
- <xref:datetime.datetime>
- name: current_state
- description: 'Known values are: "Queued", "Scheduled", and "Ended".'
+ description: 'Possible values include: "Queued", "Scheduled", "Ended".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.SchedulerCurrentState>
-variables:
-- name: submitted_at
- types:
- - <xref:datetime.datetime>
-- name: scheduled_at
- types:
- - <xref:datetime.datetime>
-- name: ended_at
- types:
- - <xref:datetime.datetime>
-- name: cancellation_requested_at
- types:
- - <xref:datetime.datetime>
-- description: 'Known values are: "Queued", "Scheduled", and "Ended".'
- name: current_state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SchedulerCurrentState>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServerType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServerType.yml
index adecbdb8638c..3996ca5fd781 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServerType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServerType.yml
@@ -11,9 +11,9 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServiceError.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServiceError.yml
index 655231846ac7..280a1317563c 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServiceError.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServiceError.yml
@@ -4,32 +4,23 @@ name: SparkServiceError
fullName: azure.synapse.artifacts.models.SparkServiceError
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: SparkServiceError.
constructor:
syntax: 'SparkServiceError(*, message: str | None = None, error_code: str | None
- = None, source: str | _models.SparkErrorSource | None = None, **kwargs: Any)'
+ = None, source: str | SparkErrorSource | None = None, **kwargs)'
parameters:
- name: message
+ isRequired: true
types:
- <xref:str>
- name: error_code
+ isRequired: true
types:
- <xref:str>
- name: source
- description: 'Known values are: "System", "User", "Unknown", and "Dependency".'
+ description: 'Possible values include: "System", "User", "Unknown", "Dependency".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.SparkErrorSource>
-variables:
-- name: message
- types:
- - <xref:str>
-- name: error_code
- types:
- - <xref:str>
-- description: 'Known values are: "System", "User", "Unknown", and "Dependency".'
- name: source
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SparkErrorSource>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServicePlugin.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServicePlugin.yml
index b9049d03d750..1099b00fcb47 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServicePlugin.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServicePlugin.yml
@@ -4,56 +4,39 @@ name: SparkServicePlugin
fullName: azure.synapse.artifacts.models.SparkServicePlugin
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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 | _models.PluginCurrentState | None = None, **kwargs: Any)'
+ str | PluginCurrentState | None = None, **kwargs)'
parameters:
- name: preparation_started_at
+ isRequired: true
types:
- <xref:datetime.datetime>
- name: resource_acquisition_started_at
+ isRequired: true
types:
- <xref:datetime.datetime>
- name: submission_started_at
+ isRequired: true
types:
- <xref:datetime.datetime>
- name: monitoring_started_at
+ isRequired: true
types:
- <xref:datetime.datetime>
- name: cleanup_started_at
+ isRequired: true
types:
- <xref:datetime.datetime>
- name: current_state
- description: 'Known values are: "Preparation", "ResourceAcquisition", "Queued",
+ description: 'Possible values include: "Preparation", "ResourceAcquisition", "Queued",
- "Submission", "Monitoring", "Cleanup", and "Ended".'
+ "Submission", "Monitoring", "Cleanup", "Ended".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.PluginCurrentState>
-variables:
-- name: preparation_started_at
- types:
- - <xref:datetime.datetime>
-- name: resource_acquisition_started_at
- types:
- - <xref:datetime.datetime>
-- name: submission_started_at
- types:
- - <xref:datetime.datetime>
-- name: monitoring_started_at
- types:
- - <xref:datetime.datetime>
-- name: cleanup_started_at
- types:
- - <xref:datetime.datetime>
-- description: 'Known values are: "Preparation", "ResourceAcquisition", "Queued",
-
- "Submission", "Monitoring", "Cleanup", and "Ended".'
- name: current_state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.PluginCurrentState>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkSource.yml
deleted file mode 100644
index 16befebe0d9f..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SparkSource
-name: SparkSource
-fullName: azure.synapse.artifacts.models.SparkSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Spark Server source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SparkSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkThriftTransportProtocol.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkThriftTransportProtocol.yml
index 4fb489742633..6d4cbb651f70 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkThriftTransportProtocol.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkThriftTransportProtocol.yml
@@ -11,9 +11,9 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlAlwaysEncryptedAkvAuthType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlAlwaysEncryptedAkvAuthType.yml
deleted file mode 100644
index 24f6aae4934f..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlAlwaysEncryptedAkvAuthType.yml
+++ /dev/null
@@ -1,19 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.SqlAlwaysEncryptedAkvAuthType
-name: SqlAlwaysEncryptedAkvAuthType
-fullName: azure.synapse.artifacts.models.SqlAlwaysEncryptedAkvAuthType
-summary: 'Sql always encrypted AKV authentication type. Type: string.'
-module: azure.synapse.artifacts.models
-constructor:
- syntax: SqlAlwaysEncryptedAkvAuthType(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: MANAGED_IDENTITY
- uid: azure.synapse.artifacts.models.SqlAlwaysEncryptedAkvAuthType.MANAGED_IDENTITY
-- name: SERVICE_PRINCIPAL
- uid: azure.synapse.artifacts.models.SqlAlwaysEncryptedAkvAuthType.SERVICE_PRINCIPAL
-- name: USER_ASSIGNED_MANAGED_IDENTITY
- uid: azure.synapse.artifacts.models.SqlAlwaysEncryptedAkvAuthType.USER_ASSIGNED_MANAGED_IDENTITY
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlAlwaysEncryptedProperties.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlAlwaysEncryptedProperties.yml
deleted file mode 100644
index f96f7877035b..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlAlwaysEncryptedProperties.yml
+++ /dev/null
@@ -1,69 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SqlAlwaysEncryptedProperties
-name: SqlAlwaysEncryptedProperties
-fullName: azure.synapse.artifacts.models.SqlAlwaysEncryptedProperties
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Sql always encrypted properties.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SqlAlwaysEncryptedProperties(*, always_encrypted_akv_auth_type: str | _models.SqlAlwaysEncryptedAkvAuthType,
- service_principal_id: MutableMapping[str, Any] | None = None, service_principal_key:
- _models.SecretBase | None = None, credential: _models.CredentialReference | None
- = None, **kwargs: Any)'
- parameters:
- - name: always_encrypted_akv_auth_type
- description: 'Sql always encrypted AKV authentication type. Type:
-
- string. Required. Known values are: "ServicePrincipal", "ManagedIdentity", and
-
- "UserAssignedManagedIdentity".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SqlAlwaysEncryptedAkvAuthType>
- - name: service_principal_id
- description: 'The client ID of the application in Azure Active Directory used
-
- for Azure Key Vault authentication. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
- - name: service_principal_key
- description: 'The key of the service principal used to authenticate against
-
- Azure Key Vault.'
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
- - name: credential
- description: The credential reference containing authentication information.
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
-variables:
-- description: 'Sql always encrypted AKV authentication type. Type:
-
- string. Required. Known values are: "ServicePrincipal", "ManagedIdentity", and
-
- "UserAssignedManagedIdentity".'
- name: always_encrypted_akv_auth_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SqlAlwaysEncryptedAkvAuthType>
-- description: 'The client ID of the application in Azure Active Directory used for
-
- Azure Key Vault authentication. Type: string (or Expression with resultType string).'
- name: service_principal_id
- types:
- - <xref:JSON>
-- description: 'The key of the service principal used to authenticate against
-
- Azure Key Vault.'
- name: service_principal_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: The credential reference containing authentication information.
- name: credential
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlConnection.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlConnection.yml
index f8488812a567..6862b6ff25af 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlConnection.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlConnection.yml
@@ -4,59 +4,32 @@ name: SqlConnection
fullName: azure.synapse.artifacts.models.SqlConnection
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: The connection used to execute the SQL script.
+- msrest.serialization.Model
+summary: 'The connection used to execute the SQL script.
+
+
+ All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SqlConnection(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, type: str | _models.SqlConnectionType | None = None, name: str
- | None = None, pool_name: str | None = None, database_name: str | None = None,
- **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: type
- description: 'The type of the connection. Known values are: "SqlOnDemand" and
+ description: 'Required. The type of the connection. Possible values include: "SqlOnDemand",
+
"SqlPool".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.SqlConnectionType>
- name: name
- description: The identifier of the connection.
- types:
- - <xref:str>
- - name: pool_name
- description: The associated SQL pool name (supported by SQL pool v3).
- types:
- - <xref:str>
- - name: database_name
- description: The associated database name (supported by SQL pool v3).
+ description: Required. The identifier of the connection.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: 'The type of the connection. Known values are: "SqlOnDemand" and "SqlPool".'
- name: type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SqlConnectionType>
-- description: The identifier of the connection.
- name: name
- types:
- - <xref:str>
-- description: The associated SQL pool name (supported by SQL pool v3).
- name: pool_name
- types:
- - <xref:str>
-- description: The associated database name (supported by SQL pool v3).
- name: database_name
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlConnectionType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlConnectionType.yml
index db9e31c6a446..399be74ebdcb 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlConnectionType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlConnectionType.yml
@@ -11,7 +11,7 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlDWSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlDWSink.yml
deleted file mode 100644
index 558e4b88fa95..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlDWSink.yml
+++ /dev/null
@@ -1,169 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SqlDWSink
-name: SqlDWSink
-fullName: azure.synapse.artifacts.models.SqlDWSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity SQL Data Warehouse sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SqlDWSink(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, write_batch_size: MutableMapping[str, Any] | None = None, write_batch_timeout:
- MutableMapping[str, Any] | None = None, sink_retry_count: MutableMapping[str,
- Any] | None = None, sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, pre_copy_script: MutableMapping[str, Any]
- | None = None, allow_poly_base: MutableMapping[str, Any] | None = None, poly_base_settings:
- _models.PolybaseSettings | None = None, allow_copy_command: MutableMapping[str,
- Any] | None = None, copy_command_settings: _models.DWCopyCommandSettings | None
- = None, table_option: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: pre_copy_script
- description: 'SQL pre-copy script. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: allow_poly_base
- description: 'Indicates to use PolyBase to copy data into SQL Data Warehouse when
-
- applicable. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: poly_base_settings
- description: Specifies PolyBase-related settings when allowPolyBase is true.
- types:
- - <xref:azure.synapse.artifacts.models.PolybaseSettings>
- - name: allow_copy_command
- description: 'Indicates to use Copy Command to copy data into SQL Data
-
- Warehouse. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: copy_command_settings
- description: 'Specifies Copy Command related settings when allowCopyCommand
-
- is true.'
- types:
- - <xref:azure.synapse.artifacts.models.DWCopyCommandSettings>
- - name: table_option
- description: 'The option to handle sink table, such as autoCreate. For now only
-
- ''autoCreate'' value is supported. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'SQL pre-copy script. Type: string (or Expression with resultType
-
- string).'
- name: pre_copy_script
- types:
- - <xref:JSON>
-- description: 'Indicates to use PolyBase to copy data into SQL Data Warehouse when
-
- applicable. Type: boolean (or Expression with resultType boolean).'
- name: allow_poly_base
- types:
- - <xref:JSON>
-- description: Specifies PolyBase-related settings when allowPolyBase is true.
- name: poly_base_settings
- types:
- - <xref:azure.synapse.artifacts.models.PolybaseSettings>
-- description: 'Indicates to use Copy Command to copy data into SQL Data Warehouse.
-
- Type: boolean (or Expression with resultType boolean).'
- name: allow_copy_command
- types:
- - <xref:JSON>
-- description: 'Specifies Copy Command related settings when allowCopyCommand is
-
- true.'
- name: copy_command_settings
- types:
- - <xref:azure.synapse.artifacts.models.DWCopyCommandSettings>
-- description: 'The option to handle sink table, such as autoCreate. For now only
-
- ''autoCreate'' value is supported. Type: string (or Expression with resultType
- string).'
- name: table_option
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlDWSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlDWSource.yml
deleted file mode 100644
index 384518a1d34d..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlDWSource.yml
+++ /dev/null
@@ -1,187 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SqlDWSource
-name: SqlDWSource
-fullName: azure.synapse.artifacts.models.SqlDWSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity SQL Data Warehouse source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SqlDWSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, sql_reader_query: MutableMapping[str,
- Any] | None = None, sql_reader_stored_procedure_name: MutableMapping[str, Any]
- | None = None, stored_procedure_parameters: MutableMapping[str, Any] | None =
- None, isolation_level: MutableMapping[str, Any] | None = None, partition_option:
- MutableMapping[str, Any] | None = None, partition_settings: _models.SqlPartitionSettings
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: sql_reader_query
- description: 'SQL Data Warehouse reader query. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: sql_reader_stored_procedure_name
- description: 'Name of the stored procedure for a SQL Data
-
- Warehouse source. This cannot be used at the same time as SqlReaderQuery. Type:
- string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: stored_procedure_parameters
- description: 'Value and type setting for stored procedure parameters.
-
- Example: "{Parameter1: {value: "1", type: "int"}}". Type: object (or Expression
- with resultType
-
- object), itemType: StoredProcedureParameter.'
- types:
- - <xref:JSON>
- - name: isolation_level
- description: 'Specifies the transaction locking behavior for the SQL source.
-
- Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot.
- The default
-
- value is ReadCommitted. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: partition_option
- description: 'The partition mechanism that will be used for Sql read in parallel.
-
- Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".'
- types:
- - <xref:JSON>
- - name: partition_settings
- description: The settings that will be leveraged for Sql source partitioning.
- types:
- - <xref:azure.synapse.artifacts.models.SqlPartitionSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'SQL Data Warehouse reader query. Type: string (or Expression with
-
- resultType string).'
- name: sql_reader_query
- types:
- - <xref:JSON>
-- description: 'Name of the stored procedure for a SQL Data Warehouse
-
- source. This cannot be used at the same time as SqlReaderQuery. Type: string (or
- Expression
-
- with resultType string).'
- name: sql_reader_stored_procedure_name
- types:
- - <xref:JSON>
-- description: 'Value and type setting for stored procedure parameters.
-
- Example: "{Parameter1: {value: "1", type: "int"}}". Type: object (or Expression
- with resultType
-
- object), itemType: StoredProcedureParameter.'
- name: stored_procedure_parameters
- types:
- - <xref:JSON>
-- description: 'Specifies the transaction locking behavior for the SQL source. Allowed
-
- values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The
- default value
-
- is ReadCommitted. Type: string (or Expression with resultType string).'
- name: isolation_level
- types:
- - <xref:JSON>
-- description: 'The partition mechanism that will be used for Sql read in parallel.
-
- Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".'
- name: partition_option
- types:
- - <xref:JSON>
-- description: The settings that will be leveraged for Sql source partitioning.
- name: partition_settings
- types:
- - <xref:azure.synapse.artifacts.models.SqlPartitionSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlMISink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlMISink.yml
deleted file mode 100644
index 2364f4888f47..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlMISink.yml
+++ /dev/null
@@ -1,170 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SqlMISink
-name: SqlMISink
-fullName: azure.synapse.artifacts.models.SqlMISink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity Azure SQL Managed Instance sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SqlMISink(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, write_batch_size: MutableMapping[str, Any] | None = None, write_batch_timeout:
- MutableMapping[str, Any] | None = None, sink_retry_count: MutableMapping[str,
- Any] | None = None, sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, sql_writer_stored_procedure_name: MutableMapping[str,
- Any] | None = None, sql_writer_table_type: MutableMapping[str, Any] | None = None,
- pre_copy_script: MutableMapping[str, Any] | None = None, stored_procedure_parameters:
- Dict[str, _models.StoredProcedureParameter] | None = None, stored_procedure_table_type_parameter_name:
- MutableMapping[str, Any] | None = None, table_option: MutableMapping[str, Any]
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: sql_writer_stored_procedure_name
- description: 'SQL writer stored procedure name. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: sql_writer_table_type
- description: 'SQL writer table type. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: pre_copy_script
- description: 'SQL pre-copy script. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: stored_procedure_parameters
- description: SQL stored procedure parameters.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.StoredProcedureParameter>]
- - name: stored_procedure_table_type_parameter_name
- description: 'The stored procedure parameter name of the
-
- table type. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: table_option
- description: 'The option to handle sink table, such as autoCreate. For now only
-
- ''autoCreate'' value is supported. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'SQL writer stored procedure name. Type: string (or
-
- Expression with resultType string).'
- name: sql_writer_stored_procedure_name
- types:
- - <xref:JSON>
-- description: 'SQL writer table type. Type: string (or Expression with resultType
-
- string).'
- name: sql_writer_table_type
- types:
- - <xref:JSON>
-- description: 'SQL pre-copy script. Type: string (or Expression with resultType
-
- string).'
- name: pre_copy_script
- types:
- - <xref:JSON>
-- description: SQL stored procedure parameters.
- name: stored_procedure_parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.StoredProcedureParameter>]
-- description: 'The stored procedure parameter name of the
-
- table type. Type: string (or Expression with resultType string).'
- name: stored_procedure_table_type_parameter_name
- types:
- - <xref:JSON>
-- description: 'The option to handle sink table, such as autoCreate. For now only
-
- ''autoCreate'' value is supported. Type: string (or Expression with resultType
- string).'
- name: table_option
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlMISource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlMISource.yml
deleted file mode 100644
index 263df440a309..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlMISource.yml
+++ /dev/null
@@ -1,188 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SqlMISource
-name: SqlMISource
-fullName: azure.synapse.artifacts.models.SqlMISource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Azure SQL Managed Instance source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SqlMISource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, sql_reader_query: MutableMapping[str,
- Any] | None = None, sql_reader_stored_procedure_name: MutableMapping[str, Any]
- | None = None, stored_procedure_parameters: Dict[str, _models.StoredProcedureParameter]
- | None = None, isolation_level: MutableMapping[str, Any] | None = None, produce_additional_types:
- MutableMapping[str, Any] | None = None, partition_option: MutableMapping[str,
- Any] | None = None, partition_settings: _models.SqlPartitionSettings | None =
- None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: sql_reader_query
- description: 'SQL reader query. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: sql_reader_stored_procedure_name
- description: 'Name of the stored procedure for a Azure SQL Managed
-
- Instance source. This cannot be used at the same time as SqlReaderQuery. Type:
- string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: stored_procedure_parameters
- description: 'Value and type setting for stored procedure parameters.
-
- Example: "{Parameter1: {value: "1", type: "int"}}".'
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.StoredProcedureParameter>]
- - name: isolation_level
- description: 'Specifies the transaction locking behavior for the SQL source.
-
- Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot.
- The default
-
- value is ReadCommitted. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: produce_additional_types
- description: Which additional types to produce.
- types:
- - <xref:JSON>
- - name: partition_option
- description: 'The partition mechanism that will be used for Sql read in parallel.
-
- Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".'
- types:
- - <xref:JSON>
- - name: partition_settings
- description: The settings that will be leveraged for Sql source partitioning.
- types:
- - <xref:azure.synapse.artifacts.models.SqlPartitionSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'SQL reader query. Type: string (or Expression with resultType string).'
- name: sql_reader_query
- types:
- - <xref:JSON>
-- description: 'Name of the stored procedure for a Azure SQL Managed
-
- Instance source. This cannot be used at the same time as SqlReaderQuery. Type:
- string (or
-
- Expression with resultType string).'
- name: sql_reader_stored_procedure_name
- types:
- - <xref:JSON>
-- description: 'Value and type setting for stored procedure parameters.
-
- Example: "{Parameter1: {value: "1", type: "int"}}".'
- name: stored_procedure_parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.StoredProcedureParameter>]
-- description: 'Specifies the transaction locking behavior for the SQL source. Allowed
-
- values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The
- default value
-
- is ReadCommitted. Type: string (or Expression with resultType string).'
- name: isolation_level
- types:
- - <xref:JSON>
-- description: Which additional types to produce.
- name: produce_additional_types
- types:
- - <xref:JSON>
-- description: 'The partition mechanism that will be used for Sql read in parallel.
-
- Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".'
- name: partition_option
- types:
- - <xref:JSON>
-- description: The settings that will be leveraged for Sql source partitioning.
- name: partition_settings
- types:
- - <xref:azure.synapse.artifacts.models.SqlPartitionSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlPartitionOption.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlPartitionOption.yml
deleted file mode 100644
index 587bae0c45cb..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlPartitionOption.yml
+++ /dev/null
@@ -1,19 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.SqlPartitionOption
-name: SqlPartitionOption
-fullName: azure.synapse.artifacts.models.SqlPartitionOption
-summary: The partition mechanism that will be used for Sql read in parallel.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: SqlPartitionOption(value, names=None, *, module=None, qualname=None, type=None,
- start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: DYNAMIC_RANGE
- uid: azure.synapse.artifacts.models.SqlPartitionOption.DYNAMIC_RANGE
-- name: NONE
- uid: azure.synapse.artifacts.models.SqlPartitionOption.NONE
-- name: PHYSICAL_PARTITIONS_OF_TABLE
- uid: azure.synapse.artifacts.models.SqlPartitionOption.PHYSICAL_PARTITIONS_OF_TABLE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlPartitionSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlPartitionSettings.yml
deleted file mode 100644
index 4983b4b7e9af..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlPartitionSettings.yml
+++ /dev/null
@@ -1,86 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SqlPartitionSettings
-name: SqlPartitionSettings
-fullName: azure.synapse.artifacts.models.SqlPartitionSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: The settings that will be leveraged for Sql source partitioning.
-constructor:
- syntax: 'SqlPartitionSettings(*, partition_column_name: MutableMapping[str, Any]
- | None = None, partition_upper_bound: MutableMapping[str, Any] | None = None,
- partition_lower_bound: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: partition_column_name
- description: 'The name of the column in integer or datetime type that will be
-
- used for proceeding partitioning. If not specified, the primary key of the table
- is
-
- auto-detected and used as the partition column. Type: string (or Expression
- with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: partition_upper_bound
- description: 'The maximum value of the partition column for partition range
-
- splitting. This value is used to decide the partition stride, not for filtering
- the rows in
-
- table. All rows in the table or query result will be partitioned and copied.
- Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: partition_lower_bound
- description: 'The minimum value of the partition column for partition range
-
- splitting. This value is used to decide the partition stride, not for filtering
- the rows in
-
- table. All rows in the table or query result will be partitioned and copied.
- Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'The name of the column in integer or datetime type that will be
-
- used for proceeding partitioning. If not specified, the primary key of the table
- is
-
- auto-detected and used as the partition column. Type: string (or Expression with
- resultType
-
- string).'
- name: partition_column_name
- types:
- - <xref:JSON>
-- description: 'The maximum value of the partition column for partition range
-
- splitting. This value is used to decide the partition stride, not for filtering
- the rows in
-
- table. All rows in the table or query result will be partitioned and copied. Type:
- string (or
-
- Expression with resultType string).'
- name: partition_upper_bound
- types:
- - <xref:JSON>
-- description: 'The minimum value of the partition column for partition range
-
- splitting. This value is used to decide the partition stride, not for filtering
- the rows in
-
- table. All rows in the table or query result will be partitioned and copied. Type:
- string (or
-
- Expression with resultType string).'
- name: partition_lower_bound
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlPool.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlPool.yml
deleted file mode 100644
index 58a6948ce46a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlPool.yml
+++ /dev/null
@@ -1,194 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SqlPool
-name: SqlPool
-fullName: azure.synapse.artifacts.models.SqlPool
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TrackedResource
-summary: 'A SQL Analytics pool.
-
-
- Variables are only populated by the server, and will be ignored when sending a request.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SqlPool(*, location: str, tags: Dict[str, str] | None = None, sku: _models.Sku
- | None = None, max_size_bytes: int | None = None, collation: str | None = None,
- source_database_id: str | None = None, recoverable_database_id: str | None = None,
- provisioning_state: str | None = None, status: str | None = None, restore_point_in_time:
- str | None = None, create_mode: str | _models.CreateMode | None = None, creation_date:
- datetime | None = None, **kwargs: Any)'
- parameters:
- - name: tags
- description: Resource tags.
- types:
- - <xref:dict>[<xref:str>, <xref:str>]
- - name: location
- description: The geo-location where the resource lives. Required.
- types:
- - <xref:str>
- - name: sku
- description: SQL pool SKU.
- types:
- - <xref:azure.synapse.artifacts.models.Sku>
- - name: max_size_bytes
- description: Maximum size in bytes.
- types:
- - <xref:int>
- - name: collation
- description: Collation mode.
- types:
- - <xref:str>
- - name: source_database_id
- description: Source database to create from.
- types:
- - <xref:str>
- - name: recoverable_database_id
- description: Backup database to restore from.
- types:
- - <xref:str>
- - name: provisioning_state
- description: Resource state.
- types:
- - <xref:str>
- - name: status
- description: Resource status.
- types:
- - <xref:str>
- - name: restore_point_in_time
- description: Snapshot time to restore.
- types:
- - <xref:str>
- - name: create_mode
- description: 'Specifies the mode of sql pool creation.
-
-
- Default: regular sql pool creation.
-
-
- PointInTimeRestore: Creates a sql pool by restoring a point in time backup of
- an existing sql
-
- pool. sourceDatabaseId must be specified as the resource ID of the existing
- sql pool, and
-
- restorePointInTime must be specified.
-
-
- Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must
- be specified
-
- as the recoverableDatabaseId to restore.
-
-
- Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId
-
- should be the sql pool''s original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate
-
- must be specified. Known values are: "Default", "PointInTimeRestore", "Recovery",
- and
-
- "Restore".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.CreateMode>
- - name: creation_date
- description: Date the SQL pool was created.
- types:
- - <xref:datetime.datetime>
-variables:
-- description: 'Fully qualified resource ID for the resource. Ex -
-
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.'
- name: id
- types:
- - <xref:str>
-- description: The name of the resource.
- name: name
- types:
- - <xref:str>
-- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines"
- or
-
- "Microsoft.Storage/storageAccounts".'
- name: type
- types:
- - <xref:str>
-- description: Resource tags.
- name: tags
- types:
- - <xref:dict>[<xref:str>, <xref:str>]
-- description: The geo-location where the resource lives. Required.
- name: location
- types:
- - <xref:str>
-- description: SQL pool SKU.
- name: sku
- types:
- - <xref:azure.synapse.artifacts.models.Sku>
-- description: Maximum size in bytes.
- name: max_size_bytes
- types:
- - <xref:int>
-- description: Collation mode.
- name: collation
- types:
- - <xref:str>
-- description: Source database to create from.
- name: source_database_id
- types:
- - <xref:str>
-- description: Backup database to restore from.
- name: recoverable_database_id
- types:
- - <xref:str>
-- description: Resource state.
- name: provisioning_state
- types:
- - <xref:str>
-- description: Resource status.
- name: status
- types:
- - <xref:str>
-- description: Snapshot time to restore.
- name: restore_point_in_time
- types:
- - <xref:str>
-- description: 'Specifies the mode of sql pool creation.
-
-
- Default: regular sql pool creation.
-
-
- PointInTimeRestore: Creates a sql pool by restoring a point in time backup of
- an existing sql
-
- pool. sourceDatabaseId must be specified as the resource ID of the existing sql
- pool, and
-
- restorePointInTime must be specified.
-
-
- Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must
- be specified
-
- as the recoverableDatabaseId to restore.
-
-
- Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId
-
- should be the sql pool''s original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate
-
- must be specified. Known values are: "Default", "PointInTimeRestore", "Recovery",
- and
-
- "Restore".'
- name: create_mode
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.CreateMode>
-- description: Date the SQL pool was created.
- name: creation_date
- types:
- - <xref:datetime.datetime>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlPoolInfoListResult.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlPoolInfoListResult.yml
deleted file mode 100644
index c38ddde425f4..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlPoolInfoListResult.yml
+++ /dev/null
@@ -1,29 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SqlPoolInfoListResult
-name: SqlPoolInfoListResult
-fullName: azure.synapse.artifacts.models.SqlPoolInfoListResult
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: List of SQL pools.
-constructor:
- syntax: 'SqlPoolInfoListResult(*, next_link: str | None = None, value: List[_models.SqlPool]
- | None = None, **kwargs: Any)'
- parameters:
- - name: next_link
- description: Link to the next page of results.
- types:
- - <xref:str>
- - name: value
- description: List of SQL pools.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.SqlPool>]
-variables:
-- description: Link to the next page of results.
- name: next_link
- types:
- - <xref:str>
-- description: List of SQL pools.
- name: value
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.SqlPool>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlPoolReference.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlPoolReference.yml
deleted file mode 100644
index d19957b3fea4..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlPoolReference.yml
+++ /dev/null
@@ -1,34 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SqlPoolReference
-name: SqlPoolReference
-fullName: azure.synapse.artifacts.models.SqlPoolReference
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'SQL pool reference type.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SqlPoolReference(*, type: str | _models.SqlPoolReferenceType, reference_name:
- str, **kwargs: Any)'
- parameters:
- - name: type
- description: SQL pool reference type. Required. "SqlPoolReference"
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SqlPoolReferenceType>
- - name: reference_name
- description: Reference SQL pool name. Required.
- types:
- - <xref:str>
-variables:
-- description: SQL pool reference type. Required. "SqlPoolReference"
- name: type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SqlPoolReferenceType>
-- description: Reference SQL pool name. Required.
- name: reference_name
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlPoolReferenceType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlPoolReferenceType.yml
deleted file mode 100644
index aa922e3cfc73..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlPoolReferenceType.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.SqlPoolReferenceType
-name: SqlPoolReferenceType
-fullName: azure.synapse.artifacts.models.SqlPoolReferenceType
-summary: SQL pool reference type.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: SqlPoolReferenceType(value, names=None, *, module=None, qualname=None, type=None,
- start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: SQL_POOL_REFERENCE
- uid: azure.synapse.artifacts.models.SqlPoolReferenceType.SQL_POOL_REFERENCE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlPoolStoredProcedureActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlPoolStoredProcedureActivity.yml
deleted file mode 100644
index ceda10084ee3..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlPoolStoredProcedureActivity.yml
+++ /dev/null
@@ -1,137 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SqlPoolStoredProcedureActivity
-name: SqlPoolStoredProcedureActivity
-fullName: azure.synapse.artifacts.models.SqlPoolStoredProcedureActivity
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.Activity
-summary: 'Execute SQL pool stored procedure activity.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SqlPoolStoredProcedureActivity(*, name: str, sql_pool: _models.SqlPoolReference,
- stored_procedure_name: MutableMapping[str, Any], additional_properties: Dict[str,
- MutableMapping[str, Any]] | None = None, description: str | None = None, state:
- str | _models.ActivityState | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs
- | None = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, stored_procedure_parameters: Dict[str,
- _models.StoredProcedureParameter] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: name
- description: Activity name. Required.
- types:
- - <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- - name: depends_on
- description: Activity depends on condition.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- - name: user_properties
- description: Activity user properties.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- - name: sql_pool
- description: SQL pool stored procedure reference. Required.
- types:
- - <xref:azure.synapse.artifacts.models.SqlPoolReference>
- - name: stored_procedure_name
- description: 'Stored procedure name. Type: string (or Expression with
-
- resultType string). Required.'
- types:
- - <xref:JSON>
- - name: stored_procedure_parameters
- description: 'Value and type setting for stored procedure parameters.
-
- Example: "{Parameter1: {value: "1", type: "int"}}".'
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.StoredProcedureParameter>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: SQL pool stored procedure reference. Required.
- name: sql_pool
- types:
- - <xref:azure.synapse.artifacts.models.SqlPoolReference>
-- description: 'Stored procedure name. Type: string (or Expression with resultType
-
- string). Required.'
- name: stored_procedure_name
- types:
- - <xref:JSON>
-- description: 'Value and type setting for stored procedure parameters.
-
- Example: "{Parameter1: {value: "1", type: "int"}}".'
- name: stored_procedure_parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.StoredProcedureParameter>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScript.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScript.yml
index 4f05836b0d45..6fbf0a77279c 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScript.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScript.yml
@@ -4,67 +4,41 @@ name: SqlScript
fullName: azure.synapse.artifacts.models.SqlScript
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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: _models.SqlScriptContent, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None,
- type: str | _models.SqlScriptType | None = None, folder: _models.SqlScriptFolder
- | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: description
description: The description of the SQL script.
+ isRequired: true
types:
- <xref:str>
- - name: type
- description: The type of the SQL script. "SqlQuery"
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SqlScriptType>
- name: content
- description: The content of the SQL script. Required.
+ description: Required. The content of the SQL script.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SqlScriptContent>
- - name: folder
- description: 'The folder that this SQL script is in. If not specified, this SQL
- script will
-
- appear at the root level.'
- types:
- - <xref:azure.synapse.artifacts.models.SqlScriptFolder>
variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The description of the SQL script.
- name: description
- types:
- - <xref:str>
-- description: The type of the SQL script. "SqlQuery"
+- description: 'The type of the SQL script. Default value: "SqlQuery".'
name: type
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.SqlScriptType>
-- description: The content of the SQL script. Required.
- name: content
- types:
- - <xref:azure.synapse.artifacts.models.SqlScriptContent>
-- description: 'The folder that this SQL script is in. If not specified, this SQL
- script will
-
- appear at the root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.SqlScriptFolder>
+attributes:
+- uid: azure.synapse.artifacts.models.SqlScript.type
+ name: type
+ signature: type = 'SqlQuery'
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptContent.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptContent.yml
index d1fe301a9f03..6e0752c05f4c 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptContent.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptContent.yml
@@ -4,59 +4,34 @@ name: SqlScriptContent
fullName: azure.synapse.artifacts.models.SqlScriptContent
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'The content of the SQL script.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SqlScriptContent(*, query: str, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, current_connection: _models.SqlConnection | None = None,
- result_limit: int | None = None, metadata: _models.SqlScriptMetadata | None =
- None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: query
- description: SQL query to execute. Required.
+ description: Required. SQL query to execute.
+ isRequired: true
types:
- <xref:str>
- name: current_connection
- description: The connection used to execute the SQL script.
+ description: Required. The connection used to execute the SQL script.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SqlConnection>
- - name: result_limit
- description: Limit of results, '-1' for no limit.
- types:
- - <xref:int>
- name: metadata
description: The metadata of the SQL script.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SqlScriptMetadata>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: SQL query to execute. Required.
- name: query
- types:
- - <xref:str>
-- description: The connection used to execute the SQL script.
- name: current_connection
- types:
- - <xref:azure.synapse.artifacts.models.SqlConnection>
-- description: Limit of results, '-1' for no limit.
- name: result_limit
- types:
- - <xref:int>
-- description: The metadata of the SQL script.
- name: metadata
- types:
- - <xref:azure.synapse.artifacts.models.SqlScriptMetadata>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptFolder.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptFolder.yml
deleted file mode 100644
index 92a792eeff48..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptFolder.yml
+++ /dev/null
@@ -1,23 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SqlScriptFolder
-name: SqlScriptFolder
-fullName: azure.synapse.artifacts.models.SqlScriptFolder
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'The folder that this SQL script is in. If not specified, this SQL script
- will appear at the
-
- root level.'
-constructor:
- syntax: 'SqlScriptFolder(*, name: str | None = None, **kwargs: Any)'
- parameters:
- - name: name
- description: The name of the folder that this SQL script is in.
- types:
- - <xref:str>
-variables:
-- description: The name of the folder that this SQL script is in.
- name: name
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptMetadata.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptMetadata.yml
index 25cc24d6d866..400c83e7aee2 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptMetadata.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptMetadata.yml
@@ -4,30 +4,21 @@ name: SqlScriptMetadata
fullName: azure.synapse.artifacts.models.SqlScriptMetadata
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: The metadata of the SQL script.
constructor:
- syntax: 'SqlScriptMetadata(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, language: str | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: language
description: The language of the SQL script.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The language of the SQL script.
- name: language
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptResource.yml
index bde9fff60508..bd98bf598943 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptResource.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptResource.yml
@@ -4,7 +4,7 @@ name: SqlScriptResource
fullName: azure.synapse.artifacts.models.SqlScriptResource
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- azure.synapse.artifacts.models._models_py3.SubResource
summary: 'Sql Script resource type.
@@ -13,39 +13,27 @@ summary: 'Sql Script resource type.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SqlScriptResource(*, name: str, properties: _models.SqlScript, **kwargs:
- Any)'
+ syntax: 'SqlScriptResource(*, properties: SqlScript, **kwargs)'
parameters:
- - name: name
- description: The name of the resource. Required.
- types:
- - <xref:str>
- name: properties
- description: Properties of sql script. Required.
+ description: Required. Properties of sql script.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SqlScript>
variables:
-- description: 'Fully qualified resource Id for the resource. Ex -
-
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.'
+- description: The resource identifier.
name: id
types:
- <xref:str>
-- description: The name of the resource. Required.
+- description: The resource name.
name: name
types:
- <xref:str>
-- description: 'The type of the resource. Ex- Microsoft.Compute/virtualMachines or
-
- Microsoft.Storage/storageAccounts.'
+- description: The resource type.
name: type
types:
- <xref:str>
-- description: Resource Etag.
+- description: Etag identifies change in the resource.
name: etag
types:
- <xref:str>
-- description: Properties of sql script. Required.
- name: properties
- types:
- - <xref:azure.synapse.artifacts.models.SqlScript>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptType.yml
deleted file mode 100644
index 672e198748c9..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptType.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.SqlScriptType
-name: SqlScriptType
-fullName: azure.synapse.artifacts.models.SqlScriptType
-summary: The type of the SQL script.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: SqlScriptType(value, names=None, *, module=None, qualname=None, type=None,
- start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: SQL_QUERY
- uid: azure.synapse.artifacts.models.SqlScriptType.SQL_QUERY
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptsListResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptsListResponse.yml
index 088f4224f15e..7cc5a6f3bae3 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptsListResponse.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptsListResponse.yml
@@ -4,29 +4,22 @@ name: SqlScriptsListResponse
fullName: azure.synapse.artifacts.models.SqlScriptsListResponse
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'A list of sql scripts resources.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SqlScriptsListResponse(*, value: List[_models.SqlScriptResource], next_link:
- str | None = None, **kwargs: Any)'
+ syntax: 'SqlScriptsListResponse(*, value: List[SqlScriptResource], next_link: str
+ | None = None, **kwargs)'
parameters:
- name: value
- description: List of sql scripts. Required.
+ description: Required. List of sql scripts.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.SqlScriptResource>]
- name: next_link
description: The link to the next page of results, if any remaining results exist.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: List of sql scripts. Required.
- name: value
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.SqlScriptResource>]
-- description: The link to the next page of results, if any remaining results exist.
- name: next_link
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerLinkedService.yml
index 2bd87ebbf8ab..abd759890b75 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerLinkedService.yml
@@ -10,120 +10,72 @@ summary: 'SQL Server linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SqlServerLinkedService(*, connection_string: MutableMapping[str, Any],
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, connect_via:
- _models.IntegrationRuntimeReference | None = None, description: str | None = None,
- parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations:
- List[MutableMapping[str, Any]] | None = None, user_name: MutableMapping[str, Any]
- | None = None, password: _models.SecretBase | None = None, encrypted_credential:
- MutableMapping[str, Any] | None = None, always_encrypted_settings: _models.SqlAlwaysEncryptedProperties
- | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
- description: 'The connection string. Type: string, SecureString or
+ description: 'Required. The connection string. Type: string, SecureString or
- AzureKeyVaultSecretReference. Required.'
+ AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: user_name
description: 'The on-premises Windows authentication user name. Type: string (or
+ Expression
- Expression with resultType string).'
+ with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: The on-premises Windows authentication password.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
- types:
- - <xref:JSON>
- - name: always_encrypted_settings
- description: Sql always encrypted properties.
+ resultType string).'
+ isRequired: true
types:
- - <xref:azure.synapse.artifacts.models.SqlAlwaysEncryptedProperties>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference. Required.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: 'The on-premises Windows authentication user name. Type: string (or
- Expression
-
- with resultType string).'
- name: user_name
- types:
- - <xref:JSON>
-- description: The on-premises Windows authentication password.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
-- description: Sql always encrypted properties.
- name: always_encrypted_settings
- types:
- - <xref:azure.synapse.artifacts.models.SqlAlwaysEncryptedProperties>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerSink.yml
deleted file mode 100644
index 6dd4d6c3d5e0..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerSink.yml
+++ /dev/null
@@ -1,170 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SqlServerSink
-name: SqlServerSink
-fullName: azure.synapse.artifacts.models.SqlServerSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity SQL server sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SqlServerSink(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, write_batch_size: MutableMapping[str, Any] | None = None, write_batch_timeout:
- MutableMapping[str, Any] | None = None, sink_retry_count: MutableMapping[str,
- Any] | None = None, sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, sql_writer_stored_procedure_name: MutableMapping[str,
- Any] | None = None, sql_writer_table_type: MutableMapping[str, Any] | None = None,
- pre_copy_script: MutableMapping[str, Any] | None = None, stored_procedure_parameters:
- Dict[str, _models.StoredProcedureParameter] | None = None, stored_procedure_table_type_parameter_name:
- MutableMapping[str, Any] | None = None, table_option: MutableMapping[str, Any]
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: sql_writer_stored_procedure_name
- description: 'SQL writer stored procedure name. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: sql_writer_table_type
- description: 'SQL writer table type. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: pre_copy_script
- description: 'SQL pre-copy script. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: stored_procedure_parameters
- description: SQL stored procedure parameters.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.StoredProcedureParameter>]
- - name: stored_procedure_table_type_parameter_name
- description: 'The stored procedure parameter name of the
-
- table type. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: table_option
- description: 'The option to handle sink table, such as autoCreate. For now only
-
- ''autoCreate'' value is supported. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'SQL writer stored procedure name. Type: string (or
-
- Expression with resultType string).'
- name: sql_writer_stored_procedure_name
- types:
- - <xref:JSON>
-- description: 'SQL writer table type. Type: string (or Expression with resultType
-
- string).'
- name: sql_writer_table_type
- types:
- - <xref:JSON>
-- description: 'SQL pre-copy script. Type: string (or Expression with resultType
-
- string).'
- name: pre_copy_script
- types:
- - <xref:JSON>
-- description: SQL stored procedure parameters.
- name: stored_procedure_parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.StoredProcedureParameter>]
-- description: 'The stored procedure parameter name of the
-
- table type. Type: string (or Expression with resultType string).'
- name: stored_procedure_table_type_parameter_name
- types:
- - <xref:JSON>
-- description: 'The option to handle sink table, such as autoCreate. For now only
-
- ''autoCreate'' value is supported. Type: string (or Expression with resultType
- string).'
- name: table_option
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerSource.yml
deleted file mode 100644
index a46576b9da68..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerSource.yml
+++ /dev/null
@@ -1,188 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SqlServerSource
-name: SqlServerSource
-fullName: azure.synapse.artifacts.models.SqlServerSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity SQL server source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SqlServerSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, sql_reader_query:
- MutableMapping[str, Any] | None = None, sql_reader_stored_procedure_name: MutableMapping[str,
- Any] | None = None, stored_procedure_parameters: Dict[str, _models.StoredProcedureParameter]
- | None = None, isolation_level: MutableMapping[str, Any] | None = None, produce_additional_types:
- MutableMapping[str, Any] | None = None, partition_option: MutableMapping[str,
- Any] | None = None, partition_settings: _models.SqlPartitionSettings | None =
- None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: sql_reader_query
- description: 'SQL reader query. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: sql_reader_stored_procedure_name
- description: 'Name of the stored procedure for a SQL Database
-
- source. This cannot be used at the same time as SqlReaderQuery. Type: string
- (or Expression
-
- with resultType string).'
- types:
- - <xref:JSON>
- - name: stored_procedure_parameters
- description: 'Value and type setting for stored procedure parameters.
-
- Example: "{Parameter1: {value: "1", type: "int"}}".'
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.StoredProcedureParameter>]
- - name: isolation_level
- description: 'Specifies the transaction locking behavior for the SQL source.
-
- Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot.
- The default
-
- value is ReadCommitted. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: produce_additional_types
- description: Which additional types to produce.
- types:
- - <xref:JSON>
- - name: partition_option
- description: 'The partition mechanism that will be used for Sql read in parallel.
-
- Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".'
- types:
- - <xref:JSON>
- - name: partition_settings
- description: The settings that will be leveraged for Sql source partitioning.
- types:
- - <xref:azure.synapse.artifacts.models.SqlPartitionSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'SQL reader query. Type: string (or Expression with resultType string).'
- name: sql_reader_query
- types:
- - <xref:JSON>
-- description: 'Name of the stored procedure for a SQL Database source.
-
- This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression
- with
-
- resultType string).'
- name: sql_reader_stored_procedure_name
- types:
- - <xref:JSON>
-- description: 'Value and type setting for stored procedure parameters.
-
- Example: "{Parameter1: {value: "1", type: "int"}}".'
- name: stored_procedure_parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.StoredProcedureParameter>]
-- description: 'Specifies the transaction locking behavior for the SQL source. Allowed
-
- values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The
- default value
-
- is ReadCommitted. Type: string (or Expression with resultType string).'
- name: isolation_level
- types:
- - <xref:JSON>
-- description: Which additional types to produce.
- name: produce_additional_types
- types:
- - <xref:JSON>
-- description: 'The partition mechanism that will be used for Sql read in parallel.
-
- Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".'
- name: partition_option
- types:
- - <xref:JSON>
-- description: The settings that will be leveraged for Sql source partitioning.
- name: partition_settings
- types:
- - <xref:azure.synapse.artifacts.models.SqlPartitionSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerStoredProcedureActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerStoredProcedureActivity.yml
index 775141e516bd..5dbb9266d827 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerStoredProcedureActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerStoredProcedureActivity.yml
@@ -10,137 +10,66 @@ 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: MutableMapping[str,
- Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- description: str | None = None, state: str | _models.ActivityState | None = None,
- on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None = None, depends_on:
- List[_models.ActivityDependency] | None = None, user_properties: List[_models.UserProperty]
- | None = None, linked_service_name: _models.LinkedServiceReference | None = None,
- policy: _models.ActivityPolicy | None = None, stored_procedure_parameters: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
- name: stored_procedure_name
- description: 'Stored procedure name. Type: string (or Expression with
+ description: 'Required. Stored procedure name. Type: string (or Expression with
- resultType string). Required.'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: stored_procedure_parameters
description: 'Value and type setting for stored procedure parameters.
Example: "{Parameter1: {value: "1", type: "int"}}".'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: 'Stored procedure name. Type: string (or Expression with resultType
-
- string). Required.'
- name: stored_procedure_name
- types:
- - <xref:JSON>
-- description: 'Value and type setting for stored procedure parameters.
-
- Example: "{Parameter1: {value: "1", type: "int"}}".'
- name: stored_procedure_parameters
- types:
- - <xref:JSON>
+ - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.StoredProcedureParameter>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerTableDataset.yml
index f33165d831a5..9f42cbc7fe2b 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerTableDataset.yml
@@ -10,140 +10,88 @@ 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: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, schema_type_properties_schema: MutableMapping[str, Any] | None = None,
- table: MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'This property will be retired. Please consider using schema + table
properties instead.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: schema_type_properties_schema
description: 'The schema name of the SQL Server dataset. Type: string
(or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: table
description: 'The table name of the SQL Server dataset. Type: string (or Expression
with
resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'This property will be retired. Please consider using schema + table
-
- properties instead.'
- name: table_name
- types:
- - <xref:JSON>
-- description: 'The schema name of the SQL Server dataset. Type: string
-
- (or Expression with resultType string).'
- name: schema_type_properties_schema
- types:
- - <xref:JSON>
-- description: 'The table name of the SQL Server dataset. Type: string (or Expression
- with
-
- resultType string).'
- name: table
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlSink.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlSink.yml
deleted file mode 100644
index 82c317fab97d..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlSink.yml
+++ /dev/null
@@ -1,170 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SqlSink
-name: SqlSink
-fullName: azure.synapse.artifacts.models.SqlSink
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySink
-summary: 'A copy activity SQL sink.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SqlSink(*, additional_properties: Dict[str, MutableMapping[str, Any]] |
- None = None, write_batch_size: MutableMapping[str, Any] | None = None, write_batch_timeout:
- MutableMapping[str, Any] | None = None, sink_retry_count: MutableMapping[str,
- Any] | None = None, sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, sql_writer_stored_procedure_name: MutableMapping[str,
- Any] | None = None, sql_writer_table_type: MutableMapping[str, Any] | None = None,
- pre_copy_script: MutableMapping[str, Any] | None = None, stored_procedure_parameters:
- Dict[str, _models.StoredProcedureParameter] | None = None, stored_procedure_table_type_parameter_name:
- MutableMapping[str, Any] | None = None, table_option: MutableMapping[str, Any]
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: write_batch_size
- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: sink_retry_count
- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: sql_writer_stored_procedure_name
- description: 'SQL writer stored procedure name. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: sql_writer_table_type
- description: 'SQL writer table type. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: pre_copy_script
- description: 'SQL pre-copy script. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: stored_procedure_parameters
- description: SQL stored procedure parameters.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.StoredProcedureParameter>]
- - name: stored_procedure_table_type_parameter_name
- description: 'The stored procedure parameter name of the
-
- table type. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: table_option
- description: 'The option to handle sink table, such as autoCreate. For now only
-
- ''autoCreate'' value is supported. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy sink type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Write batch size. Type: integer (or Expression with resultType
-
- integer), minimum: 0.'
- name: write_batch_size
- types:
- - <xref:JSON>
-- description: 'Write batch timeout. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: write_batch_timeout
- types:
- - <xref:JSON>
-- description: 'Sink retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: sink_retry_count
- types:
- - <xref:JSON>
-- description: 'Sink retry wait. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: sink_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the sink data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'SQL writer stored procedure name. Type: string (or
-
- Expression with resultType string).'
- name: sql_writer_stored_procedure_name
- types:
- - <xref:JSON>
-- description: 'SQL writer table type. Type: string (or Expression with resultType
-
- string).'
- name: sql_writer_table_type
- types:
- - <xref:JSON>
-- description: 'SQL pre-copy script. Type: string (or Expression with resultType
-
- string).'
- name: pre_copy_script
- types:
- - <xref:JSON>
-- description: SQL stored procedure parameters.
- name: stored_procedure_parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.StoredProcedureParameter>]
-- description: 'The stored procedure parameter name of the
-
- table type. Type: string (or Expression with resultType string).'
- name: stored_procedure_table_type_parameter_name
- types:
- - <xref:JSON>
-- description: 'The option to handle sink table, such as autoCreate. For now only
-
- ''autoCreate'' value is supported. Type: string (or Expression with resultType
- string).'
- name: table_option
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlSource.yml
deleted file mode 100644
index f624b89066ab..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlSource.yml
+++ /dev/null
@@ -1,179 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SqlSource
-name: SqlSource
-fullName: azure.synapse.artifacts.models.SqlSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity SQL source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SqlSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, sql_reader_query: MutableMapping[str,
- Any] | None = None, sql_reader_stored_procedure_name: MutableMapping[str, Any]
- | None = None, stored_procedure_parameters: Dict[str, _models.StoredProcedureParameter]
- | None = None, isolation_level: MutableMapping[str, Any] | None = None, partition_option:
- MutableMapping[str, Any] | None = None, partition_settings: _models.SqlPartitionSettings
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: sql_reader_query
- description: 'SQL reader query. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: sql_reader_stored_procedure_name
- description: 'Name of the stored procedure for a SQL Database
-
- source. This cannot be used at the same time as SqlReaderQuery. Type: string
- (or Expression
-
- with resultType string).'
- types:
- - <xref:JSON>
- - name: stored_procedure_parameters
- description: 'Value and type setting for stored procedure parameters.
-
- Example: "{Parameter1: {value: "1", type: "int"}}".'
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.StoredProcedureParameter>]
- - name: isolation_level
- description: 'Specifies the transaction locking behavior for the SQL source.
-
- Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot.
- The default
-
- value is ReadCommitted. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: partition_option
- description: 'The partition mechanism that will be used for Sql read in parallel.
-
- Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".'
- types:
- - <xref:JSON>
- - name: partition_settings
- description: The settings that will be leveraged for Sql source partitioning.
- types:
- - <xref:azure.synapse.artifacts.models.SqlPartitionSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'SQL reader query. Type: string (or Expression with resultType string).'
- name: sql_reader_query
- types:
- - <xref:JSON>
-- description: 'Name of the stored procedure for a SQL Database source.
-
- This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression
- with
-
- resultType string).'
- name: sql_reader_stored_procedure_name
- types:
- - <xref:JSON>
-- description: 'Value and type setting for stored procedure parameters.
-
- Example: "{Parameter1: {value: "1", type: "int"}}".'
- name: stored_procedure_parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.StoredProcedureParameter>]
-- description: 'Specifies the transaction locking behavior for the SQL source. Allowed
-
- values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The
- default value
-
- is ReadCommitted. Type: string (or Expression with resultType string).'
- name: isolation_level
- types:
- - <xref:JSON>
-- description: 'The partition mechanism that will be used for Sql read in parallel.
-
- Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".'
- name: partition_option
- types:
- - <xref:JSON>
-- description: The settings that will be leveraged for Sql source partitioning.
- name: partition_settings
- types:
- - <xref:azure.synapse.artifacts.models.SqlPartitionSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareLinkedService.yml
index 298741878154..80bbd65522c9 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareLinkedService.yml
@@ -10,69 +10,75 @@ summary: 'Square Service linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SquareLinkedService(*, host: MutableMapping[str, Any], client_id: MutableMapping[str,
- Any], redirect_uri: MutableMapping[str, Any], additional_properties: Dict[str,
- MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, connection_properties:
- MutableMapping[str, Any] | None = None, client_secret: _models.SecretBase | None
- = None, use_encrypted_endpoints: MutableMapping[str, Any] | None = None, use_host_verification:
- MutableMapping[str, Any] | None = None, use_peer_verification: MutableMapping[str,
- Any] | None = None, encrypted_credential: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
- - name: connection_properties
- description: 'Properties used to connect to Square. It is mutually exclusive
-
- with any other properties in the linked service. Type: object.'
- types:
- - <xref:JSON>
+ - <xref:list>[<xref:object>]
- name: host
- description: "The URL\_of the Square instance. (i.e. mystore.mysquare.com). Required."
+ description: "Required. The URL\_of the Square instance. (i.e. mystore.mysquare.com)."
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: client_id
- description: The client ID associated with your Square application. Required.
+ description: Required. The client ID associated with your Square application.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: client_secret
description: The client secret associated with your Square application.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: redirect_uri
- description: 'The redirect URL assigned in the Square application dashboard. (i.e.
+ description: 'Required. The redirect URL assigned in the Square application dashboard.
- [http://localhost:2500](http://localhost:2500)). Required.'
+ (i.e. [http://localhost:2500](http://localhost:2500)).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_encrypted_endpoints
- description: 'Specifies whether the data source endpoints are encrypted
+ description: 'Specifies whether the data source endpoints are encrypted using
- using HTTPS. The default value is true.'
+ HTTPS. The default value is true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_host_verification
description: 'Specifies whether to require the host name in the server''s
@@ -80,101 +86,23 @@ constructor:
default value is
true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Properties used to connect to Square. It is mutually exclusive
-
- with any other properties in the linked service. Type: object.'
- name: connection_properties
- types:
- - <xref:JSON>
-- description: "The URL\_of the Square instance. (i.e. mystore.mysquare.com). Required."
- name: host
- types:
- - <xref:JSON>
-- description: The client ID associated with your Square application. Required.
- name: client_id
- types:
- - <xref:JSON>
-- description: The client secret associated with your Square application.
- name: client_secret
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The redirect URL assigned in the Square application dashboard. (i.e.
-
- [http://localhost:2500](http://localhost:2500)). Required.'
- name: redirect_uri
- types:
- - <xref:JSON>
-- description: 'Specifies whether the data source endpoints are encrypted using
-
- HTTPS. The default value is true.'
- name: use_encrypted_endpoints
- types:
- - <xref:JSON>
-- 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.'
- name: use_host_verification
- types:
- - <xref:JSON>
-- description: 'Specifies whether to verify the identity of the server when
-
- connecting over SSL. The default value is true.'
- name: use_peer_verification
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareObjectDataset.yml
index a5e0404747ec..2772aebd678f 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareObjectDataset.yml
@@ -10,109 +10,70 @@ summary: 'Square Service dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SquareObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The table name. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareSource.yml
deleted file mode 100644
index 5d6173b7a7d2..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SquareSource
-name: SquareSource
-fullName: azure.synapse.artifacts.models.SquareSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Square Service source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SquareSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SsisLogLocationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SsisLogLocationType.yml
deleted file mode 100644
index f882dad47f79..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SsisLogLocationType.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.SsisLogLocationType
-name: SsisLogLocationType
-fullName: azure.synapse.artifacts.models.SsisLogLocationType
-summary: The type of SSIS log location.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: SsisLogLocationType(value, names=None, *, module=None, qualname=None, type=None,
- start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: FILE
- uid: azure.synapse.artifacts.models.SsisLogLocationType.FILE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse.yml
index d5d0c45f84a2..ca06863dd643 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse.yml
@@ -4,43 +4,29 @@ name: SsisObjectMetadataStatusResponse
fullName: azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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:
- Any)'
+ | None = None, properties: str | None = None, error: str | None = None, **kwargs)'
parameters:
- name: status
description: The status of the operation.
+ isRequired: true
types:
- <xref:str>
- name: name
description: The operation name.
+ isRequired: true
types:
- <xref:str>
- name: properties
description: The operation properties.
+ isRequired: true
types:
- <xref:str>
- name: error
description: The operation error message.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: The status of the operation.
- name: status
- types:
- - <xref:str>
-- description: The operation name.
- name: name
- types:
- - <xref:str>
-- description: The operation properties.
- name: properties
- types:
- - <xref:str>
-- description: The operation error message.
- name: error
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SsisPackageLocationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SsisPackageLocationType.yml
index 3141858cc100..f47ec72ee05e 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SsisPackageLocationType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SsisPackageLocationType.yml
@@ -11,11 +11,9 @@ inheritances:
- builtins.str
- enum.Enum
fields:
-- name: FILE
- uid: azure.synapse.artifacts.models.SsisPackageLocationType.FILE
-- name: INLINE_PACKAGE
- uid: azure.synapse.artifacts.models.SsisPackageLocationType.INLINE_PACKAGE
-- name: PACKAGE_STORE
- uid: azure.synapse.artifacts.models.SsisPackageLocationType.PACKAGE_STORE
-- name: SSISDB
- uid: azure.synapse.artifacts.models.SsisPackageLocationType.SSISDB
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StagingSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StagingSettings.yml
index 5502fa92e45c..0d68eea25b4a 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StagingSettings.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StagingSettings.yml
@@ -4,63 +4,41 @@ name: StagingSettings
fullName: azure.synapse.artifacts.models.StagingSettings
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'Staging settings.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'StagingSettings(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, path:
- MutableMapping[str, Any] | None = None, enable_compression: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: linked_service_name
- description: Staging linked service reference. Required.
+ description: Required. Staging linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: path
description: 'The path to storage for storing the interim data. Type: string (or
- Expression
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Staging linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: 'The path to storage for storing the interim data. Type: string (or
- Expression with
-
- resultType string).'
- name: path
- types:
- - <xref:JSON>
-- description: 'Specifies whether to use compression when copying data via an interim
-
- staging. Default value is false. Type: boolean (or Expression with resultType
- boolean).'
- name: enable_compression
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest.yml
index ab238f088ec3..236f5a43ce1b 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest.yml
@@ -4,78 +4,47 @@ name: StartDataFlowDebugSessionRequest
fullName: azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: Request body structure for starting data flow debug session.
constructor:
syntax: 'StartDataFlowDebugSessionRequest(*, session_id: str | None = None, data_flow:
- _models.DataFlowResource | None = None, data_flows: List[_models.DataFlowResource]
- | None = None, datasets: List[_models.DatasetResource] | None = None, linked_services:
- List[_models.LinkedServiceResource] | None = None, staging: MutableMapping[str,
- Any] | None = None, debug_settings: MutableMapping[str, Any] | None = None, incremental_debug:
- bool | None = None, **kwargs: Any)'
+ 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:
- <xref:str>
- name: data_flow
description: Data flow instance.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DataFlowResource>
- - name: data_flows
- description: List of Data flows.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DataFlowResource>]
- name: datasets
description: List of datasets.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.DatasetResource>]
- name: linked_services
description: List of linked services.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.LinkedServiceResource>]
- name: staging
description: Staging info for debug session.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: debug_settings
description: Data flow debug settings.
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: incremental_debug
description: The type of new Databricks cluster.
+ isRequired: true
types:
- <xref:bool>
-variables:
-- description: The ID of data flow debug session.
- name: session_id
- types:
- - <xref:str>
-- description: Data flow instance.
- name: data_flow
- types:
- - <xref:azure.synapse.artifacts.models.DataFlowResource>
-- description: List of Data flows.
- name: data_flows
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DataFlowResource>]
-- description: List of datasets.
- name: datasets
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DatasetResource>]
-- description: List of linked services.
- name: linked_services
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.LinkedServiceResource>]
-- description: Staging info for debug session.
- name: staging
- types:
- - <xref:JSON>
-- description: Data flow debug settings.
- name: debug_settings
- types:
- - <xref:JSON>
-- description: The type of new Databricks cluster.
- name: incremental_debug
- types:
- - <xref:bool>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse.yml
index 72fb265e7785..1942cbd58340 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse.yml
@@ -4,18 +4,13 @@ name: StartDataFlowDebugSessionResponse
fullName: azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: Response body structure for starting data flow debug session.
constructor:
- syntax: 'StartDataFlowDebugSessionResponse(*, job_version: str | None = None, **kwargs:
- Any)'
+ syntax: 'StartDataFlowDebugSessionResponse(*, job_version: str | None = None, **kwargs)'
parameters:
- name: job_version
description: The ID of data flow debug job version.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: The ID of data flow debug job version.
- name: job_version
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoreReadSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoreReadSettings.yml
deleted file mode 100644
index b9aa5f8ef162..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoreReadSettings.yml
+++ /dev/null
@@ -1,57 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.StoreReadSettings
-name: StoreReadSettings
-fullName: azure.synapse.artifacts.models.StoreReadSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Connector read setting.
-
-
- You probably want to use the sub-classes and not this class directly. Known sub-classes
- are:
-
- AmazonS3ReadSettings, AzureBlobFSReadSettings, AzureBlobStorageReadSettings,
-
- AzureDataLakeStoreReadSettings, AzureFileStorageReadSettings, FileServerReadSettings,
-
- FtpReadSettings, GoogleCloudStorageReadSettings, HdfsReadSettings, HttpReadSettings,
-
- SftpReadSettings
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'StoreReadSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The read setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoreWriteSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoreWriteSettings.yml
deleted file mode 100644
index 88cc0a15b867..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoreWriteSettings.yml
+++ /dev/null
@@ -1,61 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.StoreWriteSettings
-name: StoreWriteSettings
-fullName: azure.synapse.artifacts.models.StoreWriteSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Connector write settings.
-
-
- You probably want to use the sub-classes and not this class directly. Known sub-classes
- are:
-
- AzureBlobFSWriteSettings, AzureBlobStorageWriteSettings, AzureDataLakeStoreWriteSettings,
-
- AzureFileStorageWriteSettings, FileServerWriteSettings, SftpWriteSettings
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'StoreWriteSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None
- = None, copy_behavior: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: copy_behavior
- description: The type of copy behavior for copy sink.
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The write setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: The type of copy behavior for copy sink.
- name: copy_behavior
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoredProcedureParameter.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoredProcedureParameter.yml
index fd99cbc6eee5..fa505171d0f2 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoredProcedureParameter.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoredProcedureParameter.yml
@@ -4,40 +4,26 @@ name: StoredProcedureParameter
fullName: azure.synapse.artifacts.models.StoredProcedureParameter
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: SQL stored procedure parameter.
constructor:
- syntax: 'StoredProcedureParameter(*, value: MutableMapping[str, Any] | None = None,
- type: str | _models.StoredProcedureParameterType | None = None, **kwargs: Any)'
+ 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:
- - <xref:JSON>
+ - <xref:object>
- name: type
- description: 'Stored procedure parameter type. Known values are: "String", "Int",
- "Int64",
+ description: 'Stored procedure parameter type. Possible values include: "String",
+ "Int",
- "Decimal", "Guid", "Boolean", and "Date".'
+ "Int64", "Decimal", "Guid", "Boolean", "Date".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.StoredProcedureParameterType>
-variables:
-- description: 'Stored procedure parameter value. Type: string (or Expression with
- resultType
-
- string).'
- name: value
- types:
- - <xref:JSON>
-- description: 'Stored procedure parameter type. Known values are: "String", "Int",
- "Int64",
-
- "Decimal", "Guid", "Boolean", and "Date".'
- name: type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.StoredProcedureParameterType>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoredProcedureParameterType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoredProcedureParameterType.yml
index 52157262c9f8..48b03a9faa38 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoredProcedureParameterType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoredProcedureParameterType.yml
@@ -11,17 +11,17 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SubResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SubResource.yml
index 17c41d625c3d..a4f1a6ba8762 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SubResource.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SubResource.yml
@@ -4,32 +4,27 @@ name: SubResource
fullName: azure.synapse.artifacts.models.SubResource
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts.models._models_py3.AzureEntityResource
+- msrest.serialization.Model
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: Any)'
+ syntax: SubResource(**kwargs)
variables:
-- description: 'Fully qualified resource ID for the resource. Ex -
-
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.'
+- description: The resource identifier.
name: id
types:
- <xref:str>
-- description: The name of the resource.
+- description: The resource name.
name: name
types:
- <xref:str>
-- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines"
- or
-
- "Microsoft.Storage/storageAccounts".'
+- description: The resource type.
name: type
types:
- <xref:str>
-- description: Resource Etag.
+- description: Etag identifies change in the resource.
name: etag
types:
- <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SubResourceDebugResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SubResourceDebugResource.yml
index 9f9f013ca8bf..96fbf03406c8 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SubResourceDebugResource.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SubResourceDebugResource.yml
@@ -4,17 +4,13 @@ name: SubResourceDebugResource
fullName: azure.synapse.artifacts.models.SubResourceDebugResource
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: Azure Synapse nested debug resource.
constructor:
- syntax: 'SubResourceDebugResource(*, name: str | None = None, **kwargs: Any)'
+ syntax: 'SubResourceDebugResource(*, name: str | None = None, **kwargs)'
parameters:
- name: name
description: The resource name.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: The resource name.
- name: name
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchActivity.yml
index 2d2209aea17c..6606bddd0759 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchActivity.yml
@@ -4,77 +4,68 @@ name: SwitchActivity
fullName: azure.synapse.artifacts.models.SwitchActivity
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts.models._models_py3.ControlActivity
+- azure.synapse.artifacts.models._models_py3.Activity
summary: 'This activity evaluates an expression and executes activities under the
- cases property that
-
- correspond to the expression evaluation expected in the equals property.
+ 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: _models.Expression, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None,
- state: str | _models.ActivityState | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs
- | None = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, cases: List[_models.SwitchCase] | None
- = None, default_activities: List[_models.Activity] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: 'on'
- description: 'An expression that would evaluate to a string or integer. This is
- used to
+ 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. Required.'
+ determine the block of activities in cases that will be executed.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.Expression>
- name: cases
description: 'List of cases that correspond to expected values of the ''on'' property.
- This is
+ This is an
- an optional property and if not provided, the activity will execute activities
+ optional property and if not provided, the activity will execute activities
provided in
defaultActivities.'
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.SwitchCase>]
- name: default_activities
@@ -82,74 +73,6 @@ constructor:
This is an optional property and if not provided, the activity will exit without
any action.'
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.Activity>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: '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. Required.'
- name: 'on'
- types:
- - <xref:azure.synapse.artifacts.models.Expression>
-- 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.'
- name: cases
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.SwitchCase>]
-- 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.'
- name: default_activities
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.Activity>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchCase.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchCase.yml
index 72a66331ed03..58b7fe84fb6d 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchCase.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchCase.yml
@@ -4,26 +4,19 @@ name: SwitchCase
fullName: azure.synapse.artifacts.models.SwitchCase
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: Switch cases with have a value and corresponding activities.
constructor:
- syntax: 'SwitchCase(*, value: str | None = None, activities: List[_models.Activity]
- | None = None, **kwargs: Any)'
+ 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:
- <xref:str>
- name: activities
description: List of activities to execute for satisfied case condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.Activity>]
-variables:
-- description: Expected value that satisfies the expression result of the 'on' property.
- name: value
- types:
- - <xref:str>
-- description: List of activities to execute for satisfied case condition.
- name: activities
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.Activity>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseAuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseAuthenticationType.yml
index 5d6a8fa8df09..f94abf115734 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseAuthenticationType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseAuthenticationType.yml
@@ -11,7 +11,7 @@ inheritances:
- builtins.str
- enum.Enum
fields:
-- name: BASIC
- uid: azure.synapse.artifacts.models.SybaseAuthenticationType.BASIC
-- name: WINDOWS
- uid: azure.synapse.artifacts.models.SybaseAuthenticationType.WINDOWS
+- name: basic
+ uid: azure.synapse.artifacts.models.SybaseAuthenticationType.basic
+- name: windows
+ uid: azure.synapse.artifacts.models.SybaseAuthenticationType.windows
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseLinkedService.yml
index 2c725267d83e..f7efd7b0a445 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseLinkedService.yml
@@ -10,60 +10,73 @@ summary: 'Linked service for Sybase data source.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SybaseLinkedService(*, server: MutableMapping[str, Any], database: MutableMapping[str,
- Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- connect_via: _models.IntegrationRuntimeReference | None = None, description: str
- | None = None, parameters: Dict[str, _models.ParameterSpecification] | None =
- None, annotations: List[MutableMapping[str, Any]] | None = None, schema: MutableMapping[str,
- Any] | None = None, authentication_type: str | _models.SybaseAuthenticationType
- | None = None, username: MutableMapping[str, Any] | None = None, password: _models.SecretBase
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: server
- description: 'Server name for connection. Type: string (or Expression with resultType
+ description: 'Required. Server name for connection. Type: string (or Expression
+ with
- string). Required.'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: database
- description: 'Database name for connection. Type: string (or Expression with resultType
+ description: 'Required. Database name for connection. Type: string (or Expression
+ with
- string). Required.'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: schema
description: 'Schema name for connection. Type: string (or Expression with resultType
-
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: authentication_type
- description: 'AuthenticationType to be used for connection. Known values are:
+ description: 'AuthenticationType to be used for connection. Possible values
- "Basic" and "Windows".'
+ include: "Basic", "Windows".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.SybaseAuthenticationType>
@@ -71,89 +84,21 @@ constructor:
description: 'Username for authentication. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: Password for authentication.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Server name for connection. Type: string (or Expression with resultType
- string).
-
- Required.'
- name: server
- types:
- - <xref:JSON>
-- description: 'Database name for connection. Type: string (or Expression with resultType
-
- string). Required.'
- name: database
- types:
- - <xref:JSON>
-- description: 'Schema name for connection. Type: string (or Expression with resultType
- string).'
- name: schema
- types:
- - <xref:JSON>
-- description: 'AuthenticationType to be used for connection. Known values are:
-
- "Basic" and "Windows".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SybaseAuthenticationType>
-- description: 'Username for authentication. Type: string (or Expression with resultType
-
- string).'
- name: username
- types:
- - <xref:JSON>
-- description: Password for authentication.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseSource.yml
deleted file mode 100644
index 0f9ab1a139ac..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseSource.yml
+++ /dev/null
@@ -1,105 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SybaseSource
-name: SybaseSource
-fullName: azure.synapse.artifacts.models.SybaseSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity source for Sybase databases.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SybaseSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'Database query. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'Database query. Type: string (or Expression with resultType string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseTableDataset.yml
index 416b3b5136ea..78f609efc090 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseTableDataset.yml
@@ -10,112 +10,71 @@ summary: 'The Sybase table dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'SybaseTableDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The Sybase table name. Type: string (or Expression with resultType
-
string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The Sybase table name. Type: string (or Expression with resultType
- string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SynapseNotebookActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SynapseNotebookActivity.yml
deleted file mode 100644
index 7731cd5e525a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SynapseNotebookActivity.yml
+++ /dev/null
@@ -1,262 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SynapseNotebookActivity
-name: SynapseNotebookActivity
-fullName: azure.synapse.artifacts.models.SynapseNotebookActivity
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.ExecutionActivity
-summary: 'Execute Synapse notebook activity.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SynapseNotebookActivity(*, name: str, notebook: _models.SynapseNotebookReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, state: str | _models.ActivityState | None = None, on_inactive_mark_as:
- str | _models.ActivityOnInactiveMarkAs | None = None, depends_on: List[_models.ActivityDependency]
- | None = None, user_properties: List[_models.UserProperty] | None = None, linked_service_name:
- _models.LinkedServiceReference | None = None, policy: _models.ActivityPolicy |
- None = None, spark_pool: _models.BigDataPoolParametrizationReference | None =
- None, parameters: Dict[str, _models.NotebookParameter] | None = None, executor_size:
- MutableMapping[str, Any] | None = None, conf: MutableMapping[str, Any] | None
- = None, driver_size: MutableMapping[str, Any] | None = None, num_executors: MutableMapping[str,
- Any] | None = None, configuration_type: str | _models.ConfigurationType | None
- = None, target_spark_configuration: _models.SparkConfigurationParametrizationReference
- | None = None, spark_config: Dict[str, MutableMapping[str, Any]] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: name
- description: Activity name. Required.
- types:
- - <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- - name: depends_on
- description: Activity depends on condition.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- - name: user_properties
- description: Activity user properties.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- - name: linked_service_name
- description: Linked service reference.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: policy
- description: Activity policy.
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
- - name: notebook
- description: Synapse notebook reference. Required.
- types:
- - <xref:azure.synapse.artifacts.models.SynapseNotebookReference>
- - name: spark_pool
- description: The name of the big data pool which will be used to execute the notebook.
- types:
- - <xref:azure.synapse.artifacts.models.BigDataPoolParametrizationReference>
- - name: parameters
- description: Notebook parameters.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.NotebookParameter>]
- - name: executor_size
- description: 'Number of core and memory to be used for executors allocated in
- the
-
- specified Spark pool for the session, which will be used for overriding ''executorCores''
- and
-
- ''executorMemory'' of the notebook you provide. Type: string (or Expression
- with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: conf
- description: 'Spark configuration properties, which will override the ''conf''
- of the notebook
-
- you provide.'
- types:
- - <xref:JSON>
- - name: driver_size
- description: 'Number of core and memory to be used for driver allocated in the
-
- specified Spark pool for the session, which will be used for overriding ''driverCores''
- and
-
- ''driverMemory'' of the notebook you provide. Type: string (or Expression with
- resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: num_executors
- description: 'Number of executors to launch for this session, which will override
- the
-
- ''numExecutors'' of the notebook you provide. Type: integer (or Expression with
- resultType
-
- integer).'
- types:
- - <xref:JSON>
- - name: configuration_type
- description: 'The type of the spark config. Known values are: "Default",
-
- "Customized", and "Artifact".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ConfigurationType>
- - name: target_spark_configuration
- description: The spark configuration of the spark job.
- types:
- - <xref:azure.synapse.artifacts.models.SparkConfigurationParametrizationReference>
- - name: spark_config
- description: Spark configuration property.
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: Synapse notebook reference. Required.
- name: notebook
- types:
- - <xref:azure.synapse.artifacts.models.SynapseNotebookReference>
-- description: The name of the big data pool which will be used to execute the notebook.
- name: spark_pool
- types:
- - <xref:azure.synapse.artifacts.models.BigDataPoolParametrizationReference>
-- description: Notebook parameters.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.NotebookParameter>]
-- description: 'Number of core and memory to be used for executors allocated in the
-
- specified Spark pool for the session, which will be used for overriding ''executorCores''
- and
-
- ''executorMemory'' of the notebook you provide. Type: string (or Expression with
- resultType
-
- string).'
- name: executor_size
- types:
- - <xref:JSON>
-- description: 'Spark configuration properties, which will override the ''conf'' of
- the notebook you
-
- provide.'
- name: conf
- types:
- - <xref:JSON>
-- description: 'Number of core and memory to be used for driver allocated in the specified
-
- Spark pool for the session, which will be used for overriding ''driverCores''
- and ''driverMemory''
-
- of the notebook you provide. Type: string (or Expression with resultType string).'
- name: driver_size
- types:
- - <xref:JSON>
-- description: 'Number of executors to launch for this session, which will override
- the
-
- ''numExecutors'' of the notebook you provide. Type: integer (or Expression with
- resultType
-
- integer).'
- name: num_executors
- types:
- - <xref:JSON>
-- description: 'The type of the spark config. Known values are: "Default",
-
- "Customized", and "Artifact".'
- name: configuration_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ConfigurationType>
-- description: The spark configuration of the spark job.
- name: target_spark_configuration
- types:
- - <xref:azure.synapse.artifacts.models.SparkConfigurationParametrizationReference>
-- description: Spark configuration property.
- name: spark_config
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SynapseNotebookReference.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SynapseNotebookReference.yml
deleted file mode 100644
index d75b876bee4e..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SynapseNotebookReference.yml
+++ /dev/null
@@ -1,38 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SynapseNotebookReference
-name: SynapseNotebookReference
-fullName: azure.synapse.artifacts.models.SynapseNotebookReference
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Synapse notebook reference type.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SynapseNotebookReference(*, type: str | _models.NotebookReferenceType,
- reference_name: MutableMapping[str, Any], **kwargs: Any)'
- parameters:
- - name: type
- description: Synapse notebook reference type. Required. "NotebookReference"
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.NotebookReferenceType>
- - name: reference_name
- description: 'Reference notebook name. Type: string (or Expression with resultType
-
- string). Required.'
- types:
- - <xref:JSON>
-variables:
-- description: Synapse notebook reference type. Required. "NotebookReference"
- name: type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.NotebookReferenceType>
-- description: 'Reference notebook name. Type: string (or Expression with resultType
-
- string). Required.'
- name: reference_name
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SynapseSparkJobDefinitionActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SynapseSparkJobDefinitionActivity.yml
deleted file mode 100644
index 8b4c47819ae7..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SynapseSparkJobDefinitionActivity.yml
+++ /dev/null
@@ -1,383 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SynapseSparkJobDefinitionActivity
-name: SynapseSparkJobDefinitionActivity
-fullName: azure.synapse.artifacts.models.SynapseSparkJobDefinitionActivity
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.ExecutionActivity
-summary: 'Execute spark job activity.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SynapseSparkJobDefinitionActivity(*, name: str, spark_job: _models.SynapseSparkJobReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, state: str | _models.ActivityState | None = None, on_inactive_mark_as:
- str | _models.ActivityOnInactiveMarkAs | None = None, depends_on: List[_models.ActivityDependency]
- | None = None, user_properties: List[_models.UserProperty] | None = None, linked_service_name:
- _models.LinkedServiceReference | None = None, policy: _models.ActivityPolicy |
- None = None, arguments: List[Any] | None = None, file: MutableMapping[str, Any]
- | None = None, scan_folder: MutableMapping[str, Any] | None = None, class_name:
- MutableMapping[str, Any] | None = None, files: List[MutableMapping[str, Any]]
- | None = None, python_code_reference: List[MutableMapping[str, Any]] | None =
- None, files_v2: List[MutableMapping[str, Any]] | None = None, target_big_data_pool:
- _models.BigDataPoolParametrizationReference | None = None, executor_size: MutableMapping[str,
- Any] | None = None, conf: MutableMapping[str, Any] | None = None, driver_size:
- MutableMapping[str, Any] | None = None, num_executors: MutableMapping[str, Any]
- | None = None, configuration_type: str | _models.ConfigurationType | None = None,
- target_spark_configuration: _models.SparkConfigurationParametrizationReference
- | None = None, spark_config: Dict[str, MutableMapping[str, Any]] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: name
- description: Activity name. Required.
- types:
- - <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- - name: depends_on
- description: Activity depends on condition.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- - name: user_properties
- description: Activity user properties.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- - name: linked_service_name
- description: Linked service reference.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: policy
- description: Activity policy.
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
- - name: spark_job
- description: Synapse spark job reference. Required.
- types:
- - <xref:azure.synapse.artifacts.models.SynapseSparkJobReference>
- - name: arguments
- description: User specified arguments to SynapseSparkJobDefinitionActivity.
- types:
- - <xref:list>[<xref:any>]
- - name: file
- description: 'The main file used for the job, which will override the ''file''
- of the spark job
-
- definition you provide. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: scan_folder
- description: 'Scanning subfolders from the root folder of the main definition
- file,
-
- these files will be added as reference files. The folders named ''jars'', ''pyFiles'',
- ''files'' or
-
- ''archives'' will be scanned, and the folders name are case sensitive. Type:
- boolean (or
-
- Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: class_name
- description: 'The fully-qualified identifier or the main class that is in the
- main
-
- definition file, which will override the ''className'' of the spark job definition
- you provide.
-
- Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: files
- description: '(Deprecated. Please use pythonCodeReference and filesV2) Additional
- files used
-
- for reference in the main definition file, which will override the ''files''
- of the spark job
-
- definition you provide.'
- types:
- - <xref:list>[<xref:JSON>]
- - name: python_code_reference
- description: 'Additional python code files used for reference in the main
-
- definition file, which will override the ''pyFiles'' of the spark job definition
- you provide.'
- types:
- - <xref:list>[<xref:JSON>]
- - name: files_v2
- description: 'Additional files used for reference in the main definition file,
- which will
-
- override the ''jars'' and ''files'' of the spark job definition you provide.'
- types:
- - <xref:list>[<xref:JSON>]
- - name: target_big_data_pool
- description: 'The name of the big data pool which will be used to execute the
-
- spark batch job, which will override the ''targetBigDataPool'' of the spark
- job definition you
-
- provide.'
- types:
- - <xref:azure.synapse.artifacts.models.BigDataPoolParametrizationReference>
- - name: executor_size
- description: 'Number of core and memory to be used for executors allocated in
- the
-
- specified Spark pool for the job, which will be used for overriding ''executorCores''
- and
-
- ''executorMemory'' of the spark job definition you provide. Type: string (or
- Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: conf
- description: 'Spark configuration properties, which will override the ''conf''
- of the spark job
-
- definition you provide.'
- types:
- - <xref:JSON>
- - name: driver_size
- description: 'Number of core and memory to be used for driver allocated in the
-
- specified Spark pool for the job, which will be used for overriding ''driverCores''
- and
-
- ''driverMemory'' of the spark job definition you provide. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: num_executors
- description: 'Number of executors to launch for this job, which will override
- the
-
- ''numExecutors'' of the spark job definition you provide. Type: integer (or
- Expression with
-
- resultType integer).'
- types:
- - <xref:JSON>
- - name: configuration_type
- description: 'The type of the spark config. Known values are: "Default",
-
- "Customized", and "Artifact".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ConfigurationType>
- - name: target_spark_configuration
- description: The spark configuration of the spark job.
- types:
- - <xref:azure.synapse.artifacts.models.SparkConfigurationParametrizationReference>
- - name: spark_config
- description: Spark configuration property.
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: Synapse spark job reference. Required.
- name: spark_job
- types:
- - <xref:azure.synapse.artifacts.models.SynapseSparkJobReference>
-- description: User specified arguments to SynapseSparkJobDefinitionActivity.
- name: arguments
- types:
- - <xref:list>[<xref:any>]
-- description: 'The main file used for the job, which will override the ''file'' of
- the spark job
-
- definition you provide. Type: string (or Expression with resultType string).'
- name: file
- types:
- - <xref:JSON>
-- description: 'Scanning subfolders from the root folder of the main definition file,
- these
-
- files will be added as reference files. The folders named ''jars'', ''pyFiles'',
- ''files'' or
-
- ''archives'' will be scanned, and the folders name are case sensitive. Type: boolean
- (or
-
- Expression with resultType boolean).'
- name: scan_folder
- types:
- - <xref:JSON>
-- description: 'The fully-qualified identifier or the main class that is in the main
-
- definition file, which will override the ''className'' of the spark job definition
- you provide.
-
- Type: string (or Expression with resultType string).'
- name: class_name
- types:
- - <xref:JSON>
-- description: '(Deprecated. Please use pythonCodeReference and filesV2) Additional
- files used for
-
- reference in the main definition file, which will override the ''files'' of the
- spark job
-
- definition you provide.'
- name: files
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Additional python code files used for reference in the main
-
- definition file, which will override the ''pyFiles'' of the spark job definition
- you provide.'
- name: python_code_reference
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Additional files used for reference in the main definition file, which
- will
-
- override the ''jars'' and ''files'' of the spark job definition you provide.'
- name: files_v2
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The name of the big data pool which will be used to execute the
-
- spark batch job, which will override the ''targetBigDataPool'' of the spark job
- definition you
-
- provide.'
- name: target_big_data_pool
- types:
- - <xref:azure.synapse.artifacts.models.BigDataPoolParametrizationReference>
-- description: 'Number of core and memory to be used for executors allocated in the
-
- specified Spark pool for the job, which will be used for overriding ''executorCores''
- and
-
- ''executorMemory'' of the spark job definition you provide. Type: string (or Expression
- with
-
- resultType string).'
- name: executor_size
- types:
- - <xref:JSON>
-- description: 'Spark configuration properties, which will override the ''conf'' of
- the spark job
-
- definition you provide.'
- name: conf
- types:
- - <xref:JSON>
-- description: 'Number of core and memory to be used for driver allocated in the specified
-
- Spark pool for the job, which will be used for overriding ''driverCores'' and
- ''driverMemory'' of
-
- the spark job definition you provide. Type: string (or Expression with resultType
- string).'
- name: driver_size
- types:
- - <xref:JSON>
-- description: 'Number of executors to launch for this job, which will override the
-
- ''numExecutors'' of the spark job definition you provide. Type: integer (or Expression
- with
-
- resultType integer).'
- name: num_executors
- types:
- - <xref:JSON>
-- description: 'The type of the spark config. Known values are: "Default",
-
- "Customized", and "Artifact".'
- name: configuration_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ConfigurationType>
-- description: The spark configuration of the spark job.
- name: target_spark_configuration
- types:
- - <xref:azure.synapse.artifacts.models.SparkConfigurationParametrizationReference>
-- description: Spark configuration property.
- name: spark_config
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SynapseSparkJobReference.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SynapseSparkJobReference.yml
deleted file mode 100644
index db0649c46df3..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SynapseSparkJobReference.yml
+++ /dev/null
@@ -1,34 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.SynapseSparkJobReference
-name: SynapseSparkJobReference
-fullName: azure.synapse.artifacts.models.SynapseSparkJobReference
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Synapse spark job reference type.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'SynapseSparkJobReference(*, type: str | _models.SparkJobReferenceType,
- reference_name: str, **kwargs: Any)'
- parameters:
- - name: type
- description: Synapse spark job reference type. Required. "SparkJobDefinitionReference"
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SparkJobReferenceType>
- - name: reference_name
- description: Reference spark job name. Required.
- types:
- - <xref:str>
-variables:
-- description: Synapse spark job reference type. Required. "SparkJobDefinitionReference"
- name: type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.SparkJobReferenceType>
-- description: Reference spark job name. Required.
- name: reference_name
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TabularSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TabularSource.yml
deleted file mode 100644
index e551b5e36c22..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TabularSource.yml
+++ /dev/null
@@ -1,124 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.TabularSource
-name: TabularSource
-fullName: azure.synapse.artifacts.models.TabularSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'Copy activity sources of tabular type.
-
-
- You probably want to use the sub-classes and not this class directly. Known sub-classes
- are:
-
- AmazonMWSSource, AmazonRdsForSqlServerSource, AmazonRedshiftSource, AzureMariaDBSource,
-
- AzureMySqlSource, AzurePostgreSqlSource, AzureSqlSource, AzureTableSource, CassandraSource,
-
- ConcurSource, CouchbaseSource, Db2Source, DrillSource, DynamicsAXSource, EloquaSource,
-
- GoogleAdWordsSource, GoogleBigQuerySource, GreenplumSource, HBaseSource, HiveSource,
-
- HubspotSource, ImpalaSource, InformixSource, JiraSource, MagentoSource, MariaDBSource,
-
- MarketoSource, MySqlSource, NetezzaSource, OdbcSource, OracleServiceCloudSource,
- PaypalSource,
-
- PhoenixSource, PostgreSqlSource, PrestoSource, QuickBooksSource, ResponsysSource,
-
- SalesforceMarketingCloudSource, SalesforceSource, SapBwSource, SapCloudForCustomerSource,
-
- SapEccSource, SapHanaSource, SapOdpSource, SapOpenHubSource, SapTableSource, ServiceNowSource,
-
- ShopifySource, SparkSource, SqlDWSource, SqlMISource, SqlServerSource, SqlSource,
- SquareSource,
-
- SybaseSource, TeradataSource, VerticaSource, XeroSource, ZohoSource
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'TabularSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TabularTranslator.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TabularTranslator.yml
deleted file mode 100644
index 8232c9976553..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TabularTranslator.yml
+++ /dev/null
@@ -1,147 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.TabularTranslator
-name: TabularTranslator
-fullName: azure.synapse.artifacts.models.TabularTranslator
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopyTranslator
-summary: 'A copy activity tabular translator.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'TabularTranslator(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, column_mappings: MutableMapping[str, Any] | None = None,
- schema_mapping: MutableMapping[str, Any] | None = None, collection_reference:
- MutableMapping[str, Any] | None = None, map_complex_values_to_string: MutableMapping[str,
- Any] | None = None, mappings: MutableMapping[str, Any] | None = None, type_conversion:
- MutableMapping[str, Any] | None = None, type_conversion_settings: _models.TypeConversionSettings
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: column_mappings
- description: 'Column mappings. Example: "UserId: MyUserId, Group: MyGroup, Name:
-
- MyName" Type: string (or Expression with resultType string). This property will
- be retired.
-
- Please use mappings property.'
- types:
- - <xref:JSON>
- - name: schema_mapping
- description: 'The schema mapping to map between tabular data and hierarchical
- data.
-
- Example: {"Column1": "$.Column1", "Column2": "$.Column2.Property1", "Column3":
-
- "$.Column2.Property2"}. Type: object (or Expression with resultType object).
- This property will
-
- be retired. Please use mappings property.'
- types:
- - <xref:JSON>
- - name: collection_reference
- description: 'The JSON Path of the Nested Array that is going to do
-
- cross-apply. Type: object (or Expression with resultType object).'
- types:
- - <xref:JSON>
- - name: map_complex_values_to_string
- description: 'Whether to map complex (array and object) values to
-
- simple strings in json format. Type: boolean (or Expression with resultType
- boolean).'
- types:
- - <xref:JSON>
- - name: mappings
- description: 'Column mappings with logical types. Tabular->tabular example:
-
- [{"source":{"name":"CustomerName","type":"String"},"sink":{"name":"ClientName","type":"String"}},{"source":{"name":"CustomerAddress","type":"String"},"sink":{"name":"ClientAddress","type":"String"}}].
-
- Hierarchical->tabular example:
-
- [{"source":{"path":"$.CustomerName","type":"String"},"sink":{"name":"ClientName","type":"String"}},{"source":{"path":"$.CustomerAddress","type":"String"},"sink":{"name":"ClientAddress","type":"String"}}].
-
- Type: object (or Expression with resultType object).'
- types:
- - <xref:JSON>
- - name: type_conversion
- description: 'Whether to enable the advanced type conversion feature in the Copy
-
- activity. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: type_conversion_settings
- description: Type conversion settings.
- types:
- - <xref:azure.synapse.artifacts.models.TypeConversionSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy translator type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Column mappings. Example: "UserId: MyUserId, Group: MyGroup, Name:
-
- MyName" Type: string (or Expression with resultType string). This property will
- be retired.
-
- Please use mappings property.'
- name: column_mappings
- types:
- - <xref:JSON>
-- description: 'The schema mapping to map between tabular data and hierarchical data.
-
- Example: {"Column1": "$.Column1", "Column2": "$.Column2.Property1", "Column3":
-
- "$.Column2.Property2"}. Type: object (or Expression with resultType object). This
- property will
-
- be retired. Please use mappings property.'
- name: schema_mapping
- types:
- - <xref:JSON>
-- description: 'The JSON Path of the Nested Array that is going to do cross-apply.
-
- Type: object (or Expression with resultType object).'
- name: collection_reference
- types:
- - <xref:JSON>
-- description: 'Whether to map complex (array and object) values to simple
-
- strings in json format. Type: boolean (or Expression with resultType boolean).'
- name: map_complex_values_to_string
- types:
- - <xref:JSON>
-- description: 'Column mappings with logical types. Tabular->tabular example:
-
- [{"source":{"name":"CustomerName","type":"String"},"sink":{"name":"ClientName","type":"String"}},{"source":{"name":"CustomerAddress","type":"String"},"sink":{"name":"ClientAddress","type":"String"}}].
-
- Hierarchical->tabular example:
-
- [{"source":{"path":"$.CustomerName","type":"String"},"sink":{"name":"ClientName","type":"String"}},{"source":{"path":"$.CustomerAddress","type":"String"},"sink":{"name":"ClientAddress","type":"String"}}].
-
- Type: object (or Expression with resultType object).'
- name: mappings
- types:
- - <xref:JSON>
-- description: 'Whether to enable the advanced type conversion feature in the Copy
-
- activity. Type: boolean (or Expression with resultType boolean).'
- name: type_conversion
- types:
- - <xref:JSON>
-- description: Type conversion settings.
- name: type_conversion_settings
- types:
- - <xref:azure.synapse.artifacts.models.TypeConversionSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TarGZipReadSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TarGZipReadSettings.yml
deleted file mode 100644
index 0235904d7fce..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TarGZipReadSettings.yml
+++ /dev/null
@@ -1,45 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.TarGZipReadSettings
-name: TarGZipReadSettings
-fullName: azure.synapse.artifacts.models.TarGZipReadSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CompressionReadSettings
-summary: 'The TarGZip compression read settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'TarGZipReadSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, preserve_compression_file_name_as_folder: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: preserve_compression_file_name_as_folder
- description: 'Preserve the compression file name as folder
-
- path. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The Compression setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Preserve the compression file name as folder
-
- path. Type: boolean (or Expression with resultType boolean).'
- name: preserve_compression_file_name_as_folder
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TarReadSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TarReadSettings.yml
deleted file mode 100644
index 68e1af28dabe..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TarReadSettings.yml
+++ /dev/null
@@ -1,45 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.TarReadSettings
-name: TarReadSettings
-fullName: azure.synapse.artifacts.models.TarReadSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CompressionReadSettings
-summary: 'The Tar compression read settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'TarReadSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, preserve_compression_file_name_as_folder: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: preserve_compression_file_name_as_folder
- description: 'Preserve the compression file name as folder
-
- path. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The Compression setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Preserve the compression file name as folder
-
- path. Type: boolean (or Expression with resultType boolean).'
- name: preserve_compression_file_name_as_folder
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeamDeskAuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeamDeskAuthenticationType.yml
deleted file mode 100644
index 1d00ef855910..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeamDeskAuthenticationType.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.TeamDeskAuthenticationType
-name: TeamDeskAuthenticationType
-fullName: azure.synapse.artifacts.models.TeamDeskAuthenticationType
-summary: The authentication type to use.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: TeamDeskAuthenticationType(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: BASIC
- uid: azure.synapse.artifacts.models.TeamDeskAuthenticationType.BASIC
-- name: TOKEN
- uid: azure.synapse.artifacts.models.TeamDeskAuthenticationType.TOKEN
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeamDeskLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeamDeskLinkedService.yml
deleted file mode 100644
index d2fe728952ec..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeamDeskLinkedService.yml
+++ /dev/null
@@ -1,145 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.TeamDeskLinkedService
-name: TeamDeskLinkedService
-fullName: azure.synapse.artifacts.models.TeamDeskLinkedService
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.LinkedService
-summary: 'Linked service for TeamDesk.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'TeamDeskLinkedService(*, authentication_type: str | _models.TeamDeskAuthenticationType,
- url: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, user_name:
- MutableMapping[str, Any] | None = None, password: _models.SecretBase | None =
- None, api_token: _models.SecretBase | None = None, encrypted_credential: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: connect_via
- description: The integration runtime reference.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- - name: description
- description: Linked service description.
- types:
- - <xref:str>
- - name: parameters
- description: Parameters for linked service.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the linked service.
- types:
- - <xref:list>[<xref:JSON>]
- - name: authentication_type
- description: 'The authentication type to use. Required. Known values are:
-
- "Basic" and "Token".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.TeamDeskAuthenticationType>
- - name: url
- description: 'The url to connect TeamDesk source. Type: string (or Expression
- with resultType
-
- string). Required.'
- types:
- - <xref:JSON>
- - name: user_name
- description: 'The username of the TeamDesk source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: password
- description: The password of the TeamDesk source.
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
- - name: api_token
- description: The api token for the TeamDesk source.
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
- - 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).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The authentication type to use. Required. Known values are: "Basic"
-
- and "Token".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.TeamDeskAuthenticationType>
-- description: 'The url to connect TeamDesk source. Type: string (or Expression with
- resultType
-
- string). Required.'
- name: url
- types:
- - <xref:JSON>
-- description: 'The username of the TeamDesk source. Type: string (or Expression with
-
- resultType string).'
- name: user_name
- types:
- - <xref:JSON>
-- description: The password of the TeamDesk source.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: The api token for the TeamDesk source.
- name: api_token
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataAuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataAuthenticationType.yml
index 5df1d18a9e36..a3e8a5f34a63 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataAuthenticationType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataAuthenticationType.yml
@@ -11,7 +11,7 @@ inheritances:
- builtins.str
- enum.Enum
fields:
-- name: BASIC
- uid: azure.synapse.artifacts.models.TeradataAuthenticationType.BASIC
-- name: WINDOWS
- uid: azure.synapse.artifacts.models.TeradataAuthenticationType.WINDOWS
+- name: basic
+ uid: azure.synapse.artifacts.models.TeradataAuthenticationType.basic
+- name: windows
+ uid: azure.synapse.artifacts.models.TeradataAuthenticationType.windows
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataLinkedService.yml
index 61b91180e291..d448146b0b12 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataLinkedService.yml
@@ -10,54 +10,64 @@ 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, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, connection_string:
- MutableMapping[str, Any] | None = None, server: MutableMapping[str, Any] | None
- = None, authentication_type: str | _models.TeradataAuthenticationType | None =
- None, username: MutableMapping[str, Any] | None = None, password: _models.SecretBase
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
description: 'Teradata ODBC connection string. Type: string, SecureString or
AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: server
description: 'Server name for connection. Type: string (or Expression with resultType
-
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: authentication_type
- description: 'AuthenticationType to be used for connection. Known values are:
+ description: 'AuthenticationType to be used for connection. Possible values
- "Basic" and "Windows".'
+ include: "Basic", "Windows".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.TeradataAuthenticationType>
@@ -65,82 +75,21 @@ constructor:
description: 'Username for authentication. Type: string (or Expression with resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
description: Password for authentication.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Teradata ODBC connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: 'Server name for connection. Type: string (or Expression with resultType
- string).'
- name: server
- types:
- - <xref:JSON>
-- description: 'AuthenticationType to be used for connection. Known values are:
-
- "Basic" and "Windows".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.TeradataAuthenticationType>
-- description: 'Username for authentication. Type: string (or Expression with resultType
-
- string).'
- name: username
- types:
- - <xref:JSON>
-- description: Password for authentication.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataPartitionOption.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataPartitionOption.yml
deleted file mode 100644
index de4fe10a73db..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataPartitionOption.yml
+++ /dev/null
@@ -1,19 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.TeradataPartitionOption
-name: TeradataPartitionOption
-fullName: azure.synapse.artifacts.models.TeradataPartitionOption
-summary: The partition mechanism that will be used for teradata read in parallel.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: TeradataPartitionOption(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: DYNAMIC_RANGE
- uid: azure.synapse.artifacts.models.TeradataPartitionOption.DYNAMIC_RANGE
-- name: HASH
- uid: azure.synapse.artifacts.models.TeradataPartitionOption.HASH
-- name: NONE
- uid: azure.synapse.artifacts.models.TeradataPartitionOption.NONE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataPartitionSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataPartitionSettings.yml
deleted file mode 100644
index acf9a3e038a6..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataPartitionSettings.yml
+++ /dev/null
@@ -1,62 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.TeradataPartitionSettings
-name: TeradataPartitionSettings
-fullName: azure.synapse.artifacts.models.TeradataPartitionSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: The settings that will be leveraged for teradata source partitioning.
-constructor:
- syntax: 'TeradataPartitionSettings(*, partition_column_name: MutableMapping[str,
- Any] | None = None, partition_upper_bound: MutableMapping[str, Any] | None = None,
- partition_lower_bound: MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: partition_column_name
- description: 'The name of the column that will be used for proceeding range
-
- or hash partitioning. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: partition_upper_bound
- description: 'The maximum value of column specified in partitionColumnName
-
- that will be used for proceeding range partitioning. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: partition_lower_bound
- description: 'The minimum value of column specified in partitionColumnName
-
- that will be used for proceeding range partitioning. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'The name of the column that will be used for proceeding range or
-
- hash partitioning. Type: string (or Expression with resultType string).'
- name: partition_column_name
- types:
- - <xref:JSON>
-- description: 'The maximum value of column specified in partitionColumnName that
-
- will be used for proceeding range partitioning. Type: string (or Expression with
- resultType
-
- string).'
- name: partition_upper_bound
- types:
- - <xref:JSON>
-- description: 'The minimum value of column specified in partitionColumnName that
-
- will be used for proceeding range partitioning. Type: string (or Expression with
- resultType
-
- string).'
- name: partition_lower_bound
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataSource.yml
deleted file mode 100644
index 1214a7398341..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataSource.yml
+++ /dev/null
@@ -1,131 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.TeradataSource
-name: TeradataSource
-fullName: azure.synapse.artifacts.models.TeradataSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Teradata source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'TeradataSource(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None,
- source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections:
- MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any]
- | None = None, additional_columns: MutableMapping[str, Any] | None = None, query:
- MutableMapping[str, Any] | None = None, partition_option: str | _models.TeradataPartitionOption
- | None = None, partition_settings: _models.TeradataPartitionSettings | None =
- None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'Teradata query. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: partition_option
- description: 'The partition mechanism that will be used for teradata read in
-
- parallel. Known values are: "None", "Hash", and "DynamicRange".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.TeradataPartitionOption>
- - name: partition_settings
- description: 'The settings that will be leveraged for teradata source
-
- partitioning.'
- types:
- - <xref:azure.synapse.artifacts.models.TeradataPartitionSettings>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'Teradata query. Type: string (or Expression with resultType string).'
- name: query
- types:
- - <xref:JSON>
-- description: 'The partition mechanism that will be used for teradata read in
-
- parallel. Known values are: "None", "Hash", and "DynamicRange".'
- name: partition_option
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.TeradataPartitionOption>
-- description: The settings that will be leveraged for teradata source partitioning.
- name: partition_settings
- types:
- - <xref:azure.synapse.artifacts.models.TeradataPartitionSettings>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataTableDataset.yml
index f1f18f4f8ab6..a29b16c6c722 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataTableDataset.yml
@@ -10,54 +10,66 @@ summary: 'The Teradata database dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'TeradataTableDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, database: MutableMapping[str, Any] | None
- = None, table: MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: database
@@ -65,70 +77,12 @@ constructor:
resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: table
description: 'The table name of Teradata. Type: string (or Expression with resultType
-
string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The database name of Teradata. Type: string (or Expression with resultType
-
- string).'
- name: database
- types:
- - <xref:JSON>
-- description: 'The table name of Teradata. Type: string (or Expression with resultType
- string).'
- name: table
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TextFormat.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TextFormat.yml
deleted file mode 100644
index a6325885cd4a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TextFormat.yml
+++ /dev/null
@@ -1,165 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.TextFormat
-name: TextFormat
-fullName: azure.synapse.artifacts.models.TextFormat
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.DatasetStorageFormat
-summary: 'The data stored in text format.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'TextFormat(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, serializer: MutableMapping[str, Any] | None = None, deserializer:
- MutableMapping[str, Any] | None = None, column_delimiter: MutableMapping[str,
- Any] | None = None, row_delimiter: MutableMapping[str, Any] | None = None, escape_char:
- MutableMapping[str, Any] | None = None, quote_char: MutableMapping[str, Any] |
- None = None, null_value: MutableMapping[str, Any] | None = None, encoding_name:
- MutableMapping[str, Any] | None = None, treat_empty_as_null: MutableMapping[str,
- Any] | None = None, skip_line_count: MutableMapping[str, Any] | None = None, first_row_as_header:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: serializer
- description: 'Serializer. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: deserializer
- description: 'Deserializer. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: column_delimiter
- description: 'The column delimiter. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: row_delimiter
- description: 'The row delimiter. Type: string (or Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: escape_char
- description: 'The escape character. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: quote_char
- description: 'The quote character. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
- - name: null_value
- description: 'The null value string. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: encoding_name
- description: "The code page name of the preferred encoding. If miss, the default\n\
- value is \u0393\xC7\xA3utf-8\u0393\xC7\xA5, unless BOM denotes another Unicode\
- \ encoding. Refer to the \u0393\xC7\xA3Name\u0393\xC7\xA5\ncolumn of the table\
- \ in the following link to set supported values:\n[https://msdn.microsoft.com/library/system.text.encoding.aspx](https://msdn.microsoft.com/library/system.text.encoding.aspx).\
- \ Type: string (or Expression with\nresultType string)."
- types:
- - <xref:JSON>
- - name: treat_empty_as_null
- description: 'Treat empty column values in the text file as null. The default
-
- value is true. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: skip_line_count
- description: 'The number of lines/rows to be skipped when parsing text files.
- The
-
- default value is 0. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - 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).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset storage format. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Serializer. Type: string (or Expression with resultType string).'
- name: serializer
- types:
- - <xref:JSON>
-- description: 'Deserializer. Type: string (or Expression with resultType string).'
- name: deserializer
- types:
- - <xref:JSON>
-- description: 'The column delimiter. Type: string (or Expression with resultType
-
- string).'
- name: column_delimiter
- types:
- - <xref:JSON>
-- description: 'The row delimiter. Type: string (or Expression with resultType string).'
- name: row_delimiter
- types:
- - <xref:JSON>
-- description: 'The escape character. Type: string (or Expression with resultType
- string).'
- name: escape_char
- types:
- - <xref:JSON>
-- description: 'The quote character. Type: string (or Expression with resultType string).'
- name: quote_char
- types:
- - <xref:JSON>
-- description: 'The null value string. Type: string (or Expression with resultType
- string).'
- name: null_value
- types:
- - <xref:JSON>
-- description: "The code page name of the preferred encoding. If miss, the default\
- \ value\nis \u0393\xC7\xA3utf-8\u0393\xC7\xA5, unless BOM denotes another Unicode\
- \ encoding. Refer to the \u0393\xC7\xA3Name\u0393\xC7\xA5 column of\nthe table\
- \ in the following link to set supported values:\n[https://msdn.microsoft.com/library/system.text.encoding.aspx](https://msdn.microsoft.com/library/system.text.encoding.aspx).\
- \ Type: string (or Expression with\nresultType string)."
- name: encoding_name
- types:
- - <xref:JSON>
-- description: 'Treat empty column values in the text file as null. The default
-
- value is true. Type: boolean (or Expression with resultType boolean).'
- name: treat_empty_as_null
- types:
- - <xref:JSON>
-- description: 'The number of lines/rows to be skipped when parsing text files. The
-
- default value is 0. Type: integer (or Expression with resultType integer).'
- name: skip_line_count
- types:
- - <xref:JSON>
-- 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).'
- name: first_row_as_header
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TrackedResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TrackedResource.yml
deleted file mode 100644
index 02ef3a11f484..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TrackedResource.yml
+++ /dev/null
@@ -1,55 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.TrackedResource
-name: TrackedResource
-fullName: azure.synapse.artifacts.models.TrackedResource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.Resource
-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)'
- parameters:
- - name: tags
- description: Resource tags.
- types:
- - <xref:dict>[<xref:str>, <xref:str>]
- - name: location
- description: The geo-location where the resource lives. Required.
- types:
- - <xref:str>
-variables:
-- description: 'Fully qualified resource ID for the resource. Ex -
-
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.'
- name: id
- types:
- - <xref:str>
-- description: The name of the resource.
- name: name
- types:
- - <xref:str>
-- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines"
- or
-
- "Microsoft.Storage/storageAccounts".'
- name: type
- types:
- - <xref:str>
-- description: Resource tags.
- name: tags
- types:
- - <xref:dict>[<xref:str>, <xref:str>]
-- description: The geo-location where the resource lives. Required.
- name: location
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Transformation.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Transformation.yml
index 8e2f351c31f6..3eacaaac616c 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Transformation.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Transformation.yml
@@ -4,54 +4,21 @@ name: Transformation
fullName: azure.synapse.artifacts.models.Transformation
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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, dataset: _models.DatasetReference
- | None = None, linked_service: _models.LinkedServiceReference | None = None, flowlet:
- _models.DataFlowReference | None = None, **kwargs: Any)'
+ syntax: 'Transformation(*, name: str, description: str | None = None, **kwargs)'
parameters:
- name: name
- description: Transformation name. Required.
+ description: Required. Transformation name.
+ isRequired: true
types:
- <xref:str>
- name: description
description: Transformation description.
+ isRequired: true
types:
- <xref:str>
- - name: dataset
- description: Dataset reference.
- types:
- - <xref:azure.synapse.artifacts.models.DatasetReference>
- - name: linked_service
- description: Linked service reference.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: flowlet
- description: Flowlet Reference.
- types:
- - <xref:azure.synapse.artifacts.models.DataFlowReference>
-variables:
-- description: Transformation name. Required.
- name: name
- types:
- - <xref:str>
-- description: Transformation description.
- name: description
- types:
- - <xref:str>
-- description: Dataset reference.
- name: dataset
- types:
- - <xref:azure.synapse.artifacts.models.DatasetReference>
-- description: Linked service reference.
- name: linked_service
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Flowlet Reference.
- name: flowlet
- types:
- - <xref:azure.synapse.artifacts.models.DataFlowReference>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Trigger.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Trigger.yml
index 18711ef098b0..3d62e97ab412 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Trigger.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Trigger.yml
@@ -4,15 +4,14 @@ name: Trigger
fullName: azure.synapse.artifacts.models.Trigger
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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:
+ You probably want to use the sub-classes and not this class directly. Known
- ChainingTrigger, MultiplePipelineTrigger, RerunTumblingWindowTrigger, TumblingWindowTrigger
+ sub-classes are: MultiplePipelineTrigger, RerunTumblingWindowTrigger.
Variables are only populated by the server, and will be ignored when sending a request.
@@ -20,48 +19,37 @@ summary: 'Azure Synapse nested object which contains information about creating
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'Trigger(*, additional_properties: Dict[str, MutableMapping[str, Any]] |
- None = None, description: str | None = None, annotations: List[MutableMapping[str,
- Any]] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Trigger type.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Trigger description.
+ isRequired: true
types:
- <xref:str>
- name: annotations
description: List of tags that can be used for describing the trigger.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Trigger type. Required.
- name: type
- types:
- - <xref:str>
-- description: Trigger description.
- name: description
- types:
- - <xref:str>
- description: 'Indicates if trigger is running or not. Updated when Start/Stop APIs
are
- called on the Trigger. Known values are: "Started", "Stopped", and "Disabled".'
+ called on the Trigger. Possible values include: "Started", "Stopped", "Disabled".'
name: runtime_state
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.TriggerRuntimeState>
-- description: List of tags that can be used for describing the trigger.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus.yml
index 48132fd12629..9bfe0947da9a 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus.yml
@@ -4,29 +4,22 @@ name: TriggerDependencyProvisioningStatus
fullName: azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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: Any)'
+ str, **kwargs)'
parameters:
- name: trigger_name
- description: Trigger name. Required.
+ description: Required. Trigger name.
+ isRequired: true
types:
- <xref:str>
- name: provisioning_status
- description: Provisioning status. Required.
+ description: Required. Provisioning status.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: Trigger name. Required.
- name: trigger_name
- types:
- - <xref:str>
-- description: Provisioning status. Required.
- name: provisioning_status
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerDependencyReference.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerDependencyReference.yml
deleted file mode 100644
index fb5322586aa8..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerDependencyReference.yml
+++ /dev/null
@@ -1,34 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.TriggerDependencyReference
-name: TriggerDependencyReference
-fullName: azure.synapse.artifacts.models.TriggerDependencyReference
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.DependencyReference
-summary: 'Trigger referenced dependency.
-
-
- You probably want to use the sub-classes and not this class directly. Known sub-classes
- are:
-
- TumblingWindowTriggerDependencyReference
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'TriggerDependencyReference(*, reference_trigger: _models.TriggerReference,
- **kwargs: Any)'
- parameters:
- - name: reference_trigger
- description: Referenced trigger. Required.
- types:
- - <xref:azure.synapse.artifacts.models.TriggerReference>
-variables:
-- description: The type of dependency reference. Required.
- name: type
- types:
- - <xref:str>
-- description: Referenced trigger. Required.
- name: reference_trigger
- types:
- - <xref:azure.synapse.artifacts.models.TriggerReference>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerListResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerListResponse.yml
index ca1d617099c0..cda6828784ff 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerListResponse.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerListResponse.yml
@@ -4,29 +4,22 @@ name: TriggerListResponse
fullName: azure.synapse.artifacts.models.TriggerListResponse
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'A list of trigger resources.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'TriggerListResponse(*, value: List[_models.TriggerResource], next_link:
- str | None = None, **kwargs: Any)'
+ syntax: 'TriggerListResponse(*, value: List[TriggerResource], next_link: str | None
+ = None, **kwargs)'
parameters:
- name: value
- description: List of triggers. Required.
+ description: Required. List of triggers.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.TriggerResource>]
- name: next_link
description: The link to the next page of results, if any remaining results exist.
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: List of triggers. Required.
- name: value
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.TriggerResource>]
-- description: The link to the next page of results, if any remaining results exist.
- name: next_link
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerPipelineReference.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerPipelineReference.yml
index 6101b1c904dc..4731d3b4f2ec 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerPipelineReference.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerPipelineReference.yml
@@ -4,27 +4,19 @@ name: TriggerPipelineReference
fullName: azure.synapse.artifacts.models.TriggerPipelineReference
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: Pipeline that needs to be triggered with the given parameters.
constructor:
- syntax: 'TriggerPipelineReference(*, pipeline_reference: _models.PipelineReference
- | None = None, parameters: Dict[str, MutableMapping[str, Any]] | None = None,
- **kwargs: Any)'
+ syntax: 'TriggerPipelineReference(*, pipeline_reference: PipelineReference | None
+ = None, parameters: Dict[str, object] | None = None, **kwargs)'
parameters:
- name: pipeline_reference
description: Pipeline reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.PipelineReference>
- name: parameters
description: Pipeline parameters.
+ isRequired: true
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-variables:
-- description: Pipeline reference.
- name: pipeline_reference
- types:
- - <xref:azure.synapse.artifacts.models.PipelineReference>
-- description: Pipeline parameters.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerReference.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerReference.yml
deleted file mode 100644
index c4c4d428eb2a..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerReference.yml
+++ /dev/null
@@ -1,34 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.TriggerReference
-name: TriggerReference
-fullName: azure.synapse.artifacts.models.TriggerReference
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: 'Trigger reference type.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'TriggerReference(*, type: str | _models.TriggerReferenceType, reference_name:
- str, **kwargs: Any)'
- parameters:
- - name: type
- description: Trigger reference type. Required. "TriggerReference"
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.TriggerReferenceType>
- - name: reference_name
- description: Reference trigger name. Required.
- types:
- - <xref:str>
-variables:
-- description: Trigger reference type. Required. "TriggerReference"
- name: type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.TriggerReferenceType>
-- description: Reference trigger name. Required.
- name: reference_name
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerReferenceType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerReferenceType.yml
deleted file mode 100644
index 820da2058def..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerReferenceType.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.TriggerReferenceType
-name: TriggerReferenceType
-fullName: azure.synapse.artifacts.models.TriggerReferenceType
-summary: Trigger reference type.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: TriggerReferenceType(value, names=None, *, module=None, qualname=None, type=None,
- start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: TRIGGER_REFERENCE
- uid: azure.synapse.artifacts.models.TriggerReferenceType.TRIGGER_REFERENCE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerResource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerResource.yml
index 607f010ff559..160d7237b5fe 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerResource.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerResource.yml
@@ -13,35 +13,27 @@ summary: 'Trigger resource type.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'TriggerResource(*, properties: _models.Trigger, **kwargs: Any)'
+ syntax: 'TriggerResource(*, properties: Trigger, **kwargs)'
parameters:
- name: properties
- description: Properties of the trigger. Required.
+ description: Required. Properties of the trigger.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.Trigger>
variables:
-- description: 'Fully qualified resource ID for the resource. Ex -
-
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.'
+- description: The resource identifier.
name: id
types:
- <xref:str>
-- description: The name of the resource.
+- description: The resource name.
name: name
types:
- <xref:str>
-- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines"
- or
-
- "Microsoft.Storage/storageAccounts".'
+- description: The resource type.
name: type
types:
- <xref:str>
-- description: Resource Etag.
+- description: Etag identifies change in the resource.
name: etag
types:
- <xref:str>
-- description: Properties of the trigger. Required.
- name: properties
- types:
- - <xref:azure.synapse.artifacts.models.Trigger>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRun.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRun.yml
index d3eb31788b1a..644a24dd69ab 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRun.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRun.yml
@@ -4,28 +4,22 @@ name: TriggerRun
fullName: azure.synapse.artifacts.models.TriggerRun
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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, MutableMapping[str, Any]]
- | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- description: Trigger run id.
name: trigger_run_id
types:
@@ -42,7 +36,8 @@ variables:
name: trigger_run_timestamp
types:
- <xref:datetime.datetime>
-- description: 'Trigger run status. Known values are: "Succeeded", "Failed", and "Inprogress".'
+- description: 'Trigger run status. Possible values include: "Succeeded", "Failed",
+ "Inprogress".'
name: status
types:
- <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRunStatus.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRunStatus.yml
index 66a4f1b59796..4680d5360688 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRunStatus.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRunStatus.yml
@@ -11,9 +11,9 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRunsQueryResponse.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRunsQueryResponse.yml
index 517cc8f3afeb..cd77ba6562c1 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRunsQueryResponse.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRunsQueryResponse.yml
@@ -4,33 +4,25 @@ name: TriggerRunsQueryResponse
fullName: azure.synapse.artifacts.models.TriggerRunsQueryResponse
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'A list of trigger runs.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'TriggerRunsQueryResponse(*, value: List[_models.TriggerRun], continuation_token:
- str | None = None, **kwargs: Any)'
+ syntax: 'TriggerRunsQueryResponse(*, value: List[TriggerRun], continuation_token:
+ str | None = None, **kwargs)'
parameters:
- name: value
- description: List of trigger runs. Required.
+ description: Required. List of trigger runs.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.TriggerRun>]
- name: continuation_token
description: 'The continuation token for getting the next page of results, if
+ any
- any remaining results exist, null otherwise.'
+ remaining results exist, null otherwise.'
+ isRequired: true
types:
- <xref:str>
-variables:
-- description: List of trigger runs. Required.
- name: value
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.TriggerRun>]
-- description: 'The continuation token for getting the next page of results, if any
-
- remaining results exist, null otherwise.'
- name: continuation_token
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRuntimeState.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRuntimeState.yml
index 5c456d50828a..cc7e690cca4a 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRuntimeState.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRuntimeState.yml
@@ -11,9 +11,9 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus.yml
index 18426677d7eb..fde3cad94619 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus.yml
@@ -4,21 +4,21 @@ name: TriggerSubscriptionOperationStatus
fullName: azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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: Any)'
+ syntax: TriggerSubscriptionOperationStatus(**kwargs)
variables:
- description: Trigger name.
name: trigger_name
types:
- <xref:str>
-- description: 'Event Subscription Status. Known values are: "Enabled", "Provisioning",
+- description: 'Event Subscription Status. Possible values include: "Enabled", "Provisioning",
- "Deprovisioning", "Disabled", and "Unknown".'
+ "Deprovisioning", "Disabled", "Unknown".'
name: status
types:
- <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TumblingWindowFrequency.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TumblingWindowFrequency.yml
deleted file mode 100644
index 9a7ea1e212bb..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TumblingWindowFrequency.yml
+++ /dev/null
@@ -1,19 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.TumblingWindowFrequency
-name: TumblingWindowFrequency
-fullName: azure.synapse.artifacts.models.TumblingWindowFrequency
-summary: Enumerates possible frequency option for the tumbling window trigger.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: TumblingWindowFrequency(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: HOUR
- uid: azure.synapse.artifacts.models.TumblingWindowFrequency.HOUR
-- name: MINUTE
- uid: azure.synapse.artifacts.models.TumblingWindowFrequency.MINUTE
-- name: MONTH
- uid: azure.synapse.artifacts.models.TumblingWindowFrequency.MONTH
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TumblingWindowTrigger.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TumblingWindowTrigger.yml
deleted file mode 100644
index c2c577709c61..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TumblingWindowTrigger.yml
+++ /dev/null
@@ -1,191 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.TumblingWindowTrigger
-name: TumblingWindowTrigger
-fullName: azure.synapse.artifacts.models.TumblingWindowTrigger
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.Trigger
-summary: 'Trigger that schedules pipeline runs for all fixed time interval windows
- from a start time
-
- without gaps and also supports backfill scenarios (when start time is in the past).
-
-
- Variables are only populated by the server, and will be ignored when sending a request.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'TumblingWindowTrigger(*, pipeline: _models.TriggerPipelineReference, frequency:
- str | _models.TumblingWindowFrequency, interval: int, start_time: datetime, max_concurrency:
- int, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None,
- description: str | None = None, annotations: List[MutableMapping[str, Any]] |
- None = None, end_time: datetime | None = None, delay: MutableMapping[str, Any]
- | None = None, retry_policy: _models.RetryPolicy | None = None, depends_on: List[_models.DependencyReference]
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Trigger description.
- types:
- - <xref:str>
- - name: annotations
- description: List of tags that can be used for describing the trigger.
- types:
- - <xref:list>[<xref:JSON>]
- - name: pipeline
- description: 'Pipeline for which runs are created when an event is fired for trigger
-
- window that is ready. Required.'
- types:
- - <xref:azure.synapse.artifacts.models.TriggerPipelineReference>
- - name: frequency
- description: 'The frequency of the time windows. Required. Known values are: "Minute",
-
- "Hour", and "Month".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.TumblingWindowFrequency>
- - name: interval
- description: 'The interval of the time windows. The minimum interval allowed is
- 15
-
- Minutes. Required.'
- types:
- - <xref:int>
- - name: start_time
- description: 'The start time for the time period for the trigger during which
- events are
-
- fired for windows that are ready. Only UTC time is currently supported. Required.'
- types:
- - <xref:datetime.datetime>
- - name: end_time
- description: 'The end time for the time period for the trigger during which events
- are
-
- fired for windows that are ready. Only UTC time is currently supported.'
- types:
- - <xref:datetime.datetime>
- - name: delay
- description: 'Specifies how long the trigger waits past due time before triggering
- new run.
-
- It doesn''t alter window start and end time. The default is 0. Type: string
- (or Expression with
-
- resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: max_concurrency
- description: 'The max number of parallel time windows (ready for execution) for
-
- which a new run is triggered. Required.'
- types:
- - <xref:int>
- - name: retry_policy
- description: Retry policy that will be applied for failed pipeline runs.
- types:
- - <xref:azure.synapse.artifacts.models.RetryPolicy>
- - name: depends_on
- description: 'Triggers that this trigger depends on. Only tumbling window triggers
- are
-
- supported.'
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DependencyReference>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Trigger type. Required.
- name: type
- types:
- - <xref:str>
-- description: Trigger description.
- name: description
- types:
- - <xref:str>
-- description: 'Indicates if trigger is running or not. Updated when Start/Stop APIs
- are
-
- called on the Trigger. Known values are: "Started", "Stopped", and "Disabled".'
- name: runtime_state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.TriggerRuntimeState>
-- description: List of tags that can be used for describing the trigger.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Pipeline for which runs are created when an event is fired for trigger
- window
-
- that is ready. Required.'
- name: pipeline
- types:
- - <xref:azure.synapse.artifacts.models.TriggerPipelineReference>
-- description: 'The frequency of the time windows. Required. Known values are: "Minute",
-
- "Hour", and "Month".'
- name: frequency
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.TumblingWindowFrequency>
-- description: 'The interval of the time windows. The minimum interval allowed is
- 15 Minutes.
-
- Required.'
- name: interval
- types:
- - <xref:int>
-- description: 'The start time for the time period for the trigger during which events
- are
-
- fired for windows that are ready. Only UTC time is currently supported. Required.'
- name: start_time
- types:
- - <xref:datetime.datetime>
-- description: 'The end time for the time period for the trigger during which events
- are fired
-
- for windows that are ready. Only UTC time is currently supported.'
- name: end_time
- types:
- - <xref:datetime.datetime>
-- description: 'Specifies how long the trigger waits past due time before triggering
- new run. It
-
- doesn''t alter window start and end time. The default is 0. Type: string (or Expression
- with
-
- resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: delay
- types:
- - <xref:JSON>
-- description: 'The max number of parallel time windows (ready for execution) for
- which
-
- a new run is triggered. Required.'
- name: max_concurrency
- types:
- - <xref:int>
-- description: Retry policy that will be applied for failed pipeline runs.
- name: retry_policy
- types:
- - <xref:azure.synapse.artifacts.models.RetryPolicy>
-- description: 'Triggers that this trigger depends on. Only tumbling window triggers
- are
-
- supported.'
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DependencyReference>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TumblingWindowTriggerDependencyReference.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TumblingWindowTriggerDependencyReference.yml
deleted file mode 100644
index 438814ff2845..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TumblingWindowTriggerDependencyReference.yml
+++ /dev/null
@@ -1,54 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.TumblingWindowTriggerDependencyReference
-name: TumblingWindowTriggerDependencyReference
-fullName: azure.synapse.artifacts.models.TumblingWindowTriggerDependencyReference
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TriggerDependencyReference
-summary: 'Referenced tumbling window trigger dependency.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'TumblingWindowTriggerDependencyReference(*, reference_trigger: _models.TriggerReference,
- offset: str | None = None, size: str | None = None, **kwargs: Any)'
- parameters:
- - name: reference_trigger
- description: Referenced trigger. Required.
- types:
- - <xref:azure.synapse.artifacts.models.TriggerReference>
- - name: offset
- description: 'Timespan applied to the start time of a tumbling window when evaluating
-
- dependency.'
- types:
- - <xref:str>
- - name: size
- description: 'The size of the window when evaluating the dependency. If undefined
- the
-
- frequency of the tumbling window will be used.'
- types:
- - <xref:str>
-variables:
-- description: The type of dependency reference. Required.
- name: type
- types:
- - <xref:str>
-- description: Referenced trigger. Required.
- name: reference_trigger
- types:
- - <xref:azure.synapse.artifacts.models.TriggerReference>
-- description: 'Timespan applied to the start time of a tumbling window when evaluating
-
- dependency.'
- name: offset
- types:
- - <xref:str>
-- description: 'The size of the window when evaluating the dependency. If undefined
- the frequency
-
- of the tumbling window will be used.'
- name: size
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TwilioLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TwilioLinkedService.yml
deleted file mode 100644
index 3b19761f57fb..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TwilioLinkedService.yml
+++ /dev/null
@@ -1,83 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.TwilioLinkedService
-name: TwilioLinkedService
-fullName: azure.synapse.artifacts.models.TwilioLinkedService
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.LinkedService
-summary: 'Linked service for Twilio.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'TwilioLinkedService(*, user_name: MutableMapping[str, Any], password: _models.SecretBase,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, connect_via:
- _models.IntegrationRuntimeReference | None = None, description: str | None = None,
- parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations:
- List[MutableMapping[str, Any]] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: connect_via
- description: The integration runtime reference.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- - name: description
- description: Linked service description.
- types:
- - <xref:str>
- - name: parameters
- description: Parameters for linked service.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the linked service.
- types:
- - <xref:list>[<xref:JSON>]
- - name: user_name
- description: The Account SID of Twilio service. Required.
- types:
- - <xref:JSON>
- - name: password
- description: The auth token of Twilio service. Required.
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: The Account SID of Twilio service. Required.
- name: user_name
- types:
- - <xref:JSON>
-- description: The auth token of Twilio service. Required.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Type.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Type.yml
deleted file mode 100644
index c666f7076b80..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Type.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.Type
-name: Type
-fullName: azure.synapse.artifacts.models.Type
-summary: Linked service reference type.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: Type(value, names=None, *, module=None, qualname=None, type=None, start=1,
- boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: LINKED_SERVICE_REFERENCE
- uid: azure.synapse.artifacts.models.Type.LINKED_SERVICE_REFERENCE
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TypeConversionSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TypeConversionSettings.yml
deleted file mode 100644
index 876f85206797..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TypeConversionSettings.yml
+++ /dev/null
@@ -1,91 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.TypeConversionSettings
-name: TypeConversionSettings
-fullName: azure.synapse.artifacts.models.TypeConversionSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Type conversion settings.
-constructor:
- syntax: 'TypeConversionSettings(*, allow_data_truncation: MutableMapping[str, Any]
- | None = None, treat_boolean_as_number: MutableMapping[str, Any] | None = None,
- date_time_format: MutableMapping[str, Any] | None = None, date_time_offset_format:
- MutableMapping[str, Any] | None = None, time_span_format: MutableMapping[str,
- Any] | None = None, culture: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
- parameters:
- - name: allow_data_truncation
- description: 'Whether to allow data truncation when converting the data.
-
- Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: treat_boolean_as_number
- description: 'Whether to treat boolean values as numbers. Type: boolean (or
-
- Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: date_time_format
- description: 'The format for DateTime values. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: date_time_offset_format
- description: 'The format for DateTimeOffset values. Type: string (or
-
- Expression with resultType string).'
- types:
- - <xref:JSON>
- - name: time_span_format
- description: 'The format for TimeSpan values. Type: string (or Expression with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: culture
- description: 'The culture used to convert data from/to string. Type: string (or
- Expression
-
- with resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Whether to allow data truncation when converting the data. Type:
-
- boolean (or Expression with resultType boolean).'
- name: allow_data_truncation
- types:
- - <xref:JSON>
-- description: 'Whether to treat boolean values as numbers. Type: boolean (or
-
- Expression with resultType boolean).'
- name: treat_boolean_as_number
- types:
- - <xref:JSON>
-- description: 'The format for DateTime values. Type: string (or Expression with
-
- resultType string).'
- name: date_time_format
- types:
- - <xref:JSON>
-- description: 'The format for DateTimeOffset values. Type: string (or
-
- Expression with resultType string).'
- name: date_time_offset_format
- types:
- - <xref:JSON>
-- description: 'The format for TimeSpan values. Type: string (or Expression with
-
- resultType string).'
- name: time_span_format
- types:
- - <xref:JSON>
-- description: 'The culture used to convert data from/to string. Type: string (or
- Expression
-
- with resultType string).'
- name: culture
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.UntilActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.UntilActivity.yml
index bd87331d14c8..47655e25d5d6 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.UntilActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.UntilActivity.yml
@@ -4,156 +4,76 @@ name: UntilActivity
fullName: azure.synapse.artifacts.models.UntilActivity
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts.models._models_py3.ControlActivity
+- azure.synapse.artifacts.models._models_py3.Activity
summary: 'This activity executes inner activities until the specified boolean expression
- results to true
-
- or timeout is reached, whichever is earlier.
+ 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: _models.Expression, activities:
- List[_models.Activity], additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, description: str | None = None, state: str | _models.ActivityState
- | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None
- = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, timeout: MutableMapping[str, Any] |
- None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
- types:
- - <xref:str>
- - name: description
- description: Activity description.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: expression
- description: 'An expression that would evaluate to Boolean. The loop will continue
- until
+ description: 'Required. An expression that would evaluate to Boolean. The loop
+ will
- this expression evaluates to true. Required.'
+ continue until this expression evaluates to true.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.Expression>
- name: timeout
description: 'Specifies the timeout for the activity to run. If there is no value
+ specified,
- specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default.
- Type: string
+ it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type:
+ string (or
- (or Expression with resultType string), pattern:
+ 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:
- - <xref:JSON>
+ - <xref:object>
- name: activities
- description: List of activities to execute. Required.
+ description: Required. List of activities to execute.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.Activity>]
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: 'An expression that would evaluate to Boolean. The loop will continue
- until
-
- this expression evaluates to true. Required.'
- name: expression
- types:
- - <xref:azure.synapse.artifacts.models.Expression>
-- 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])).'
- name: timeout
- types:
- - <xref:JSON>
-- description: List of activities to execute. Required.
- name: activities
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.Activity>]
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.UpdateLandingZoneCredential.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.UpdateLandingZoneCredential.yml
deleted file mode 100644
index 64126c0c5b9e..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.UpdateLandingZoneCredential.yml
+++ /dev/null
@@ -1,21 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.UpdateLandingZoneCredential
-name: UpdateLandingZoneCredential
-fullName: azure.synapse.artifacts.models.UpdateLandingZoneCredential
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: UpdateLandingZoneCredential.
-constructor:
- syntax: 'UpdateLandingZoneCredential(*, sas_token: _models.SecureString | None =
- None, **kwargs: Any)'
- parameters:
- - name: sas_token
- description: Landing zone's sas token.
- types:
- - <xref:azure.synapse.artifacts.models.SecureString>
-variables:
-- description: Landing zone's sas token.
- name: sas_token
- types:
- - <xref:azure.synapse.artifacts.models.SecureString>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.UserProperty.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.UserProperty.yml
index e55dbe2f0e72..39c79b0b1b5e 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.UserProperty.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.UserProperty.yml
@@ -4,33 +4,24 @@ name: UserProperty
fullName: azure.synapse.artifacts.models.UserProperty
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'User property.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'UserProperty(*, name: str, value: MutableMapping[str, Any], **kwargs: Any)'
+ syntax: 'UserProperty(*, name: str, value: object, **kwargs)'
parameters:
- name: name
- description: User property name. Required.
+ description: Required. User property name.
+ isRequired: true
types:
- <xref:str>
- name: value
- description: 'User property value. Type: string (or Expression with resultType
- string).
+ description: 'Required. User property value. Type: string (or Expression with
+ resultType
- Required.'
+ string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: User property name. Required.
- name: name
- types:
- - <xref:str>
-- description: 'User property value. Type: string (or Expression with resultType string).
-
- Required.'
- name: value
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ValidationActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ValidationActivity.yml
index 0e17bf964c7f..4b73f299908b 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ValidationActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ValidationActivity.yml
@@ -4,185 +4,94 @@ name: ValidationActivity
fullName: azure.synapse.artifacts.models.ValidationActivity
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts.models._models_py3.ControlActivity
+- azure.synapse.artifacts.models._models_py3.Activity
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: _models.DatasetReference, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None,
- state: str | _models.ActivityState | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs
- | None = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, timeout: MutableMapping[str, Any] |
- None = None, sleep: MutableMapping[str, Any] | None = None, minimum_size: MutableMapping[str,
- Any] | None = None, child_items: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: timeout
description: 'Specifies the timeout for the activity to run. If there is no value
+ specified,
- specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default.
- Type: string
+ it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type:
+ string (or
- (or Expression with resultType string), pattern:
+ Expression with resultType string), pattern:
((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: minimum_size
description: 'Can be used if dataset points to a file. The file must be greater
- than
+ than or
- or equal in size to the value specified. Type: integer (or Expression with resultType
+ equal in size to the value specified. Type: integer (or Expression with resultType
integer).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: child_items
description: 'Can be used if dataset points to a folder. If set to true, the folder
+ must
- must have at least one file. If set to false, the folder must be empty. Type:
- boolean (or
+ have at least one file. If set to false, the folder must be empty. Type: boolean
+ (or Expression
- Expression with resultType boolean).'
+ with resultType boolean).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: dataset
- description: Validation activity dataset reference. Required.
+ description: Required. Validation activity dataset reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetReference>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- 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])).'
- name: timeout
- types:
- - <xref:JSON>
-- 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).'
- name: sleep
- types:
- - <xref:JSON>
-- 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).'
- name: minimum_size
- types:
- - <xref:JSON>
-- 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).'
- name: child_items
- types:
- - <xref:JSON>
-- description: Validation activity dataset reference. Required.
- name: dataset
- types:
- - <xref:azure.synapse.artifacts.models.DatasetReference>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VariableSpecification.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VariableSpecification.yml
index 9916369ff630..441c7db68e8b 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VariableSpecification.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VariableSpecification.yml
@@ -4,37 +4,26 @@ name: VariableSpecification
fullName: azure.synapse.artifacts.models.VariableSpecification
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
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 | _models.VariableType, default_value:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ syntax: 'VariableSpecification(*, type: str | VariableType, default_value: object
+ | None = None, **kwargs)'
parameters:
- name: type
- description: 'Variable type. Required. Known values are: "String", "Bool", "Boolean",
- and
+ description: 'Required. Variable type. Possible values include: "String", "Bool",
+ "Boolean",
"Array".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.VariableType>
- name: default_value
description: Default value of variable.
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Variable type. Required. Known values are: "String", "Bool", "Boolean",
- and
-
- "Array".'
- name: type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.VariableType>
-- description: Default value of variable.
- name: default_value
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VariableType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VariableType.yml
index e96acb9a8950..0212101dcd68 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VariableType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VariableType.yml
@@ -11,11 +11,11 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaLinkedService.yml
index 8488e1d3e8b4..7b4dd3be52c3 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaLinkedService.yml
@@ -10,98 +10,63 @@ summary: 'Vertica linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'VerticaLinkedService(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, connection_string:
- MutableMapping[str, Any] | None = None, pwd: _models.AzureKeyVaultSecretReference
- | None = None, encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: connection_string
description: 'An ODBC connection string. Type: string, SecureString or
AzureKeyVaultSecretReference.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: pwd
description: The Azure key vault secret reference of password in connection string.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'An ODBC connection string. Type: string, SecureString or
-
- AzureKeyVaultSecretReference.'
- name: connection_string
- types:
- - <xref:JSON>
-- description: The Azure key vault secret reference of password in connection string.
- name: pwd
- types:
- - <xref:azure.synapse.artifacts.models.AzureKeyVaultSecretReference>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaSource.yml
deleted file mode 100644
index 2aa1ca57c42e..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.VerticaSource
-name: VerticaSource
-fullName: azure.synapse.artifacts.models.VerticaSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Vertica source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'VerticaSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaTableDataset.yml
index 68b1a540c3e6..009c5f1799f7 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaTableDataset.yml
@@ -10,139 +10,88 @@ summary: 'Vertica dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'VerticaTableDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, table: MutableMapping[str, Any] | None = None, schema_type_properties_schema:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'This property will be retired. Please consider using schema + table
properties instead.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: table
description: 'The table name of the Vertica. Type: string (or Expression with
resultType
string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: schema_type_properties_schema
description: 'The schema name of the Vertica. Type: string (or
Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'This property will be retired. Please consider using schema + table
-
- properties instead.'
- name: table_name
- types:
- - <xref:JSON>
-- description: 'The table name of the Vertica. Type: string (or Expression with resultType
-
- string).'
- name: table
- types:
- - <xref:JSON>
-- description: 'The schema name of the Vertica. Type: string (or
-
- Expression with resultType string).'
- name: schema_type_properties_schema
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VirtualNetworkProfile.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VirtualNetworkProfile.yml
deleted file mode 100644
index a22f5ca932b9..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VirtualNetworkProfile.yml
+++ /dev/null
@@ -1,21 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.VirtualNetworkProfile
-name: VirtualNetworkProfile
-fullName: azure.synapse.artifacts.models.VirtualNetworkProfile
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Virtual Network Profile.
-constructor:
- syntax: 'VirtualNetworkProfile(*, compute_subnet_id: str | None = None, **kwargs:
- Any)'
- parameters:
- - name: compute_subnet_id
- description: Subnet ID used for computes in workspace.
- types:
- - <xref:str>
-variables:
-- description: Subnet ID used for computes in workspace.
- name: compute_subnet_id
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WaitActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WaitActivity.yml
index 138a8f3bc4c6..c77bd1a63339 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WaitActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WaitActivity.yml
@@ -4,109 +4,50 @@ name: WaitActivity
fullName: azure.synapse.artifacts.models.WaitActivity
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts.models._models_py3.ControlActivity
+- azure.synapse.artifacts.models._models_py3.Activity
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: MutableMapping[str, Any],
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, state: str | _models.ActivityState | None = None, on_inactive_mark_as:
- str | _models.ActivityOnInactiveMarkAs | None = None, depends_on: List[_models.ActivityDependency]
- | None = None, user_properties: List[_models.UserProperty] | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: wait_time_in_seconds
- description: Duration in seconds. Required.
+ description: Required. Duration in seconds.
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Duration in seconds. Required.
- name: wait_time_in_seconds
- types:
- - <xref:JSON>
+ - <xref:int>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivity.yml
index ee9489c2a54e..506ba8979f29 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivity.yml
@@ -10,82 +10,74 @@ summary: 'Web activity.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'WebActivity(*, name: str, method: str | _models.WebActivityMethod, url:
- MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, state: str | _models.ActivityState
- | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None
- = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, linked_service_name: _models.LinkedServiceReference
- | None = None, policy: _models.ActivityPolicy | None = None, headers: MutableMapping[str,
- Any] | None = None, body: MutableMapping[str, Any] | None = None, authentication:
- _models.WebActivityAuthentication | None = None, datasets: List[_models.DatasetReference]
- | None = None, linked_services: List[_models.LinkedServiceReference] | None =
- None, connect_via: _models.IntegrationRuntimeReference | None = None, **kwargs:
- Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- name: linked_service_name
description: Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: policy
description: Activity policy.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.ActivityPolicy>
- name: method
- description: 'Rest API method for target endpoint. Required. Known values are:
+ description: 'Required. Rest API method for target endpoint. Possible values include:
"GET",
- "POST", "PUT", and "DELETE".'
+ "POST", "PUT", "DELETE".'
+ isRequired: true
types:
- <xref:str>
- <xref:azure.synapse.artifacts.models.WebActivityMethod>
- name: url
- description: 'Web activity target endpoint and path. Type: string (or Expression
- with
+ description: 'Required. Web activity target endpoint and path. Type: string (or
+ Expression with
- resultType string). Required.'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: headers
description: 'Represents the headers that will be sent to the request. For example,
to set
@@ -94,130 +86,35 @@ constructor:
"Content-Type":
"application/json" }. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: authentication
description: Authentication method used for calling the endpoint.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.WebActivityAuthentication>
- name: datasets
description: List of datasets passed to web endpoint.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.DatasetReference>]
- name: linked_services
description: List of linked services passed to web endpoint.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.LinkedServiceReference>]
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Linked service reference.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Activity policy.
- name: policy
- types:
- - <xref:azure.synapse.artifacts.models.ActivityPolicy>
-- description: 'Rest API method for target endpoint. Required. Known values are: "GET",
- "POST",
-
- "PUT", and "DELETE".'
- name: method
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.WebActivityMethod>
-- description: 'Web activity target endpoint and path. Type: string (or Expression
- with resultType
-
- string). Required.'
- name: url
- types:
- - <xref:JSON>
-- 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).'
- name: headers
- types:
- - <xref:JSON>
-- 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).'
- name: body
- types:
- - <xref:JSON>
-- description: Authentication method used for calling the endpoint.
- name: authentication
- types:
- - <xref:azure.synapse.artifacts.models.WebActivityAuthentication>
-- description: List of datasets passed to web endpoint.
- name: datasets
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.DatasetReference>]
-- description: List of linked services passed to web endpoint.
- name: linked_services
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.LinkedServiceReference>]
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivityAuthentication.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivityAuthentication.yml
index d848a2d5a64a..8d6feeb5b782 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivityAuthentication.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivityAuthentication.yml
@@ -4,82 +4,41 @@ name: WebActivityAuthentication
fullName: azure.synapse.artifacts.models.WebActivityAuthentication
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'Web activity authentication properties.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'WebActivityAuthentication(*, type: str, pfx: _models.SecretBase | None
- = None, username: str | None = None, password: _models.SecretBase | None = None,
- resource: MutableMapping[str, Any] | None = None, user_tenant: MutableMapping[str,
- Any] | None = None, credential: _models.CredentialReference | None = None, **kwargs:
- Any)'
+ 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: Web activity authentication (Basic/ClientCertificate/MSI). Required.
+ description: Required. Web activity authentication (Basic/ClientCertificate/MSI).
+ isRequired: true
types:
- <xref:str>
- name: pfx
description: Base64-encoded contents of a PFX file.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: username
description: Web activity authentication user name for basic authentication.
+ isRequired: true
types:
- <xref:str>
- name: password
description: Password for the PFX file or basic authentication.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: resource
description: 'Resource for which Azure Auth token will be requested when using
MSI
- Authentication. Type: string (or Expression with resultType string).'
+ Authentication.'
+ isRequired: true
types:
- - <xref:JSON>
- - name: user_tenant
- description: 'TenantId for which Azure Auth token will be requested when using
-
- ServicePrincipal Authentication. Type: string (or Expression with resultType
- string).'
- types:
- - <xref:JSON>
- - name: credential
- description: The credential reference containing authentication information.
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
-variables:
-- description: Web activity authentication (Basic/ClientCertificate/MSI). Required.
- name: type
- types:
- - <xref:str>
-- description: Base64-encoded contents of a PFX file.
- name: pfx
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: Web activity authentication user name for basic authentication.
- name: username
- types:
- - <xref:str>
-- description: Password for the PFX file or basic authentication.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Resource for which Azure Auth token will be requested when using MSI
-
- Authentication. Type: string (or Expression with resultType string).'
- name: resource
- types:
- - <xref:JSON>
-- description: 'TenantId for which Azure Auth token will be requested when using
-
- ServicePrincipal Authentication. Type: string (or Expression with resultType string).'
- name: user_tenant
- types:
- - <xref:JSON>
-- description: The credential reference containing authentication information.
- name: credential
- types:
- - <xref:azure.synapse.artifacts.models.CredentialReference>
+ - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivityMethod.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivityMethod.yml
index 4b033b9bed29..0de7a357f4ac 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivityMethod.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivityMethod.yml
@@ -11,11 +11,11 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebAnonymousAuthentication.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebAnonymousAuthentication.yml
index c401b20846e8..d7f7174d9926 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebAnonymousAuthentication.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebAnonymousAuthentication.yml
@@ -11,28 +11,23 @@ summary: 'A WebLinkedService that uses anonymous authentication to communicate w
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'WebAnonymousAuthentication(*, url: MutableMapping[str, Any], **kwargs:
- Any)'
+ syntax: 'WebAnonymousAuthentication(*, url: object, **kwargs)'
parameters:
- name: url
- description: 'The URL of the web service endpoint, e.g. [http://www.microsoft.com](http://www.microsoft.com)
- . Type: string
+ description: 'Required. The URL of the web service endpoint, e.g. [http://www.microsoft.com](http://www.microsoft.com)
+ .
- (or Expression with resultType string). Required.'
+ Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'The URL of the web service endpoint, e.g. [http://www.microsoft.com](http://www.microsoft.com)
- . Type: string
+ - <xref:object>
+ - name: authentication_type
+ description: 'Required. Type of authentication used to connect to the web table
- (or Expression with resultType string). Required.'
- name: url
- types:
- - <xref:JSON>
-- description: 'Type of authentication used to connect to the web table source.
+ source.Constant filled by server. Possible values include: "Basic", "Anonymous",
- Required. Known values are: "Basic", "Anonymous", and "ClientCertificate".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.WebAuthenticationType>
+ "ClientCertificate".'
+ isRequired: true
+ types:
+ - <xref:str>
+ - <xref:azure.synapse.artifacts.models.WebAuthenticationType>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebAuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebAuthenticationType.yml
index e7803c450515..96582558641d 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebAuthenticationType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebAuthenticationType.yml
@@ -11,9 +11,9 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebBasicAuthentication.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebBasicAuthentication.yml
index bf58f3cd8a9e..3160622415c4 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebBasicAuthentication.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebBasicAuthentication.yml
@@ -11,50 +11,37 @@ summary: 'A WebLinkedService that uses basic authentication to communicate with
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'WebBasicAuthentication(*, url: MutableMapping[str, Any], username: MutableMapping[str,
- Any], password: _models.SecretBase, **kwargs: Any)'
+ syntax: 'WebBasicAuthentication(*, url: object, username: object, password: SecretBase,
+ **kwargs)'
parameters:
- name: url
- description: 'The URL of the web service endpoint, e.g. [http://www.microsoft.com](http://www.microsoft.com)
- . Type: string
+ description: 'Required. The URL of the web service endpoint, e.g. [http://www.microsoft.com](http://www.microsoft.com)
+ .
- (or Expression with resultType string). Required.'
+ Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
+ - 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:
+ - <xref:str>
+ - <xref:azure.synapse.artifacts.models.WebAuthenticationType>
- name: username
- description: 'User name for Basic authentication. Type: string (or Expression
+ description: 'Required. User name for Basic authentication. Type: string (or Expression
with
- resultType string). Required.'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: password
- description: The password for Basic authentication. Required.
+ description: Required. The password for Basic authentication.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
-variables:
-- description: 'The URL of the web service endpoint, e.g. [http://www.microsoft.com](http://www.microsoft.com)
- . Type: string
-
- (or Expression with resultType string). Required.'
- name: url
- types:
- - <xref:JSON>
-- description: 'Type of authentication used to connect to the web table source.
-
- Required. Known values are: "Basic", "Anonymous", and "ClientCertificate".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.WebAuthenticationType>
-- description: 'User name for Basic authentication. Type: string (or Expression with
- resultType
-
- string). Required.'
- name: username
- types:
- - <xref:JSON>
-- description: The password for Basic authentication. Required.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebClientCertificateAuthentication.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebClientCertificateAuthentication.yml
index 5a47eb6d6c15..377e12f3d112 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebClientCertificateAuthentication.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebClientCertificateAuthentication.yml
@@ -6,54 +6,40 @@ module: azure.synapse.artifacts.models
inheritances:
- azure.synapse.artifacts.models._models_py3.WebLinkedServiceTypeProperties
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.
+ 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: MutableMapping[str, Any], pfx:
- _models.SecretBase, password: _models.SecretBase, **kwargs: Any)'
+ syntax: 'WebClientCertificateAuthentication(*, url: object, pfx: SecretBase, password:
+ SecretBase, **kwargs)'
parameters:
- name: url
- description: 'The URL of the web service endpoint, e.g. [http://www.microsoft.com](http://www.microsoft.com)
- . Type: string
+ description: 'Required. The URL of the web service endpoint, e.g. [http://www.microsoft.com](http://www.microsoft.com)
+ .
- (or Expression with resultType string). Required.'
+ Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
+ - 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:
+ - <xref:str>
+ - <xref:azure.synapse.artifacts.models.WebAuthenticationType>
- name: pfx
- description: Base64-encoded contents of a PFX file. Required.
+ description: Required. Base64-encoded contents of a PFX file.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: password
- description: Password for the PFX file. Required.
+ description: Required. Password for the PFX file.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
-variables:
-- description: 'The URL of the web service endpoint, e.g. [http://www.microsoft.com](http://www.microsoft.com)
- . Type: string
-
- (or Expression with resultType string). Required.'
- name: url
- types:
- - <xref:JSON>
-- description: 'Type of authentication used to connect to the web table source.
-
- Required. Known values are: "Basic", "Anonymous", and "ClientCertificate".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.WebAuthenticationType>
-- description: Base64-encoded contents of a PFX file. Required.
- name: pfx
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: Password for the PFX file. Required.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebHookActivity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebHookActivity.yml
index 7a29916eb8e4..18f5c4720054 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebHookActivity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebHookActivity.yml
@@ -4,74 +4,62 @@ name: WebHookActivity
fullName: azure.synapse.artifacts.models.WebHookActivity
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts.models._models_py3.ControlActivity
+- azure.synapse.artifacts.models._models_py3.Activity
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, method: str | _models.WebHookActivityMethod,
- url: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, state: str | _models.ActivityState
- | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None
- = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties:
- List[_models.UserProperty] | None = None, timeout: str | None = None, headers:
- MutableMapping[str, Any] | None = None, body: MutableMapping[str, Any] | None
- = None, authentication: _models.WebActivityAuthentication | None = None, report_status_on_call_back:
- MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
- name: name
- description: Activity name. Required.
+ description: Required. Activity name.
+ isRequired: true
types:
- <xref:str>
- - name: description
- description: Activity description.
- types:
- - <xref:str>
- - name: state
- description: 'Activity state. This is an optional property and if not provided,
- the state
-
- will be Active by default. Known values are: "Active" and "Inactive".'
+ - name: type
+ description: Required. Type of activity.Constant filled by server.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
- - name: on_inactive_mark_as
- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
+ - name: description
+ description: Activity description.
+ isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
- name: depends_on
description: Activity depends on condition.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
- name: user_properties
description: Activity user properties.
+ isRequired: true
types:
- <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
- - name: method
- description: Rest API method for target endpoint. Required. "POST"
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.WebHookActivityMethod>
- name: url
- description: 'WebHook activity target endpoint and path. Type: string (or Expression
- with
+ description: 'Required. WebHook activity target endpoint and path. Type: string
+ (or Expression
- resultType string). Required.'
+ with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: timeout
description: 'The timeout within which the webhook should be called back. If there
is no
@@ -79,6 +67,7 @@ constructor:
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:
- <xref:str>
- name: headers
@@ -89,128 +78,37 @@ constructor:
"Content-Type":
"application/json" }. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: authentication
description: Authentication method used for calling the endpoint.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.WebActivityAuthentication>
- name: report_status_on_call_back
- description: 'When set to true, statusCode, output and error in callback
-
- request body will be consumed by activity. The activity can be marked as failed
- by setting
-
- statusCode >= 400 in callback request. Default is false. Type: boolean (or Expression
- with
-
- resultType boolean).'
+ 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:
- - <xref:JSON>
+ - <xref:object>
variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Activity name. Required.
- name: name
- types:
- - <xref:str>
-- description: Type of activity. Required.
- name: type
- types:
- - <xref:str>
-- description: Activity description.
- name: description
- types:
- - <xref:str>
-- description: 'Activity state. This is an optional property and if not provided,
- the state will
-
- be Active by default. Known values are: "Active" and "Inactive".'
- name: state
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityState>
-- description: 'Status result of the activity when the state is set to Inactive.
-
- This is an optional property and if not provided when the activity is inactive,
- the status will
-
- be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".'
- name: on_inactive_mark_as
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ActivityOnInactiveMarkAs>
-- description: Activity depends on condition.
- name: depends_on
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.ActivityDependency>]
-- description: Activity user properties.
- name: user_properties
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.UserProperty>]
-- description: Rest API method for target endpoint. Required. "POST"
+- description: 'Required. Rest API method for target endpoint. Default value: "POST".'
name: method
types:
- <xref:str>
- - <xref:azure.synapse.artifacts.models.WebHookActivityMethod>
-- description: 'WebHook activity target endpoint and path. Type: string (or Expression
- with
-
- resultType string). Required.'
- name: url
- types:
- - <xref:JSON>
-- 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])).'
- name: timeout
- types:
- - <xref:str>
-- 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).'
- name: headers
- types:
- - <xref:JSON>
-- 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).'
- name: body
- types:
- - <xref:JSON>
-- description: Authentication method used for calling the endpoint.
- name: authentication
- types:
- - <xref:azure.synapse.artifacts.models.WebActivityAuthentication>
-- description: 'When set to true, statusCode, output and error in callback
-
- request body will be consumed by activity. The activity can be marked as failed
- by setting
-
- statusCode >= 400 in callback request. Default is false. Type: boolean (or Expression
- with
-
- resultType boolean).'
- name: report_status_on_call_back
- types:
- - <xref:JSON>
+attributes:
+- uid: azure.synapse.artifacts.models.WebHookActivity.method
+ name: method
+ signature: method = 'POST'
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebHookActivityMethod.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebHookActivityMethod.yml
deleted file mode 100644
index d58631fd7d31..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebHookActivityMethod.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.WebHookActivityMethod
-name: WebHookActivityMethod
-fullName: azure.synapse.artifacts.models.WebHookActivityMethod
-summary: The list of HTTP methods supported by a WebHook activity.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: WebHookActivityMethod(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: POST
- uid: azure.synapse.artifacts.models.WebHookActivityMethod.POST
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebLinkedService.yml
index cd6b77ab1e39..4f3a649850ff 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebLinkedService.yml
@@ -10,66 +10,45 @@ summary: 'Web linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'WebLinkedService(*, type_properties: _models.WebLinkedServiceTypeProperties,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, connect_via:
- _models.IntegrationRuntimeReference | None = None, description: str | None = None,
- parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations:
- List[MutableMapping[str, Any]] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: type_properties
- description: Web linked service properties. Required.
+ description: Required. Web linked service properties.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.WebLinkedServiceTypeProperties>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: Web linked service properties. Required.
- name: type_properties
- types:
- - <xref:azure.synapse.artifacts.models.WebLinkedServiceTypeProperties>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebLinkedServiceTypeProperties.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebLinkedServiceTypeProperties.yml
index 855ad2cc5d6c..6de1b3d2908a 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebLinkedServiceTypeProperties.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebLinkedServiceTypeProperties.yml
@@ -4,43 +4,35 @@ name: WebLinkedServiceTypeProperties
fullName: azure.synapse.artifacts.models.WebLinkedServiceTypeProperties
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'Base definition of WebLinkedServiceTypeProperties, this typeProperties is
- polymorphic based on
+ polymorphic based on authenticationType, so not flattened in SDK models.
- authenticationType, so not flattened in SDK models.
+ You probably want to use the sub-classes and not this class directly. Known
- You probably want to use the sub-classes and not this class directly. Known sub-classes
- are:
-
- WebAnonymousAuthentication, WebBasicAuthentication, WebClientCertificateAuthentication
+ sub-classes are: WebAnonymousAuthentication, WebBasicAuthentication, WebClientCertificateAuthentication.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'WebLinkedServiceTypeProperties(*, url: MutableMapping[str, Any], **kwargs:
- Any)'
+ syntax: 'WebLinkedServiceTypeProperties(*, url: object, **kwargs)'
parameters:
- name: url
- description: 'The URL of the web service endpoint, e.g. [http://www.microsoft.com](http://www.microsoft.com)
- . Type: string
+ 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:
+ - <xref:object>
+ - 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",
- (or Expression with resultType string). Required.'
+ "ClientCertificate".'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'The URL of the web service endpoint, e.g. [http://www.microsoft.com](http://www.microsoft.com)
- . Type: string
-
- (or Expression with resultType string). Required.'
- name: url
- types:
- - <xref:JSON>
-- description: 'Type of authentication used to connect to the web table source.
-
- Required. Known values are: "Basic", "Anonymous", and "ClientCertificate".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.WebAuthenticationType>
+ - <xref:str>
+ - <xref:azure.synapse.artifacts.models.WebAuthenticationType>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebSource.yml
deleted file mode 100644
index f9aa80782ec8..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebSource.yml
+++ /dev/null
@@ -1,84 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.WebSource
-name: WebSource
-fullName: azure.synapse.artifacts.models.WebSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity source for web page table.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'WebSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, additional_columns: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebTableDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebTableDataset.yml
index 98363f539f2f..87a499837486 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebTableDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebTableDataset.yml
@@ -10,129 +10,82 @@ 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: _models.LinkedServiceReference,
- index: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, description: str | None = None, structure: MutableMapping[str,
- Any] | None = None, schema: MutableMapping[str, Any] | None = None, parameters:
- Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str,
- Any]] | None = None, folder: _models.DatasetFolder | None = None, path: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: index
- description: 'The zero-based index of the table in the web page. Type: integer
- (or Expression
+ description: 'Required. The zero-based index of the table in the web page. Type:
+ integer (or
- with resultType integer), minimum: 0. Required.'
+ Expression with resultType integer), minimum: 0.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The zero-based index of the table in the web page. Type: integer (or
- Expression
-
- with resultType integer), minimum: 0. Required.'
- name: index
- types:
- - <xref:JSON>
-- description: 'The relative URL to the web page from the linked service URL. Type:
- string (or
-
- Expression with resultType string).'
- name: path
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Workspace.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Workspace.yml
index a1b9be4ee992..359a6a92530d 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Workspace.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Workspace.yml
@@ -4,198 +4,75 @@ name: Workspace
fullName: azure.synapse.artifacts.models.Workspace
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts.models._models_py3.TrackedResource
-summary: 'A workspace.
+- azure.synapse.artifacts.models._models_py3.Resource
+summary: 'Workspace 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.'
+ Variables are only populated by the server, and will be ignored when sending a request.'
constructor:
- syntax: 'Workspace(*, location: str, tags: Dict[str, str] | None = None, identity:
- _models.ManagedIdentity | None = None, default_data_lake_storage: _models.DataLakeStorageAccountDetails
- | None = None, sql_administrator_login_password: str | None = None, managed_resource_group_name:
- str | None = None, sql_administrator_login: str | None = None, virtual_network_profile:
- _models.VirtualNetworkProfile | None = None, connectivity_endpoints: Dict[str,
- str] | None = None, managed_virtual_network: str | None = None, private_endpoint_connections:
- List[_models.PrivateEndpointConnection] | None = None, encryption: _models.EncryptionDetails
- | None = None, managed_virtual_network_settings: _models.ManagedVirtualNetworkSettings
- | None = None, workspace_repository_configuration: _models.WorkspaceRepositoryConfiguration
- | None = None, purview_configuration: _models.PurviewConfiguration | None = None,
- **kwargs: Any)'
+ 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: tags
- description: Resource tags.
- types:
- - <xref:dict>[<xref:str>, <xref:str>]
- name: location
- description: The geo-location where the resource lives. Required.
+ description: The resource location.
+ isRequired: true
types:
- <xref:str>
- - name: identity
- description: Identity of the workspace.
- types:
- - <xref:azure.synapse.artifacts.models.ManagedIdentity>
- - name: default_data_lake_storage
- description: Workspace default data lake storage account details.
- types:
- - <xref:azure.synapse.artifacts.models.DataLakeStorageAccountDetails>
- - name: sql_administrator_login_password
- description: SQL administrator login password.
- types:
- - <xref:str>
- - name: managed_resource_group_name
- description: 'Workspace managed resource group. The resource group name
-
- uniquely identifies the resource group within the user subscriptionId. The resource
- group name
-
- must be no longer than 90 characters long, and must be alphanumeric characters
-
- (Char.IsLetterOrDigit()) and ''-'', ''_'', ''('', '')'' and''.''. Note that
- the name cannot end with ''.''.'
- types:
- - <xref:str>
- - name: sql_administrator_login
- description: Login for workspace SQL active directory administrator.
- types:
- - <xref:str>
- - name: virtual_network_profile
- description: Virtual Network profile.
- types:
- - <xref:azure.synapse.artifacts.models.VirtualNetworkProfile>
- - name: connectivity_endpoints
- description: Connectivity endpoints.
+ - name: tags
+ description: A set of tags. The resource tags.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:str>]
- - name: managed_virtual_network
- description: 'Setting this to ''default'' will ensure that all compute for
+ - name: additional_properties
+ description: 'Unmatched properties from the message are deserialized to this
- this workspace is in a virtual network managed on behalf of the user.'
+ collection.'
+ isRequired: true
types:
- - <xref:str>
- - name: private_endpoint_connections
- description: Private endpoint connections to the workspace.
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.PrivateEndpointConnection>]
- - name: encryption
- description: The encryption details of the workspace.
- types:
- - <xref:azure.synapse.artifacts.models.EncryptionDetails>
- - name: managed_virtual_network_settings
- description: Managed Virtual Network Settings.
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: identity
+ description: Managed service identity of the workspace.
+ isRequired: true
types:
- - <xref:azure.synapse.artifacts.models.ManagedVirtualNetworkSettings>
- - name: workspace_repository_configuration
- description: Git integration settings.
+ - <xref:azure.synapse.artifacts.models.WorkspaceIdentity>
+ - name: default_storage
+ description: Linked service reference.
+ isRequired: true
types:
- - <xref:azure.synapse.artifacts.models.WorkspaceRepositoryConfiguration>
- - name: purview_configuration
- description: Purview Configuration.
+ - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
+ - name: default_sql_server
+ description: Linked service reference.
+ isRequired: true
types:
- - <xref:azure.synapse.artifacts.models.PurviewConfiguration>
+ - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
variables:
-- description: 'Fully qualified resource ID for the resource. Ex -
-
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.'
+- description: The resource identifier.
name: id
types:
- <xref:str>
-- description: The name of the resource.
+- description: The resource name.
name: name
types:
- <xref:str>
-- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines"
- or
-
- "Microsoft.Storage/storageAccounts".'
+- description: The resource type.
name: type
types:
- <xref:str>
-- description: Resource tags.
- name: tags
- types:
- - <xref:dict>[<xref:str>, <xref:str>]
-- description: The geo-location where the resource lives. Required.
- name: location
- types:
- - <xref:str>
-- description: Identity of the workspace.
- name: identity
- types:
- - <xref:azure.synapse.artifacts.models.ManagedIdentity>
-- description: Workspace default data lake storage account details.
- name: default_data_lake_storage
- types:
- - <xref:azure.synapse.artifacts.models.DataLakeStorageAccountDetails>
-- description: SQL administrator login password.
- name: sql_administrator_login_password
- types:
- - <xref:str>
-- description: 'Workspace managed resource group. The resource group name
-
- uniquely identifies the resource group within the user subscriptionId. The resource
- group name
-
- must be no longer than 90 characters long, and must be alphanumeric characters
-
- (Char.IsLetterOrDigit()) and ''-'', ''_'', ''('', '')'' and''.''. Note that the
- name cannot end with ''.''.'
- name: managed_resource_group_name
+- description: Etag identifies change in the resource.
+ name: e_tag
types:
- <xref:str>
-- description: Resource provisioning state.
+- description: Workspace provisioning state, example Succeeded.
name: provisioning_state
types:
- <xref:str>
-- description: Login for workspace SQL active directory administrator.
- name: sql_administrator_login
- types:
- - <xref:str>
-- description: Virtual Network profile.
- name: virtual_network_profile
- types:
- - <xref:azure.synapse.artifacts.models.VirtualNetworkProfile>
-- description: Connectivity endpoints.
- name: connectivity_endpoints
- types:
- - <xref:dict>[<xref:str>, <xref:str>]
-- description: 'Setting this to ''default'' will ensure that all compute for this
-
- workspace is in a virtual network managed on behalf of the user.'
- name: managed_virtual_network
- types:
- - <xref:str>
-- description: Private endpoint connections to the workspace.
- name: private_endpoint_connections
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.PrivateEndpointConnection>]
-- description: The encryption details of the workspace.
- name: encryption
- types:
- - <xref:azure.synapse.artifacts.models.EncryptionDetails>
-- description: The workspace unique identifier.
- name: workspace_uid
- types:
- - <xref:str>
-- description: Workspace level configs and feature flags.
- name: extra_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Managed Virtual Network Settings.
- name: managed_virtual_network_settings
- types:
- - <xref:azure.synapse.artifacts.models.ManagedVirtualNetworkSettings>
-- description: Git integration settings.
- name: workspace_repository_configuration
- types:
- - <xref:azure.synapse.artifacts.models.WorkspaceRepositoryConfiguration>
-- description: Purview Configuration.
- name: purview_configuration
+- description: Time the workspace was created in ISO8601 format.
+ name: create_time
types:
- - <xref:azure.synapse.artifacts.models.PurviewConfiguration>
-- description: The ADLA resource ID.
- name: adla_resource_id
+ - <xref:datetime.datetime>
+- description: Version of the workspace.
+ name: version
types:
- <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceIdentity.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceIdentity.yml
index 96aed7572817..ce4b7a510217 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceIdentity.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceIdentity.yml
@@ -4,7 +4,7 @@ name: WorkspaceIdentity
fullName: azure.synapse.artifacts.models.WorkspaceIdentity
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: 'Identity properties of the workspace resource.
@@ -13,12 +13,12 @@ summary: 'Identity properties of the workspace resource.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'WorkspaceIdentity(**kwargs: Any)'
+ syntax: WorkspaceIdentity(**kwargs)
variables:
-- description: 'The identity type. Currently the only supported type is ''SystemAssigned''.
- Required.
+- description: 'Required. The identity type. Currently the only supported type is
+ ''SystemAssigned''.
- Default value is "SystemAssigned".'
+ Default value: "SystemAssigned".'
name: type
types:
- <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceKeyDetails.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceKeyDetails.yml
deleted file mode 100644
index 82916be03f71..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceKeyDetails.yml
+++ /dev/null
@@ -1,29 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.WorkspaceKeyDetails
-name: WorkspaceKeyDetails
-fullName: azure.synapse.artifacts.models.WorkspaceKeyDetails
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Details of the customer managed key associated with the workspace.
-constructor:
- syntax: 'WorkspaceKeyDetails(*, name: str | None = None, key_vault_url: str | None
- = None, **kwargs: Any)'
- parameters:
- - name: name
- description: Workspace Key sub-resource name.
- types:
- - <xref:str>
- - name: key_vault_url
- description: Workspace Key sub-resource key vault url.
- types:
- - <xref:str>
-variables:
-- description: Workspace Key sub-resource name.
- name: name
- types:
- - <xref:str>
-- description: Workspace Key sub-resource key vault url.
- name: key_vault_url
- types:
- - <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceRepositoryConfiguration.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceRepositoryConfiguration.yml
deleted file mode 100644
index b6f1284a5d62..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceRepositoryConfiguration.yml
+++ /dev/null
@@ -1,109 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.WorkspaceRepositoryConfiguration
-name: WorkspaceRepositoryConfiguration
-fullName: azure.synapse.artifacts.models.WorkspaceRepositoryConfiguration
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts._serialization.Model
-summary: Git integration settings.
-constructor:
- syntax: 'WorkspaceRepositoryConfiguration(*, type: str | None = None, host_name:
- str | None = None, account_name: str | None = None, project_name: str | None =
- None, repository_name: str | None = None, collaboration_branch: str | None = None,
- root_folder: str | None = None, last_commit_id: str | None = None, tenant_id:
- str | None = None, client_id: str | None = None, client_secret: _models.GitHubClientSecret
- | None = None, **kwargs: Any)'
- parameters:
- - name: type
- description: 'Type of workspace repositoryID configuration. Example
-
- WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration.'
- types:
- - <xref:str>
- - name: host_name
- description: 'GitHub Enterprise host name. For example: [https://github.mydomain.com](https://github.mydomain.com).'
- types:
- - <xref:str>
- - name: account_name
- description: Account name.
- types:
- - <xref:str>
- - name: project_name
- description: VSTS project name.
- types:
- - <xref:str>
- - name: repository_name
- description: Repository name.
- types:
- - <xref:str>
- - name: collaboration_branch
- description: Collaboration branch.
- types:
- - <xref:str>
- - name: root_folder
- description: Root folder to use in the repository.
- types:
- - <xref:str>
- - name: last_commit_id
- description: The last commit ID.
- types:
- - <xref:str>
- - name: tenant_id
- description: The VSTS tenant ID.
- types:
- - <xref:str>
- - name: client_id
- description: GitHub bring your own app client id.
- types:
- - <xref:str>
- - name: client_secret
- description: GitHub bring your own app client secret information.
- types:
- - <xref:azure.synapse.artifacts.models.GitHubClientSecret>
-variables:
-- description: 'Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration,
-
- WorkspaceGitHubConfiguration.'
- name: type
- types:
- - <xref:str>
-- description: 'GitHub Enterprise host name. For example: [https://github.mydomain.com](https://github.mydomain.com).'
- name: host_name
- types:
- - <xref:str>
-- description: Account name.
- name: account_name
- types:
- - <xref:str>
-- description: VSTS project name.
- name: project_name
- types:
- - <xref:str>
-- description: Repository name.
- name: repository_name
- types:
- - <xref:str>
-- description: Collaboration branch.
- name: collaboration_branch
- types:
- - <xref:str>
-- description: Root folder to use in the repository.
- name: root_folder
- types:
- - <xref:str>
-- description: The last commit ID.
- name: last_commit_id
- types:
- - <xref:str>
-- description: The VSTS tenant ID.
- name: tenant_id
- types:
- - <xref:str>
-- description: GitHub bring your own app client id.
- name: client_id
- types:
- - <xref:str>
-- description: GitHub bring your own app client secret information.
- name: client_secret
- types:
- - <xref:azure.synapse.artifacts.models.GitHubClientSecret>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceUpdateParameters.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceUpdateParameters.yml
index b31309524d87..be8b72533b63 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceUpdateParameters.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceUpdateParameters.yml
@@ -4,26 +4,19 @@ name: WorkspaceUpdateParameters
fullName: azure.synapse.artifacts.models.WorkspaceUpdateParameters
module: azure.synapse.artifacts.models
inheritances:
-- azure.synapse.artifacts._serialization.Model
+- msrest.serialization.Model
summary: Parameters for updating a workspace resource.
constructor:
syntax: 'WorkspaceUpdateParameters(*, tags: Dict[str, str] | None = None, identity:
- _models.WorkspaceIdentity | None = None, **kwargs: Any)'
+ WorkspaceIdentity | None = None, **kwargs)'
parameters:
- name: tags
- description: The resource tags.
+ description: A set of tags. The resource tags.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:str>]
- name: identity
description: Managed service identity of the workspace.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.WorkspaceIdentity>
-variables:
-- description: The resource tags.
- name: tags
- types:
- - <xref:dict>[<xref:str>, <xref:str>]
-- description: Managed service identity of the workspace.
- name: identity
- types:
- - <xref:azure.synapse.artifacts.models.WorkspaceIdentity>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroLinkedService.yml
index cb0debf3b1ac..8c68a6717677 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroLinkedService.yml
@@ -10,69 +10,74 @@ summary: 'Xero Service linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'XeroLinkedService(*, host: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, connection_properties:
- MutableMapping[str, Any] | None = None, consumer_key: _models.SecretBase | None
- = None, private_key: _models.SecretBase | None = None, use_encrypted_endpoints:
- MutableMapping[str, Any] | None = None, use_host_verification: MutableMapping[str,
- Any] | None = None, use_peer_verification: MutableMapping[str, Any] | None = None,
- encrypted_credential: MutableMapping[str, Any] | None = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
- - name: connection_properties
- description: 'Properties used to connect to Xero. It is mutually exclusive
-
- with any other properties in the linked service. Type: object.'
- types:
- - <xref:JSON>
+ - <xref:list>[<xref:object>]
- name: host
- description: The endpoint of the Xero server. (i.e. api.xero.com). Required.
+ description: Required. The endpoint of the Xero server. (i.e. api.xero.com).
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: consumer_key
description: The consumer key associated with the Xero application.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: private_key
description: 'The private key from the .pem file that was generated for your Xero
+ private
- private application. You must include all the text from the .pem file, including
- the Unix line
-
- endings(
+ application. You must include all the text from the .pem file, including the
+ Unix line endings(
).'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: use_encrypted_endpoints
- description: 'Specifies whether the data source endpoints are encrypted
+ description: 'Specifies whether the data source endpoints are encrypted using
- using HTTPS. The default value is true.'
+ HTTPS. The default value is true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_host_verification
description: 'Specifies whether to require the host name in the server''s
@@ -80,101 +85,23 @@ constructor:
default value is
true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Properties used to connect to Xero. It is mutually exclusive with
-
- any other properties in the linked service. Type: object.'
- name: connection_properties
- types:
- - <xref:JSON>
-- description: The endpoint of the Xero server. (i.e. api.xero.com). Required.
- name: host
- types:
- - <xref:JSON>
-- description: The consumer key associated with the Xero application.
- name: consumer_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- 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(
-
- ).'
- name: private_key
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Specifies whether the data source endpoints are encrypted using
-
- HTTPS. The default value is true.'
- name: use_encrypted_endpoints
- types:
- - <xref:JSON>
-- 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.'
- name: use_host_verification
- types:
- - <xref:JSON>
-- description: 'Specifies whether to verify the identity of the server when
-
- connecting over SSL. The default value is true.'
- name: use_peer_verification
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroObjectDataset.yml
index f8a20ae4c8a0..f520fbd6d09e 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroObjectDataset.yml
@@ -10,109 +10,70 @@ summary: 'Xero Service dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'XeroObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The table name. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroSource.yml
deleted file mode 100644
index 688af5001e30..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.XeroSource
-name: XeroSource
-fullName: azure.synapse.artifacts.models.XeroSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Xero Service source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'XeroSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XmlDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XmlDataset.yml
deleted file mode 100644
index 65fdcb2d9995..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XmlDataset.yml
+++ /dev/null
@@ -1,168 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.XmlDataset
-name: XmlDataset
-fullName: azure.synapse.artifacts.models.XmlDataset
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.Dataset
-summary: 'Xml dataset.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'XmlDataset(*, linked_service_name: _models.LinkedServiceReference, additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None,
- structure: MutableMapping[str, Any] | None = None, schema: MutableMapping[str,
- Any] | None = None, parameters: Dict[str, _models.ParameterSpecification] | None
- = None, annotations: List[MutableMapping[str, Any]] | None = None, folder: _models.DatasetFolder
- | None = None, location: _models.DatasetLocation | None = None, encoding_name:
- MutableMapping[str, Any] | None = None, null_value: MutableMapping[str, Any] |
- None = None, compression: _models.DatasetCompression | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: description
- description: Dataset description.
- types:
- - <xref:str>
- - name: structure
- description: 'Columns that define the structure of the dataset. Type: array (or
-
- Expression with resultType array), itemType: DatasetDataElement.'
- types:
- - <xref:JSON>
- - name: schema
- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- types:
- - <xref:JSON>
- - name: linked_service_name
- description: Linked service reference. Required.
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- - name: parameters
- description: Parameters for dataset.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the Dataset.
- types:
- - <xref:list>[<xref:JSON>]
- - name: folder
- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
-
- the root level.'
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
- - name: location
- description: The location of the json data storage.
- types:
- - <xref:azure.synapse.artifacts.models.DatasetLocation>
- - 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).'
- types:
- - <xref:JSON>
- - name: null_value
- description: 'The null value string. Type: string (or Expression with resultType
-
- string).'
- types:
- - <xref:JSON>
- - name: compression
- description: The data compression method used for the json dataset.
- types:
- - <xref:azure.synapse.artifacts.models.DatasetCompression>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: The location of the json data storage.
- name: location
- types:
- - <xref:azure.synapse.artifacts.models.DatasetLocation>
-- 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).'
- name: encoding_name
- types:
- - <xref:JSON>
-- description: 'The null value string. Type: string (or Expression with resultType
- string).'
- name: null_value
- types:
- - <xref:JSON>
-- description: The data compression method used for the json dataset.
- name: compression
- types:
- - <xref:azure.synapse.artifacts.models.DatasetCompression>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XmlReadSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XmlReadSettings.yml
deleted file mode 100644
index 018798e69a46..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XmlReadSettings.yml
+++ /dev/null
@@ -1,108 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.XmlReadSettings
-name: XmlReadSettings
-fullName: azure.synapse.artifacts.models.XmlReadSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.FormatReadSettings
-summary: 'Xml read settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'XmlReadSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, compression_properties: _models.CompressionReadSettings |
- None = None, validation_mode: MutableMapping[str, Any] | None = None, detect_data_type:
- MutableMapping[str, Any] | None = None, namespaces: MutableMapping[str, Any] |
- None = None, namespace_prefixes: MutableMapping[str, Any] | None = None, **kwargs:
- Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: compression_properties
- description: Compression settings.
- types:
- - <xref:azure.synapse.artifacts.models.CompressionReadSettings>
- - name: validation_mode
- description: 'Indicates what validation method is used when reading the xml files.
-
- Allowed values: ''none'', ''xsd'', or ''dtd''. Type: string (or Expression with
- resultType string).'
- types:
- - <xref:JSON>
- - name: detect_data_type
- description: 'Indicates whether type detection is enabled when reading the xml
-
- files. Type: boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: namespaces
- description: 'Indicates whether namespace is enabled when reading the xml files.
- Type:
-
- boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
- - name: namespace_prefixes
- description: 'Namespace uri to prefix mappings to override the prefixes in
-
- column names when namespace is enabled, if no prefix is defined for a namespace
- uri, the prefix
-
- of xml element/attribute name in the xml data file will be used. Example:
-
- "{"[http://www.example.com/xml](http://www.example.com/xml)":"prefix"}" Type:
- object (or Expression with resultType object).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The read setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: Compression settings.
- name: compression_properties
- types:
- - <xref:azure.synapse.artifacts.models.CompressionReadSettings>
-- description: 'Indicates what validation method is used when reading the xml files.
-
- Allowed values: ''none'', ''xsd'', or ''dtd''. Type: string (or Expression with
- resultType string).'
- name: validation_mode
- types:
- - <xref:JSON>
-- description: 'Indicates whether type detection is enabled when reading the xml files.
-
- Type: boolean (or Expression with resultType boolean).'
- name: detect_data_type
- types:
- - <xref:JSON>
-- description: 'Indicates whether namespace is enabled when reading the xml files.
- Type:
-
- boolean (or Expression with resultType boolean).'
- name: namespaces
- types:
- - <xref:JSON>
-- description: 'Namespace uri to prefix mappings to override the prefixes in column
-
- names when namespace is enabled, if no prefix is defined for a namespace uri,
- the prefix of xml
-
- element/attribute name in the xml data file will be used. Example:
-
- "{"[http://www.example.com/xml](http://www.example.com/xml)":"prefix"}" Type:
- object (or Expression with resultType object).'
- name: namespace_prefixes
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XmlSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XmlSource.yml
deleted file mode 100644
index 224d72761de5..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XmlSource.yml
+++ /dev/null
@@ -1,101 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.XmlSource
-name: XmlSource
-fullName: azure.synapse.artifacts.models.XmlSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CopySource
-summary: 'A copy activity Xml source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'XmlSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, store_settings: _models.StoreReadSettings | None = None, format_settings:
- _models.XmlReadSettings | None = None, additional_columns: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: store_settings
- description: Xml store settings.
- types:
- - <xref:azure.synapse.artifacts.models.StoreReadSettings>
- - name: format_settings
- description: Xml format settings.
- types:
- - <xref:azure.synapse.artifacts.models.XmlReadSettings>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: Xml store settings.
- name: store_settings
- types:
- - <xref:azure.synapse.artifacts.models.StoreReadSettings>
-- description: Xml format settings.
- name: format_settings
- types:
- - <xref:azure.synapse.artifacts.models.XmlReadSettings>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZendeskAuthenticationType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZendeskAuthenticationType.yml
deleted file mode 100644
index 7bdcb4b1f2ad..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZendeskAuthenticationType.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.artifacts.models.ZendeskAuthenticationType
-name: ZendeskAuthenticationType
-fullName: azure.synapse.artifacts.models.ZendeskAuthenticationType
-summary: The authentication type to use.
-module: azure.synapse.artifacts.models
-constructor:
- syntax: ZendeskAuthenticationType(value, names=None, *, module=None, qualname=None,
- type=None, start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: BASIC
- uid: azure.synapse.artifacts.models.ZendeskAuthenticationType.BASIC
-- name: TOKEN
- uid: azure.synapse.artifacts.models.ZendeskAuthenticationType.TOKEN
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZendeskLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZendeskLinkedService.yml
deleted file mode 100644
index 919edb486b79..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZendeskLinkedService.yml
+++ /dev/null
@@ -1,145 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ZendeskLinkedService
-name: ZendeskLinkedService
-fullName: azure.synapse.artifacts.models.ZendeskLinkedService
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.LinkedService
-summary: 'Linked service for Zendesk.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ZendeskLinkedService(*, authentication_type: str | _models.ZendeskAuthenticationType,
- url: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, connect_via: _models.IntegrationRuntimeReference | None =
- None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, user_name:
- MutableMapping[str, Any] | None = None, password: _models.SecretBase | None =
- None, api_token: _models.SecretBase | None = None, encrypted_credential: MutableMapping[str,
- Any] | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: connect_via
- description: The integration runtime reference.
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- - name: description
- description: Linked service description.
- types:
- - <xref:str>
- - name: parameters
- description: Parameters for linked service.
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- - name: annotations
- description: List of tags that can be used for describing the linked service.
- types:
- - <xref:list>[<xref:JSON>]
- - name: authentication_type
- description: 'The authentication type to use. Required. Known values are:
-
- "Basic" and "Token".'
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ZendeskAuthenticationType>
- - name: url
- description: 'The url to connect Zendesk source. Type: string (or Expression with
- resultType
-
- string). Required.'
- types:
- - <xref:JSON>
- - name: user_name
- description: 'The username of the Zendesk source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
- - name: password
- description: The password of the Zendesk source.
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
- - name: api_token
- description: The api token for the Zendesk source.
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
- - 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).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The authentication type to use. Required. Known values are: "Basic"
-
- and "Token".'
- name: authentication_type
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.ZendeskAuthenticationType>
-- description: 'The url to connect Zendesk source. Type: string (or Expression with
- resultType
-
- string). Required.'
- name: url
- types:
- - <xref:JSON>
-- description: 'The username of the Zendesk source. Type: string (or Expression with
-
- resultType string).'
- name: user_name
- types:
- - <xref:JSON>
-- description: The password of the Zendesk source.
- name: password
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: The api token for the Zendesk source.
- name: api_token
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZipDeflateReadSettings.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZipDeflateReadSettings.yml
deleted file mode 100644
index 6db30ab7bcf6..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZipDeflateReadSettings.yml
+++ /dev/null
@@ -1,45 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ZipDeflateReadSettings
-name: ZipDeflateReadSettings
-fullName: azure.synapse.artifacts.models.ZipDeflateReadSettings
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.CompressionReadSettings
-summary: 'The ZipDeflate compression read settings.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ZipDeflateReadSettings(*, additional_properties: Dict[str, MutableMapping[str,
- Any]] | None = None, preserve_zip_file_name_as_folder: MutableMapping[str, Any]
- | None = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: preserve_zip_file_name_as_folder
- description: 'Preserve the zip file name as folder path. Type:
-
- boolean (or Expression with resultType boolean).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: The Compression setting type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Preserve the zip file name as folder path. Type:
-
- boolean (or Expression with resultType boolean).'
- name: preserve_zip_file_name_as_folder
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoLinkedService.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoLinkedService.yml
index d6bed4597d6a..bb2fa7040951 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoLinkedService.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoLinkedService.yml
@@ -10,59 +10,63 @@ summary: 'Zoho server linked service.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'ZohoLinkedService(*, endpoint: MutableMapping[str, Any], additional_properties:
- Dict[str, MutableMapping[str, Any]] | None = None, connect_via: _models.IntegrationRuntimeReference
- | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, connection_properties:
- MutableMapping[str, Any] | None = None, access_token: _models.SecretBase | None
- = None, use_encrypted_endpoints: MutableMapping[str, Any] | None = None, use_host_verification:
- MutableMapping[str, Any] | None = None, use_peer_verification: MutableMapping[str,
- Any] | None = None, encrypted_credential: MutableMapping[str, Any] | None = None,
- **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of linked service.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: connect_via
description: The integration runtime reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
- name: description
description: Linked service description.
+ isRequired: true
types:
- <xref:str>
- name: parameters
description: Parameters for linked service.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the linked service.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
- - name: connection_properties
- description: 'Properties used to connect to Zoho. It is mutually exclusive
-
- with any other properties in the linked service. Type: object.'
- types:
- - <xref:JSON>
+ - <xref:list>[<xref:object>]
- name: endpoint
- description: The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private).
- Required.
+ description: Required. The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private).
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: access_token
description: The access token for Zoho authentication.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SecretBase>
- name: use_encrypted_endpoints
- description: 'Specifies whether the data source endpoints are encrypted
+ description: 'Specifies whether the data source endpoints are encrypted using
- using HTTPS. The default value is true.'
+ HTTPS. The default value is true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- name: use_host_verification
description: 'Specifies whether to require the host name in the server''s
@@ -70,91 +74,23 @@ constructor:
default value is
true.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: encrypted_credential
- description: 'The encrypted credential used for authentication. Credentials
+ description: 'The encrypted credential used for authentication. Credentials are
- are encrypted using the integration runtime credential manager. Type: string
- (or Expression
+ encrypted using the integration runtime credential manager. Type: string (or
+ Expression with
- with resultType string).'
+ resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of linked service. Required.
- name: type
- types:
- - <xref:str>
-- description: The integration runtime reference.
- name: connect_via
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeReference>
-- description: Linked service description.
- name: description
- types:
- - <xref:str>
-- description: Parameters for linked service.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the linked service.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'Properties used to connect to Zoho. It is mutually exclusive with
-
- any other properties in the linked service. Type: object.'
- name: connection_properties
- types:
- - <xref:JSON>
-- description: The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private). Required.
- name: endpoint
- types:
- - <xref:JSON>
-- description: The access token for Zoho authentication.
- name: access_token
- types:
- - <xref:azure.synapse.artifacts.models.SecretBase>
-- description: 'Specifies whether the data source endpoints are encrypted using
-
- HTTPS. The default value is true.'
- name: use_encrypted_endpoints
- types:
- - <xref:JSON>
-- 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.'
- name: use_host_verification
- types:
- - <xref:JSON>
-- description: 'Specifies whether to verify the identity of the server when
-
- connecting over SSL. The default value is true.'
- name: use_peer_verification
- types:
- - <xref:JSON>
-- description: 'The encrypted credential used for authentication. Credentials are
-
- encrypted using the integration runtime credential manager. Type: string (or Expression
- with
-
- resultType string).'
- name: encrypted_credential
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoObjectDataset.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoObjectDataset.yml
index 9099ea47339a..a703f5aab57f 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoObjectDataset.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoObjectDataset.yml
@@ -10,109 +10,70 @@ summary: 'Zoho server dataset.
All required parameters must be populated in order to send to Azure.'
constructor:
- syntax: 'ZohoObjectDataset(*, linked_service_name: _models.LinkedServiceReference,
- additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description:
- str | None = None, structure: MutableMapping[str, Any] | None = None, schema:
- MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification]
- | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder:
- _models.DatasetFolder | None = None, table_name: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
+ 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:
- - <xref:dict>[<xref:str>, <xref:JSON>]
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: type
+ description: Required. Type of dataset.Constant filled by server.
+ isRequired: true
+ types:
+ - <xref:str>
- name: description
description: Dataset description.
+ isRequired: true
types:
- <xref:str>
- name: structure
description: 'Columns that define the structure of the dataset. Type: array (or
+ Expression
- Expression with resultType array), itemType: DatasetDataElement.'
+ with resultType array), itemType: DatasetDataElement.'
+ isRequired: true
types:
- - <xref:JSON>
+ - <xref:object>
- 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:
- - <xref:JSON>
+ - <xref:object>
- name: linked_service_name
- description: Linked service reference. Required.
+ description: Required. Linked service reference.
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceReference>
- name: parameters
description: Parameters for dataset.
+ isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
- name: annotations
description: List of tags that can be used for describing the Dataset.
+ isRequired: true
types:
- - <xref:list>[<xref:JSON>]
+ - <xref:list>[<xref:object>]
- name: folder
description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at
+ appear at the
- the root level.'
+ root level.'
+ isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DatasetFolder>
- name: table_name
description: 'The table name. Type: string (or Expression with resultType string).'
+ isRequired: true
types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Type of dataset. Required.
- name: type
- types:
- - <xref:str>
-- description: Dataset description.
- name: description
- types:
- - <xref:str>
-- description: 'Columns that define the structure of the dataset. Type: array (or
- Expression
-
- with resultType array), itemType: DatasetDataElement.'
- name: structure
- types:
- - <xref:JSON>
-- description: 'Columns that define the physical type schema of the dataset. Type:
- array (or
-
- Expression with resultType array), itemType: DatasetSchemaDataElement.'
- name: schema
- types:
- - <xref:JSON>
-- description: Linked service reference. Required.
- name: linked_service_name
- types:
- - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
-- description: Parameters for dataset.
- name: parameters
- types:
- - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
-- description: List of tags that can be used for describing the Dataset.
- name: annotations
- types:
- - <xref:list>[<xref:JSON>]
-- description: 'The folder that this Dataset is in. If not specified, Dataset will
- appear at the
-
- root level.'
- name: folder
- types:
- - <xref:azure.synapse.artifacts.models.DatasetFolder>
-- description: 'The table name. Type: string (or Expression with resultType string).'
- name: table_name
- types:
- - <xref:JSON>
+ - <xref:object>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoSource.yml
deleted file mode 100644
index 9d2415724d53..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoSource.yml
+++ /dev/null
@@ -1,111 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.models.ZohoSource
-name: ZohoSource
-fullName: azure.synapse.artifacts.models.ZohoSource
-module: azure.synapse.artifacts.models
-inheritances:
-- azure.synapse.artifacts.models._models_py3.TabularSource
-summary: 'A copy activity Zoho server source.
-
-
- All required parameters must be populated in order to send to Azure.'
-constructor:
- syntax: 'ZohoSource(*, additional_properties: Dict[str, MutableMapping[str, Any]]
- | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait:
- MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str,
- Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns:
- MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None
- = None, **kwargs: Any)'
- parameters:
- - name: additional_properties
- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - name: source_retry_count
- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- types:
- - <xref:JSON>
- - 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])).'
- types:
- - <xref:JSON>
- - name: max_concurrent_connections
- description: 'The maximum concurrent connection count for the source
-
- data store. Type: integer (or Expression with resultType integer).'
- types:
- - <xref:JSON>
- - name: query_timeout
- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- types:
- - <xref:JSON>
- - name: additional_columns
- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of
- objects).'
- types:
- - <xref:JSON>
- - name: query
- description: 'A query to retrieve data from source. Type: string (or Expression
- with
-
- resultType string).'
- types:
- - <xref:JSON>
-variables:
-- description: 'Unmatched properties from the message are deserialized to this
-
- collection.'
- name: additional_properties
- types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
-- description: Copy source type. Required.
- name: type
- types:
- - <xref:str>
-- description: 'Source retry count. Type: integer (or Expression with resultType
-
- integer).'
- name: source_retry_count
- types:
- - <xref:JSON>
-- description: 'Source retry wait. Type: string (or Expression with resultType
-
- string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: source_retry_wait
- types:
- - <xref:JSON>
-- description: 'The maximum concurrent connection count for the source data
-
- store. Type: integer (or Expression with resultType integer).'
- name: max_concurrent_connections
- types:
- - <xref:JSON>
-- description: 'Query timeout. Type: string (or Expression with resultType string),
-
- pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).'
- name: query_timeout
- types:
- - <xref:JSON>
-- description: 'Specifies the additional columns to be added to source data. Type:
-
- array of objects(AdditionalColumns) (or Expression with resultType array of objects).'
- name: additional_columns
- types:
- - <xref:JSON>
-- description: 'A query to retrieve data from source. Type: string (or Expression
- with resultType
-
- string).'
- name: query
- types:
- - <xref:JSON>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.yml
index 6665b2f80b08..c63dfbda0e28 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.yml
@@ -10,73 +10,23 @@ classes:
- azure.synapse.artifacts.models.ActivityRun
- azure.synapse.artifacts.models.ActivityRunsQueryResponse
- azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse
-- azure.synapse.artifacts.models.AdditionalColumns
- azure.synapse.artifacts.models.AmazonMWSLinkedService
- azure.synapse.artifacts.models.AmazonMWSObjectDataset
-- azure.synapse.artifacts.models.AmazonMWSSource
-- azure.synapse.artifacts.models.AmazonRdsForOracleLinkedService
-- azure.synapse.artifacts.models.AmazonRdsForOraclePartitionSettings
-- azure.synapse.artifacts.models.AmazonRdsForOracleSource
-- azure.synapse.artifacts.models.AmazonRdsForOracleTableDataset
-- azure.synapse.artifacts.models.AmazonRdsForSqlServerLinkedService
-- azure.synapse.artifacts.models.AmazonRdsForSqlServerSource
-- azure.synapse.artifacts.models.AmazonRdsForSqlServerTableDataset
- azure.synapse.artifacts.models.AmazonRedshiftLinkedService
-- azure.synapse.artifacts.models.AmazonRedshiftSource
- azure.synapse.artifacts.models.AmazonRedshiftTableDataset
-- azure.synapse.artifacts.models.AmazonS3Dataset
- azure.synapse.artifacts.models.AmazonS3LinkedService
-- azure.synapse.artifacts.models.AmazonS3Location
-- azure.synapse.artifacts.models.AmazonS3ReadSettings
-- azure.synapse.artifacts.models.AppFiguresLinkedService
- azure.synapse.artifacts.models.AppendVariableActivity
-- azure.synapse.artifacts.models.ArtifactRenameRequest
-- azure.synapse.artifacts.models.AsanaLinkedService
-- azure.synapse.artifacts.models.AutoPauseProperties
-- azure.synapse.artifacts.models.AutoScaleProperties
- azure.synapse.artifacts.models.AvroDataset
-- azure.synapse.artifacts.models.AvroFormat
-- azure.synapse.artifacts.models.AvroSink
-- azure.synapse.artifacts.models.AvroSource
-- azure.synapse.artifacts.models.AvroWriteSettings
- azure.synapse.artifacts.models.AzureBatchLinkedService
-- azure.synapse.artifacts.models.AzureBlobDataset
-- azure.synapse.artifacts.models.AzureBlobFSDataset
- azure.synapse.artifacts.models.AzureBlobFSLinkedService
-- azure.synapse.artifacts.models.AzureBlobFSLocation
-- azure.synapse.artifacts.models.AzureBlobFSReadSettings
-- azure.synapse.artifacts.models.AzureBlobFSSink
-- azure.synapse.artifacts.models.AzureBlobFSSource
-- azure.synapse.artifacts.models.AzureBlobFSWriteSettings
- azure.synapse.artifacts.models.AzureBlobStorageLinkedService
-- azure.synapse.artifacts.models.AzureBlobStorageLocation
-- azure.synapse.artifacts.models.AzureBlobStorageReadSettings
-- azure.synapse.artifacts.models.AzureBlobStorageWriteSettings
- azure.synapse.artifacts.models.AzureDataExplorerCommandActivity
- azure.synapse.artifacts.models.AzureDataExplorerLinkedService
-- azure.synapse.artifacts.models.AzureDataExplorerSink
-- azure.synapse.artifacts.models.AzureDataExplorerSource
- azure.synapse.artifacts.models.AzureDataExplorerTableDataset
- azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService
-- azure.synapse.artifacts.models.AzureDataLakeStoreDataset
- azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService
-- azure.synapse.artifacts.models.AzureDataLakeStoreLocation
-- azure.synapse.artifacts.models.AzureDataLakeStoreReadSettings
-- azure.synapse.artifacts.models.AzureDataLakeStoreSink
-- azure.synapse.artifacts.models.AzureDataLakeStoreSource
-- azure.synapse.artifacts.models.AzureDataLakeStoreWriteSettings
-- azure.synapse.artifacts.models.AzureDatabricksDeltaLakeDataset
-- azure.synapse.artifacts.models.AzureDatabricksDeltaLakeExportCommand
-- azure.synapse.artifacts.models.AzureDatabricksDeltaLakeImportCommand
-- azure.synapse.artifacts.models.AzureDatabricksDeltaLakeLinkedService
-- azure.synapse.artifacts.models.AzureDatabricksDeltaLakeSink
-- azure.synapse.artifacts.models.AzureDatabricksDeltaLakeSource
- azure.synapse.artifacts.models.AzureDatabricksLinkedService
-- azure.synapse.artifacts.models.AzureEntityResource
- azure.synapse.artifacts.models.AzureFileStorageLinkedService
-- azure.synapse.artifacts.models.AzureFileStorageLocation
-- azure.synapse.artifacts.models.AzureFileStorageReadSettings
-- azure.synapse.artifacts.models.AzureFileStorageWriteSettings
- azure.synapse.artifacts.models.AzureFunctionActivity
- azure.synapse.artifacts.models.AzureFunctionLinkedService
- azure.synapse.artifacts.models.AzureKeyVaultLinkedService
@@ -88,91 +38,48 @@ classes:
- azure.synapse.artifacts.models.AzureMLUpdateResourceActivity
- azure.synapse.artifacts.models.AzureMLWebServiceFile
- azure.synapse.artifacts.models.AzureMariaDBLinkedService
-- azure.synapse.artifacts.models.AzureMariaDBSource
- azure.synapse.artifacts.models.AzureMariaDBTableDataset
- azure.synapse.artifacts.models.AzureMySqlLinkedService
-- azure.synapse.artifacts.models.AzureMySqlSink
-- azure.synapse.artifacts.models.AzureMySqlSource
- azure.synapse.artifacts.models.AzureMySqlTableDataset
- azure.synapse.artifacts.models.AzurePostgreSqlLinkedService
-- azure.synapse.artifacts.models.AzurePostgreSqlSink
-- azure.synapse.artifacts.models.AzurePostgreSqlSource
- azure.synapse.artifacts.models.AzurePostgreSqlTableDataset
-- azure.synapse.artifacts.models.AzureQueueSink
- azure.synapse.artifacts.models.AzureSearchIndexDataset
-- azure.synapse.artifacts.models.AzureSearchIndexSink
- 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.AzureSqlSink
-- azure.synapse.artifacts.models.AzureSqlSource
- azure.synapse.artifacts.models.AzureSqlTableDataset
- azure.synapse.artifacts.models.AzureStorageLinkedService
-- azure.synapse.artifacts.models.AzureSynapseArtifactsLinkedService
- azure.synapse.artifacts.models.AzureTableDataset
-- azure.synapse.artifacts.models.AzureTableSink
-- azure.synapse.artifacts.models.AzureTableSource
- azure.synapse.artifacts.models.AzureTableStorageLinkedService
-- azure.synapse.artifacts.models.BigDataPoolParametrizationReference
- azure.synapse.artifacts.models.BigDataPoolReference
-- azure.synapse.artifacts.models.BigDataPoolResourceInfo
-- azure.synapse.artifacts.models.BigDataPoolResourceInfoListResult
- azure.synapse.artifacts.models.BinaryDataset
-- azure.synapse.artifacts.models.BinaryReadSettings
-- azure.synapse.artifacts.models.BinarySink
-- azure.synapse.artifacts.models.BinarySource
-- azure.synapse.artifacts.models.BlobEventsTrigger
-- azure.synapse.artifacts.models.BlobSink
-- azure.synapse.artifacts.models.BlobSource
-- azure.synapse.artifacts.models.BlobTrigger
- azure.synapse.artifacts.models.CassandraLinkedService
-- azure.synapse.artifacts.models.CassandraSource
- azure.synapse.artifacts.models.CassandraTableDataset
-- azure.synapse.artifacts.models.ChainingTrigger
- azure.synapse.artifacts.models.CloudError
- azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset
- azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService
-- azure.synapse.artifacts.models.CommonDataServiceForAppsSink
-- azure.synapse.artifacts.models.CommonDataServiceForAppsSource
-- azure.synapse.artifacts.models.CompressionReadSettings
- azure.synapse.artifacts.models.ConcurLinkedService
- azure.synapse.artifacts.models.ConcurObjectDataset
-- azure.synapse.artifacts.models.ConcurSource
- azure.synapse.artifacts.models.ControlActivity
- azure.synapse.artifacts.models.CopyActivity
-- azure.synapse.artifacts.models.CopyActivityLogSettings
- azure.synapse.artifacts.models.CopySink
- azure.synapse.artifacts.models.CopySource
-- azure.synapse.artifacts.models.CopyTranslator
- azure.synapse.artifacts.models.CosmosDbLinkedService
- azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset
- azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService
-- azure.synapse.artifacts.models.CosmosDbMongoDbApiSink
-- azure.synapse.artifacts.models.CosmosDbMongoDbApiSource
- azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset
-- azure.synapse.artifacts.models.CosmosDbSqlApiSink
-- azure.synapse.artifacts.models.CosmosDbSqlApiSource
- azure.synapse.artifacts.models.CouchbaseLinkedService
-- azure.synapse.artifacts.models.CouchbaseSource
- azure.synapse.artifacts.models.CouchbaseTableDataset
- azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest
- azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse
- azure.synapse.artifacts.models.CreateRunResponse
-- azure.synapse.artifacts.models.CredentialReference
- azure.synapse.artifacts.models.CustomActivity
- azure.synapse.artifacts.models.CustomActivityReferenceObject
- azure.synapse.artifacts.models.CustomDataSourceLinkedService
-- azure.synapse.artifacts.models.CustomDataset
-- azure.synapse.artifacts.models.CustomEventsTrigger
-- azure.synapse.artifacts.models.CustomSetupBase
-- azure.synapse.artifacts.models.CustomerManagedKeyDetails
-- azure.synapse.artifacts.models.DWCopyCommandDefaultValue
-- azure.synapse.artifacts.models.DWCopyCommandSettings
- azure.synapse.artifacts.models.DataFlow
-- azure.synapse.artifacts.models.DataFlowDebugCommandPayload
- azure.synapse.artifacts.models.DataFlowDebugCommandRequest
- azure.synapse.artifacts.models.DataFlowDebugCommandResponse
- azure.synapse.artifacts.models.DataFlowDebugPackage
@@ -192,110 +99,61 @@ classes:
- azure.synapse.artifacts.models.DataFlowSourceSetting
- azure.synapse.artifacts.models.DataFlowStagingInfo
- azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity
-- azure.synapse.artifacts.models.DataLakeStorageAccountDetails
- 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.DatasetDataElement
- 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.DatasetSchemaDataElement
-- azure.synapse.artifacts.models.DatasetStorageFormat
-- azure.synapse.artifacts.models.DataworldLinkedService
+- azure.synapse.artifacts.models.DatasetZipDeflateCompression
- azure.synapse.artifacts.models.Db2LinkedService
-- azure.synapse.artifacts.models.Db2Source
- azure.synapse.artifacts.models.Db2TableDataset
- azure.synapse.artifacts.models.DeleteActivity
- azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest
- azure.synapse.artifacts.models.DelimitedTextDataset
-- azure.synapse.artifacts.models.DelimitedTextReadSettings
-- azure.synapse.artifacts.models.DelimitedTextSink
-- azure.synapse.artifacts.models.DelimitedTextSource
-- azure.synapse.artifacts.models.DelimitedTextWriteSettings
-- azure.synapse.artifacts.models.DependencyReference
-- azure.synapse.artifacts.models.DistcpSettings
- azure.synapse.artifacts.models.DocumentDbCollectionDataset
-- azure.synapse.artifacts.models.DocumentDbCollectionSink
-- azure.synapse.artifacts.models.DocumentDbCollectionSource
- azure.synapse.artifacts.models.DrillLinkedService
-- azure.synapse.artifacts.models.DrillSource
- azure.synapse.artifacts.models.DrillTableDataset
-- azure.synapse.artifacts.models.DynamicExecutorAllocation
- azure.synapse.artifacts.models.DynamicsAXLinkedService
- azure.synapse.artifacts.models.DynamicsAXResourceDataset
-- azure.synapse.artifacts.models.DynamicsAXSource
- azure.synapse.artifacts.models.DynamicsCrmEntityDataset
- azure.synapse.artifacts.models.DynamicsCrmLinkedService
-- azure.synapse.artifacts.models.DynamicsCrmSink
-- azure.synapse.artifacts.models.DynamicsCrmSource
- azure.synapse.artifacts.models.DynamicsEntityDataset
- azure.synapse.artifacts.models.DynamicsLinkedService
-- azure.synapse.artifacts.models.DynamicsSink
-- azure.synapse.artifacts.models.DynamicsSource
-- azure.synapse.artifacts.models.EditTablesRequest
- azure.synapse.artifacts.models.EloquaLinkedService
- azure.synapse.artifacts.models.EloquaObjectDataset
-- azure.synapse.artifacts.models.EloquaSource
-- azure.synapse.artifacts.models.EncryptionDetails
-- azure.synapse.artifacts.models.EntityReference
-- azure.synapse.artifacts.models.ErrorAdditionalInfo
-- azure.synapse.artifacts.models.ErrorContract
-- azure.synapse.artifacts.models.ErrorResponse
- azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest
-- azure.synapse.artifacts.models.ExcelDataset
-- azure.synapse.artifacts.models.ExcelSource
- 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.ExportSettings
- azure.synapse.artifacts.models.ExposureControlRequest
- azure.synapse.artifacts.models.ExposureControlResponse
- azure.synapse.artifacts.models.Expression
-- azure.synapse.artifacts.models.FailActivity
- azure.synapse.artifacts.models.FileServerLinkedService
-- azure.synapse.artifacts.models.FileServerLocation
-- azure.synapse.artifacts.models.FileServerReadSettings
-- azure.synapse.artifacts.models.FileServerWriteSettings
-- azure.synapse.artifacts.models.FileShareDataset
-- azure.synapse.artifacts.models.FileSystemSink
-- azure.synapse.artifacts.models.FileSystemSource
- azure.synapse.artifacts.models.FilterActivity
-- azure.synapse.artifacts.models.Flowlet
- azure.synapse.artifacts.models.ForEachActivity
-- azure.synapse.artifacts.models.FormatReadSettings
-- azure.synapse.artifacts.models.FormatWriteSettings
-- azure.synapse.artifacts.models.FtpReadSettings
- azure.synapse.artifacts.models.FtpServerLinkedService
-- azure.synapse.artifacts.models.FtpServerLocation
- azure.synapse.artifacts.models.GetMetadataActivity
- azure.synapse.artifacts.models.GetSsisObjectMetadataRequest
-- azure.synapse.artifacts.models.GitHubAccessTokenRequest
-- azure.synapse.artifacts.models.GitHubAccessTokenResponse
-- azure.synapse.artifacts.models.GitHubClientSecret
- azure.synapse.artifacts.models.GoogleAdWordsLinkedService
- azure.synapse.artifacts.models.GoogleAdWordsObjectDataset
-- azure.synapse.artifacts.models.GoogleAdWordsSource
- azure.synapse.artifacts.models.GoogleBigQueryLinkedService
- azure.synapse.artifacts.models.GoogleBigQueryObjectDataset
-- azure.synapse.artifacts.models.GoogleBigQuerySource
- azure.synapse.artifacts.models.GoogleCloudStorageLinkedService
-- azure.synapse.artifacts.models.GoogleCloudStorageLocation
-- azure.synapse.artifacts.models.GoogleCloudStorageReadSettings
-- azure.synapse.artifacts.models.GoogleSheetsLinkedService
- azure.synapse.artifacts.models.GreenplumLinkedService
-- azure.synapse.artifacts.models.GreenplumSource
- azure.synapse.artifacts.models.GreenplumTableDataset
- azure.synapse.artifacts.models.HBaseLinkedService
- azure.synapse.artifacts.models.HBaseObjectDataset
-- azure.synapse.artifacts.models.HBaseSource
- azure.synapse.artifacts.models.HDInsightHiveActivity
- azure.synapse.artifacts.models.HDInsightLinkedService
- azure.synapse.artifacts.models.HDInsightMapReduceActivity
@@ -304,183 +162,71 @@ classes:
- azure.synapse.artifacts.models.HDInsightSparkActivity
- azure.synapse.artifacts.models.HDInsightStreamingActivity
- azure.synapse.artifacts.models.HdfsLinkedService
-- azure.synapse.artifacts.models.HdfsLocation
-- azure.synapse.artifacts.models.HdfsReadSettings
-- azure.synapse.artifacts.models.HdfsSource
- azure.synapse.artifacts.models.HiveLinkedService
- azure.synapse.artifacts.models.HiveObjectDataset
-- azure.synapse.artifacts.models.HiveSource
-- azure.synapse.artifacts.models.HttpDataset
- azure.synapse.artifacts.models.HttpLinkedService
-- azure.synapse.artifacts.models.HttpReadSettings
-- azure.synapse.artifacts.models.HttpServerLocation
-- azure.synapse.artifacts.models.HttpSource
- azure.synapse.artifacts.models.HubspotLinkedService
- azure.synapse.artifacts.models.HubspotObjectDataset
-- azure.synapse.artifacts.models.HubspotSource
- azure.synapse.artifacts.models.IfConditionActivity
- azure.synapse.artifacts.models.ImpalaLinkedService
- azure.synapse.artifacts.models.ImpalaObjectDataset
-- azure.synapse.artifacts.models.ImpalaSource
-- azure.synapse.artifacts.models.ImportSettings
- azure.synapse.artifacts.models.InformixLinkedService
-- azure.synapse.artifacts.models.InformixSink
-- azure.synapse.artifacts.models.InformixSource
- azure.synapse.artifacts.models.InformixTableDataset
-- azure.synapse.artifacts.models.IntegrationRuntime
-- azure.synapse.artifacts.models.IntegrationRuntimeComputeProperties
-- azure.synapse.artifacts.models.IntegrationRuntimeCustomSetupScriptProperties
-- azure.synapse.artifacts.models.IntegrationRuntimeDataFlowProperties
-- azure.synapse.artifacts.models.IntegrationRuntimeDataProxyProperties
-- azure.synapse.artifacts.models.IntegrationRuntimeDebugResource
-- azure.synapse.artifacts.models.IntegrationRuntimeListResponse
- azure.synapse.artifacts.models.IntegrationRuntimeReference
-- azure.synapse.artifacts.models.IntegrationRuntimeResource
-- azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogInfo
-- azure.synapse.artifacts.models.IntegrationRuntimeSsisProperties
-- azure.synapse.artifacts.models.IntegrationRuntimeVNetProperties
- azure.synapse.artifacts.models.JiraLinkedService
- azure.synapse.artifacts.models.JiraObjectDataset
-- azure.synapse.artifacts.models.JiraSource
- azure.synapse.artifacts.models.JsonDataset
-- azure.synapse.artifacts.models.JsonFormat
-- azure.synapse.artifacts.models.JsonReadSettings
-- azure.synapse.artifacts.models.JsonSink
-- azure.synapse.artifacts.models.JsonSource
-- azure.synapse.artifacts.models.JsonWriteSettings
-- azure.synapse.artifacts.models.KqlScript
-- azure.synapse.artifacts.models.KqlScriptContent
-- azure.synapse.artifacts.models.KqlScriptContentCurrentConnection
-- azure.synapse.artifacts.models.KqlScriptContentMetadata
-- azure.synapse.artifacts.models.KqlScriptResource
-- azure.synapse.artifacts.models.KqlScriptsResourceCollectionResponse
-- azure.synapse.artifacts.models.LibraryInfo
-- azure.synapse.artifacts.models.LibraryListResponse
-- azure.synapse.artifacts.models.LibraryRequirements
-- azure.synapse.artifacts.models.LibraryResource
-- azure.synapse.artifacts.models.LibraryResourceInfo
-- azure.synapse.artifacts.models.LibraryResourceProperties
-- azure.synapse.artifacts.models.LinkConnection
-- azure.synapse.artifacts.models.LinkConnectionCompute
-- azure.synapse.artifacts.models.LinkConnectionDetailedStatus
-- azure.synapse.artifacts.models.LinkConnectionLandingZone
-- azure.synapse.artifacts.models.LinkConnectionListResponse
-- azure.synapse.artifacts.models.LinkConnectionQueryTableStatus
-- azure.synapse.artifacts.models.LinkConnectionRefreshStatus
-- azure.synapse.artifacts.models.LinkConnectionResource
-- azure.synapse.artifacts.models.LinkConnectionSourceDatabase
-- azure.synapse.artifacts.models.LinkConnectionSourceDatabaseTypeProperties
-- azure.synapse.artifacts.models.LinkConnectionTargetDatabase
-- azure.synapse.artifacts.models.LinkConnectionTargetDatabaseTypeProperties
-- azure.synapse.artifacts.models.LinkTableListResponse
-- azure.synapse.artifacts.models.LinkTableRequest
-- azure.synapse.artifacts.models.LinkTableRequestSource
-- azure.synapse.artifacts.models.LinkTableRequestTarget
-- azure.synapse.artifacts.models.LinkTableRequestTargetDistributionOptions
-- azure.synapse.artifacts.models.LinkTableRequestTargetStructureOptions
-- azure.synapse.artifacts.models.LinkTableResource
-- azure.synapse.artifacts.models.LinkTableStatus
-- azure.synapse.artifacts.models.LinkedIntegrationRuntimeKeyAuthorization
-- azure.synapse.artifacts.models.LinkedIntegrationRuntimeRbacAuthorization
-- azure.synapse.artifacts.models.LinkedIntegrationRuntimeType
- 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.LogLocationSettings
-- azure.synapse.artifacts.models.LogSettings
- azure.synapse.artifacts.models.LogStorageSettings
- azure.synapse.artifacts.models.LookupActivity
- azure.synapse.artifacts.models.MagentoLinkedService
- azure.synapse.artifacts.models.MagentoObjectDataset
-- azure.synapse.artifacts.models.MagentoSource
-- azure.synapse.artifacts.models.ManagedIdentity
-- azure.synapse.artifacts.models.ManagedIntegrationRuntime
-- azure.synapse.artifacts.models.ManagedVirtualNetworkReference
-- azure.synapse.artifacts.models.ManagedVirtualNetworkSettings
- azure.synapse.artifacts.models.MappingDataFlow
- azure.synapse.artifacts.models.MariaDBLinkedService
-- azure.synapse.artifacts.models.MariaDBSource
- azure.synapse.artifacts.models.MariaDBTableDataset
- azure.synapse.artifacts.models.MarketoLinkedService
- azure.synapse.artifacts.models.MarketoObjectDataset
-- azure.synapse.artifacts.models.MarketoSource
-- azure.synapse.artifacts.models.MetastoreRegisterObject
-- azure.synapse.artifacts.models.MetastoreRegistrationResponse
-- azure.synapse.artifacts.models.MetastoreRequestSuccessResponse
-- azure.synapse.artifacts.models.MetastoreUpdateObject
-- azure.synapse.artifacts.models.MetastoreUpdationResponse
- azure.synapse.artifacts.models.MicrosoftAccessLinkedService
-- azure.synapse.artifacts.models.MicrosoftAccessSink
-- azure.synapse.artifacts.models.MicrosoftAccessSource
- azure.synapse.artifacts.models.MicrosoftAccessTableDataset
-- azure.synapse.artifacts.models.MongoDbAtlasCollectionDataset
-- azure.synapse.artifacts.models.MongoDbAtlasLinkedService
-- azure.synapse.artifacts.models.MongoDbAtlasSource
- azure.synapse.artifacts.models.MongoDbCollectionDataset
-- azure.synapse.artifacts.models.MongoDbCursorMethodsProperties
- azure.synapse.artifacts.models.MongoDbLinkedService
-- azure.synapse.artifacts.models.MongoDbSource
- azure.synapse.artifacts.models.MongoDbV2CollectionDataset
- azure.synapse.artifacts.models.MongoDbV2LinkedService
-- azure.synapse.artifacts.models.MongoDbV2Source
- azure.synapse.artifacts.models.MultiplePipelineTrigger
- azure.synapse.artifacts.models.MySqlLinkedService
-- azure.synapse.artifacts.models.MySqlSource
- azure.synapse.artifacts.models.MySqlTableDataset
- azure.synapse.artifacts.models.NetezzaLinkedService
-- azure.synapse.artifacts.models.NetezzaPartitionSettings
-- azure.synapse.artifacts.models.NetezzaSource
- azure.synapse.artifacts.models.NetezzaTableDataset
- azure.synapse.artifacts.models.Notebook
- azure.synapse.artifacts.models.NotebookCell
- azure.synapse.artifacts.models.NotebookCellOutputItem
-- azure.synapse.artifacts.models.NotebookFolder
- azure.synapse.artifacts.models.NotebookKernelSpec
- azure.synapse.artifacts.models.NotebookLanguageInfo
- azure.synapse.artifacts.models.NotebookListResponse
- azure.synapse.artifacts.models.NotebookMetadata
-- azure.synapse.artifacts.models.NotebookParameter
- azure.synapse.artifacts.models.NotebookResource
- azure.synapse.artifacts.models.NotebookSessionProperties
- azure.synapse.artifacts.models.ODataLinkedService
- azure.synapse.artifacts.models.ODataResourceDataset
-- azure.synapse.artifacts.models.ODataSource
- azure.synapse.artifacts.models.OdbcLinkedService
-- azure.synapse.artifacts.models.OdbcSink
-- azure.synapse.artifacts.models.OdbcSource
- azure.synapse.artifacts.models.OdbcTableDataset
- azure.synapse.artifacts.models.Office365Dataset
- azure.synapse.artifacts.models.Office365LinkedService
-- azure.synapse.artifacts.models.Office365Source
-- azure.synapse.artifacts.models.OperationResult
- azure.synapse.artifacts.models.OracleLinkedService
-- azure.synapse.artifacts.models.OraclePartitionSettings
- azure.synapse.artifacts.models.OracleServiceCloudLinkedService
- azure.synapse.artifacts.models.OracleServiceCloudObjectDataset
-- azure.synapse.artifacts.models.OracleServiceCloudSource
-- azure.synapse.artifacts.models.OracleSink
-- azure.synapse.artifacts.models.OracleSource
- azure.synapse.artifacts.models.OracleTableDataset
- azure.synapse.artifacts.models.OrcDataset
-- azure.synapse.artifacts.models.OrcFormat
-- azure.synapse.artifacts.models.OrcSink
-- azure.synapse.artifacts.models.OrcSource
-- azure.synapse.artifacts.models.OrcWriteSettings
-- azure.synapse.artifacts.models.OutputColumn
- azure.synapse.artifacts.models.ParameterSpecification
- azure.synapse.artifacts.models.ParquetDataset
-- azure.synapse.artifacts.models.ParquetFormat
-- azure.synapse.artifacts.models.ParquetSink
-- azure.synapse.artifacts.models.ParquetSource
-- azure.synapse.artifacts.models.ParquetWriteSettings
- azure.synapse.artifacts.models.PaypalLinkedService
- azure.synapse.artifacts.models.PaypalObjectDataset
-- azure.synapse.artifacts.models.PaypalSource
- azure.synapse.artifacts.models.PhoenixLinkedService
- azure.synapse.artifacts.models.PhoenixObjectDataset
-- azure.synapse.artifacts.models.PhoenixSource
- azure.synapse.artifacts.models.PipelineFolder
- azure.synapse.artifacts.models.PipelineListResponse
- azure.synapse.artifacts.models.PipelineReference
@@ -488,30 +234,14 @@ classes:
- azure.synapse.artifacts.models.PipelineRun
- azure.synapse.artifacts.models.PipelineRunInvokedBy
- azure.synapse.artifacts.models.PipelineRunsQueryResponse
-- azure.synapse.artifacts.models.PolybaseSettings
- azure.synapse.artifacts.models.PostgreSqlLinkedService
-- azure.synapse.artifacts.models.PostgreSqlSource
- azure.synapse.artifacts.models.PostgreSqlTableDataset
-- azure.synapse.artifacts.models.PowerBIWorkspaceLinkedService
- azure.synapse.artifacts.models.PrestoLinkedService
- azure.synapse.artifacts.models.PrestoObjectDataset
-- azure.synapse.artifacts.models.PrestoSource
-- azure.synapse.artifacts.models.PrivateEndpoint
-- azure.synapse.artifacts.models.PrivateEndpointConnection
-- azure.synapse.artifacts.models.PrivateLinkServiceConnectionState
-- azure.synapse.artifacts.models.ProxyResource
-- azure.synapse.artifacts.models.PurviewConfiguration
- azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse
-- azure.synapse.artifacts.models.QueryTableStatusRequest
- azure.synapse.artifacts.models.QuickBooksLinkedService
- azure.synapse.artifacts.models.QuickBooksObjectDataset
-- azure.synapse.artifacts.models.QuickBooksSource
-- azure.synapse.artifacts.models.QuickbaseLinkedService
-- azure.synapse.artifacts.models.RecurrenceSchedule
-- azure.synapse.artifacts.models.RecurrenceScheduleOccurrence
- azure.synapse.artifacts.models.RedirectIncompatibleRowSettings
-- azure.synapse.artifacts.models.RedshiftUnloadSettings
-- azure.synapse.artifacts.models.RelationalSource
- azure.synapse.artifacts.models.RelationalTableDataset
- azure.synapse.artifacts.models.RerunTriggerListResponse
- azure.synapse.artifacts.models.RerunTriggerResource
@@ -520,22 +250,9 @@ classes:
- azure.synapse.artifacts.models.Resource
- azure.synapse.artifacts.models.ResponsysLinkedService
- azure.synapse.artifacts.models.ResponsysObjectDataset
-- azure.synapse.artifacts.models.ResponsysSource
- azure.synapse.artifacts.models.RestResourceDataset
- azure.synapse.artifacts.models.RestServiceLinkedService
-- azure.synapse.artifacts.models.RestSink
-- azure.synapse.artifacts.models.RestSource
-- azure.synapse.artifacts.models.RetryPolicy
- azure.synapse.artifacts.models.RunFilterParameters
-- azure.synapse.artifacts.models.RunNotebookError
-- azure.synapse.artifacts.models.RunNotebookParameter
-- azure.synapse.artifacts.models.RunNotebookRequest
-- azure.synapse.artifacts.models.RunNotebookResponse
-- azure.synapse.artifacts.models.RunNotebookResult
-- azure.synapse.artifacts.models.RunNotebookSnapshot
-- azure.synapse.artifacts.models.RunNotebookSnapshotResponse
-- azure.synapse.artifacts.models.RunNotebookSnapshotResult
-- azure.synapse.artifacts.models.RunNotebookSparkSessionOptions
- azure.synapse.artifacts.models.RunQueryFilter
- azure.synapse.artifacts.models.RunQueryOrderBy
- azure.synapse.artifacts.models.SSISAccessCredential
@@ -548,82 +265,33 @@ classes:
- azure.synapse.artifacts.models.SalesforceLinkedService
- azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService
- azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset
-- azure.synapse.artifacts.models.SalesforceMarketingCloudSource
- azure.synapse.artifacts.models.SalesforceObjectDataset
- azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService
- azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset
-- azure.synapse.artifacts.models.SalesforceServiceCloudSink
-- azure.synapse.artifacts.models.SalesforceServiceCloudSource
-- azure.synapse.artifacts.models.SalesforceSink
-- azure.synapse.artifacts.models.SalesforceSource
- azure.synapse.artifacts.models.SapBWLinkedService
- azure.synapse.artifacts.models.SapBwCubeDataset
-- azure.synapse.artifacts.models.SapBwSource
- azure.synapse.artifacts.models.SapCloudForCustomerLinkedService
- azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset
-- azure.synapse.artifacts.models.SapCloudForCustomerSink
-- azure.synapse.artifacts.models.SapCloudForCustomerSource
- azure.synapse.artifacts.models.SapEccLinkedService
- azure.synapse.artifacts.models.SapEccResourceDataset
-- azure.synapse.artifacts.models.SapEccSource
- azure.synapse.artifacts.models.SapHanaLinkedService
-- azure.synapse.artifacts.models.SapHanaPartitionSettings
-- azure.synapse.artifacts.models.SapHanaSource
- azure.synapse.artifacts.models.SapHanaTableDataset
-- azure.synapse.artifacts.models.SapOdpLinkedService
-- azure.synapse.artifacts.models.SapOdpResourceDataset
-- azure.synapse.artifacts.models.SapOdpSource
- azure.synapse.artifacts.models.SapOpenHubLinkedService
-- azure.synapse.artifacts.models.SapOpenHubSource
- azure.synapse.artifacts.models.SapOpenHubTableDataset
- azure.synapse.artifacts.models.SapTableLinkedService
-- azure.synapse.artifacts.models.SapTablePartitionSettings
- azure.synapse.artifacts.models.SapTableResourceDataset
-- azure.synapse.artifacts.models.SapTableSource
-- azure.synapse.artifacts.models.ScheduleTrigger
-- azure.synapse.artifacts.models.ScheduleTriggerRecurrence
- azure.synapse.artifacts.models.ScriptAction
-- azure.synapse.artifacts.models.ScriptActivity
-- azure.synapse.artifacts.models.ScriptActivityParameter
-- azure.synapse.artifacts.models.ScriptActivityScriptBlock
-- azure.synapse.artifacts.models.ScriptActivityTypePropertiesLogSettings
- azure.synapse.artifacts.models.SecretBase
-- azure.synapse.artifacts.models.SecureInputOutputPolicy
- azure.synapse.artifacts.models.SecureString
-- azure.synapse.artifacts.models.SelfDependencyTumblingWindowTriggerReference
-- azure.synapse.artifacts.models.SelfHostedIntegrationRuntime
- azure.synapse.artifacts.models.ServiceNowLinkedService
- azure.synapse.artifacts.models.ServiceNowObjectDataset
-- azure.synapse.artifacts.models.ServiceNowSource
- azure.synapse.artifacts.models.SetVariableActivity
-- azure.synapse.artifacts.models.SftpLocation
-- azure.synapse.artifacts.models.SftpReadSettings
- azure.synapse.artifacts.models.SftpServerLinkedService
-- azure.synapse.artifacts.models.SftpWriteSettings
-- azure.synapse.artifacts.models.SharePointOnlineListLinkedService
-- azure.synapse.artifacts.models.SharePointOnlineListResourceDataset
-- azure.synapse.artifacts.models.SharePointOnlineListSource
- azure.synapse.artifacts.models.ShopifyLinkedService
- azure.synapse.artifacts.models.ShopifyObjectDataset
-- azure.synapse.artifacts.models.ShopifySource
-- azure.synapse.artifacts.models.SkipErrorFile
-- azure.synapse.artifacts.models.Sku
-- azure.synapse.artifacts.models.SmartsheetLinkedService
-- azure.synapse.artifacts.models.SnowflakeDataset
-- azure.synapse.artifacts.models.SnowflakeExportCopyCommand
-- azure.synapse.artifacts.models.SnowflakeImportCopyCommand
-- azure.synapse.artifacts.models.SnowflakeLinkedService
-- azure.synapse.artifacts.models.SnowflakeSink
-- azure.synapse.artifacts.models.SnowflakeSource
- azure.synapse.artifacts.models.SparkBatchJob
- azure.synapse.artifacts.models.SparkBatchJobState
-- azure.synapse.artifacts.models.SparkConfiguration
-- azure.synapse.artifacts.models.SparkConfigurationListResponse
-- azure.synapse.artifacts.models.SparkConfigurationParametrizationReference
-- azure.synapse.artifacts.models.SparkConfigurationReference
-- azure.synapse.artifacts.models.SparkConfigurationResource
- azure.synapse.artifacts.models.SparkJobDefinition
-- azure.synapse.artifacts.models.SparkJobDefinitionFolder
- azure.synapse.artifacts.models.SparkJobDefinitionResource
- azure.synapse.artifacts.models.SparkJobDefinitionsListResponse
- azure.synapse.artifacts.models.SparkJobProperties
@@ -633,87 +301,45 @@ classes:
- azure.synapse.artifacts.models.SparkScheduler
- azure.synapse.artifacts.models.SparkServiceError
- azure.synapse.artifacts.models.SparkServicePlugin
-- azure.synapse.artifacts.models.SparkSource
-- azure.synapse.artifacts.models.SqlAlwaysEncryptedProperties
- azure.synapse.artifacts.models.SqlConnection
-- azure.synapse.artifacts.models.SqlDWSink
-- azure.synapse.artifacts.models.SqlDWSource
-- azure.synapse.artifacts.models.SqlMISink
-- azure.synapse.artifacts.models.SqlMISource
-- azure.synapse.artifacts.models.SqlPartitionSettings
-- azure.synapse.artifacts.models.SqlPool
-- azure.synapse.artifacts.models.SqlPoolInfoListResult
-- azure.synapse.artifacts.models.SqlPoolReference
-- azure.synapse.artifacts.models.SqlPoolStoredProcedureActivity
- azure.synapse.artifacts.models.SqlScript
- azure.synapse.artifacts.models.SqlScriptContent
-- azure.synapse.artifacts.models.SqlScriptFolder
- azure.synapse.artifacts.models.SqlScriptMetadata
- azure.synapse.artifacts.models.SqlScriptResource
- azure.synapse.artifacts.models.SqlScriptsListResponse
- azure.synapse.artifacts.models.SqlServerLinkedService
-- azure.synapse.artifacts.models.SqlServerSink
-- azure.synapse.artifacts.models.SqlServerSource
- azure.synapse.artifacts.models.SqlServerStoredProcedureActivity
- azure.synapse.artifacts.models.SqlServerTableDataset
-- azure.synapse.artifacts.models.SqlSink
-- azure.synapse.artifacts.models.SqlSource
- azure.synapse.artifacts.models.SquareLinkedService
- azure.synapse.artifacts.models.SquareObjectDataset
-- azure.synapse.artifacts.models.SquareSource
- azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse
- azure.synapse.artifacts.models.StagingSettings
- azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest
- azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse
-- azure.synapse.artifacts.models.StoreReadSettings
-- azure.synapse.artifacts.models.StoreWriteSettings
- 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.SybaseSource
- azure.synapse.artifacts.models.SybaseTableDataset
-- azure.synapse.artifacts.models.SynapseNotebookActivity
-- azure.synapse.artifacts.models.SynapseNotebookReference
-- azure.synapse.artifacts.models.SynapseSparkJobDefinitionActivity
-- azure.synapse.artifacts.models.SynapseSparkJobReference
-- azure.synapse.artifacts.models.TabularSource
-- azure.synapse.artifacts.models.TabularTranslator
-- azure.synapse.artifacts.models.TarGZipReadSettings
-- azure.synapse.artifacts.models.TarReadSettings
-- azure.synapse.artifacts.models.TeamDeskLinkedService
- azure.synapse.artifacts.models.TeradataLinkedService
-- azure.synapse.artifacts.models.TeradataPartitionSettings
-- azure.synapse.artifacts.models.TeradataSource
- azure.synapse.artifacts.models.TeradataTableDataset
-- azure.synapse.artifacts.models.TextFormat
-- azure.synapse.artifacts.models.TrackedResource
- azure.synapse.artifacts.models.Transformation
- azure.synapse.artifacts.models.Trigger
- azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus
-- azure.synapse.artifacts.models.TriggerDependencyReference
- azure.synapse.artifacts.models.TriggerListResponse
- azure.synapse.artifacts.models.TriggerPipelineReference
-- azure.synapse.artifacts.models.TriggerReference
- azure.synapse.artifacts.models.TriggerResource
- azure.synapse.artifacts.models.TriggerRun
- azure.synapse.artifacts.models.TriggerRunsQueryResponse
- azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus
-- azure.synapse.artifacts.models.TumblingWindowTrigger
-- azure.synapse.artifacts.models.TumblingWindowTriggerDependencyReference
-- azure.synapse.artifacts.models.TwilioLinkedService
-- azure.synapse.artifacts.models.TypeConversionSettings
- azure.synapse.artifacts.models.UntilActivity
-- azure.synapse.artifacts.models.UpdateLandingZoneCredential
- azure.synapse.artifacts.models.UserProperty
- azure.synapse.artifacts.models.ValidationActivity
- azure.synapse.artifacts.models.VariableSpecification
- azure.synapse.artifacts.models.VerticaLinkedService
-- azure.synapse.artifacts.models.VerticaSource
- azure.synapse.artifacts.models.VerticaTableDataset
-- azure.synapse.artifacts.models.VirtualNetworkProfile
- azure.synapse.artifacts.models.WaitActivity
- azure.synapse.artifacts.models.WebActivity
- azure.synapse.artifacts.models.WebActivityAuthentication
@@ -723,57 +349,26 @@ classes:
- azure.synapse.artifacts.models.WebHookActivity
- azure.synapse.artifacts.models.WebLinkedService
- azure.synapse.artifacts.models.WebLinkedServiceTypeProperties
-- azure.synapse.artifacts.models.WebSource
- azure.synapse.artifacts.models.WebTableDataset
- azure.synapse.artifacts.models.Workspace
- azure.synapse.artifacts.models.WorkspaceIdentity
-- azure.synapse.artifacts.models.WorkspaceKeyDetails
-- azure.synapse.artifacts.models.WorkspaceRepositoryConfiguration
- azure.synapse.artifacts.models.WorkspaceUpdateParameters
- azure.synapse.artifacts.models.XeroLinkedService
- azure.synapse.artifacts.models.XeroObjectDataset
-- azure.synapse.artifacts.models.XeroSource
-- azure.synapse.artifacts.models.XmlDataset
-- azure.synapse.artifacts.models.XmlReadSettings
-- azure.synapse.artifacts.models.XmlSource
-- azure.synapse.artifacts.models.ZendeskLinkedService
-- azure.synapse.artifacts.models.ZipDeflateReadSettings
- azure.synapse.artifacts.models.ZohoLinkedService
- azure.synapse.artifacts.models.ZohoObjectDataset
-- azure.synapse.artifacts.models.ZohoSource
enums:
-- azure.synapse.artifacts.models.ActionOnExistingTargetTable
-- azure.synapse.artifacts.models.ActivityOnInactiveMarkAs
-- azure.synapse.artifacts.models.ActivityState
-- azure.synapse.artifacts.models.AmazonRdsForOraclePartitionOption
- azure.synapse.artifacts.models.AvroCompressionCodec
- azure.synapse.artifacts.models.AzureFunctionActivityMethod
-- azure.synapse.artifacts.models.AzureSearchIndexWriteBehaviorType
-- azure.synapse.artifacts.models.AzureStorageAuthenticationType
-- azure.synapse.artifacts.models.BigDataPoolReferenceType
-- azure.synapse.artifacts.models.BlobEventType
-- azure.synapse.artifacts.models.CassandraSourceReadConsistencyLevels
- azure.synapse.artifacts.models.CellOutputType
-- azure.synapse.artifacts.models.CompressionCodec
-- azure.synapse.artifacts.models.ConfigurationType
-- azure.synapse.artifacts.models.CopyBehaviorType
-- azure.synapse.artifacts.models.CreateMode
-- azure.synapse.artifacts.models.CredentialReferenceType
- azure.synapse.artifacts.models.DataFlowComputeType
-- azure.synapse.artifacts.models.DataFlowDebugCommandType
-- azure.synapse.artifacts.models.DataFlowReferenceType
- azure.synapse.artifacts.models.DatasetCompressionLevel
-- azure.synapse.artifacts.models.DatasetReferenceType
-- azure.synapse.artifacts.models.DayOfWeek
-- azure.synapse.artifacts.models.Db2AuthenticationType
+- 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.DynamicsSinkWriteBehavior
-- azure.synapse.artifacts.models.Enum13
- azure.synapse.artifacts.models.EventSubscriptionStatus
-- azure.synapse.artifacts.models.ExpressionType
- azure.synapse.artifacts.models.FtpAuthenticationType
- azure.synapse.artifacts.models.GoogleAdWordsAuthenticationType
- azure.synapse.artifacts.models.GoogleBigQueryAuthenticationType
@@ -785,83 +380,37 @@ enums:
- azure.synapse.artifacts.models.HiveThriftTransportProtocol
- azure.synapse.artifacts.models.HttpAuthenticationType
- azure.synapse.artifacts.models.ImpalaAuthenticationType
-- azure.synapse.artifacts.models.IntegrationRuntimeEdition
-- azure.synapse.artifacts.models.IntegrationRuntimeEntityReferenceType
-- azure.synapse.artifacts.models.IntegrationRuntimeLicenseType
-- azure.synapse.artifacts.models.IntegrationRuntimeReferenceType
-- azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogPricingTier
-- azure.synapse.artifacts.models.IntegrationRuntimeState
-- azure.synapse.artifacts.models.IntegrationRuntimeType
-- azure.synapse.artifacts.models.JsonFormatFilePattern
-- azure.synapse.artifacts.models.JsonWriteFilePattern
-- azure.synapse.artifacts.models.LivyStates
-- azure.synapse.artifacts.models.ManagedVirtualNetworkReferenceType
- azure.synapse.artifacts.models.MongoDbAuthenticationType
-- azure.synapse.artifacts.models.NetezzaPartitionOption
-- azure.synapse.artifacts.models.NodeSize
-- azure.synapse.artifacts.models.NodeSizeFamily
-- azure.synapse.artifacts.models.NotebookParameterType
-- azure.synapse.artifacts.models.NotebookReferenceType
- azure.synapse.artifacts.models.ODataAadServicePrincipalCredentialType
- azure.synapse.artifacts.models.ODataAuthenticationType
-- azure.synapse.artifacts.models.OraclePartitionOption
- azure.synapse.artifacts.models.OrcCompressionCodec
- azure.synapse.artifacts.models.ParameterType
-- azure.synapse.artifacts.models.ParquetCompressionCodecEnum
+- azure.synapse.artifacts.models.ParquetCompressionCodec
- azure.synapse.artifacts.models.PhoenixAuthenticationType
-- azure.synapse.artifacts.models.PipelineReferenceType
- azure.synapse.artifacts.models.PluginCurrentState
-- azure.synapse.artifacts.models.PolybaseSettingsRejectType
- azure.synapse.artifacts.models.PrestoAuthenticationType
-- azure.synapse.artifacts.models.RecurrenceFrequency
-- azure.synapse.artifacts.models.RequestStatus
-- azure.synapse.artifacts.models.ResourceIdentityType
-- azure.synapse.artifacts.models.ResourceStatus
- 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.SalesforceSinkWriteBehavior
-- azure.synapse.artifacts.models.SalesforceSourceReadBehavior
-- azure.synapse.artifacts.models.SapCloudForCustomerSinkWriteBehavior
- azure.synapse.artifacts.models.SapHanaAuthenticationType
-- azure.synapse.artifacts.models.SapHanaPartitionOption
-- azure.synapse.artifacts.models.SapTablePartitionOption
- azure.synapse.artifacts.models.SchedulerCurrentState
-- azure.synapse.artifacts.models.ScriptActivityLogDestination
-- azure.synapse.artifacts.models.ScriptActivityParameterDirection
-- azure.synapse.artifacts.models.ScriptActivityParameterType
-- azure.synapse.artifacts.models.ScriptType
- azure.synapse.artifacts.models.ServiceNowAuthenticationType
- azure.synapse.artifacts.models.SftpAuthenticationType
- azure.synapse.artifacts.models.SparkAuthenticationType
- azure.synapse.artifacts.models.SparkBatchJobResultType
-- azure.synapse.artifacts.models.SparkConfigurationReferenceType
- azure.synapse.artifacts.models.SparkErrorSource
-- azure.synapse.artifacts.models.SparkJobReferenceType
- azure.synapse.artifacts.models.SparkJobType
- azure.synapse.artifacts.models.SparkServerType
- azure.synapse.artifacts.models.SparkThriftTransportProtocol
-- azure.synapse.artifacts.models.SqlAlwaysEncryptedAkvAuthType
- azure.synapse.artifacts.models.SqlConnectionType
-- azure.synapse.artifacts.models.SqlPartitionOption
-- azure.synapse.artifacts.models.SqlPoolReferenceType
-- azure.synapse.artifacts.models.SqlScriptType
-- azure.synapse.artifacts.models.SsisLogLocationType
- azure.synapse.artifacts.models.SsisPackageLocationType
- azure.synapse.artifacts.models.StoredProcedureParameterType
- azure.synapse.artifacts.models.SybaseAuthenticationType
-- azure.synapse.artifacts.models.TeamDeskAuthenticationType
- azure.synapse.artifacts.models.TeradataAuthenticationType
-- azure.synapse.artifacts.models.TeradataPartitionOption
-- azure.synapse.artifacts.models.TriggerReferenceType
- azure.synapse.artifacts.models.TriggerRunStatus
- azure.synapse.artifacts.models.TriggerRuntimeState
-- azure.synapse.artifacts.models.TumblingWindowFrequency
-- azure.synapse.artifacts.models.Type
- azure.synapse.artifacts.models.VariableType
- azure.synapse.artifacts.models.WebActivityMethod
- azure.synapse.artifacts.models.WebAuthenticationType
-- azure.synapse.artifacts.models.WebHookActivityMethod
-- azure.synapse.artifacts.models.ZendeskAuthenticationType
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.BigDataPoolsOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.BigDataPoolsOperations.yml
deleted file mode 100644
index 7670d391b5f9..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.BigDataPoolsOperations.yml
+++ /dev/null
@@ -1,52 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.operations.BigDataPoolsOperations
-name: BigDataPoolsOperations
-fullName: azure.synapse.artifacts.operations.BigDataPoolsOperations
-module: azure.synapse.artifacts.operations
-inheritances:
-- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:big_data_pools> attribute.\n>"
-constructor:
- syntax: BigDataPoolsOperations(*args, **kwargs)
-methods:
-- uid: azure.synapse.artifacts.operations.BigDataPoolsOperations.get
- name: get
- summary: Get Big Data Pool.
- signature: 'get(big_data_pool_name: str, **kwargs: Any) -> BigDataPoolResourceInfo'
- parameters:
- - name: big_data_pool_name
- description: The Big Data Pool name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: BigDataPoolResourceInfo or the result of cls(response)
- types:
- - <xref:azure.synapse.artifacts.models.BigDataPoolResourceInfo>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.BigDataPoolsOperations.list
- name: list
- summary: List Big Data Pools.
- signature: 'list(**kwargs: Any) -> BigDataPoolResourceInfoListResult'
- parameters:
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: BigDataPoolResourceInfoListResult or the result of cls(response)
- types:
- - <xref:azure.synapse.artifacts.models.BigDataPoolResourceInfoListResult>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-attributes:
-- uid: azure.synapse.artifacts.operations.BigDataPoolsOperations.models
- name: models
- signature: models = <module 'azure.synapse.artifacts.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.5\\x64\\Lib\\site-packages\\azure\\synapse\\artifacts\\models\\__init__.py'>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DataFlowDebugSessionOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DataFlowDebugSessionOperations.yml
index 6a0603b0d107..7cd6301cfca3 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DataFlowDebugSessionOperations.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DataFlowDebugSessionOperations.yml
@@ -5,39 +5,49 @@ fullName: azure.synapse.artifacts.operations.DataFlowDebugSessionOperations
module: azure.synapse.artifacts.operations
inheritances:
- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:data_flow_debug_session> attribute.\n>"
+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(*args, **kwargs)
+ 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, *, content_type:
- str = ''application/json'', **kwargs: Any) -> _models.AddDataFlowToDebugSessionResponse'
+ signature: 'add_data_flow(request: ''models.DataFlowDebugPackage'', **kwargs: Any)
+ -> models.AddDataFlowToDebugSessionResponse'
parameters:
- name: request
- description: 'Data flow debug session definition with debug content. Is either
- a
-
- DataFlowDebugPackage type or a IO type. Required.'
+ description: Data flow debug session definition with debug content.
isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DataFlowDebugPackage>
- - <xref:typing.IO>
- - name: content_type
- description: 'Body Parameter content-type. Known values are: ''application/json''.
-
- Default value is None.'
- types:
- - <xref:str>
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
- description: AddDataFlowToDebugSessionResponse or the result of cls(response)
+ description: AddDataFlowToDebugSessionResponse, or the result of cls(response)
types:
- <xref:azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse>
exceptions:
@@ -45,23 +55,14 @@ methods:
- 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,
- *, content_type: str = ''application/json'', **kwargs: Any) -> LROPoller[_models.CreateDataFlowDebugSessionResponse]'
+ signature: 'begin_create_data_flow_debug_session(request: ''models.CreateDataFlowDebugSessionRequest'',
+ **kwargs: Any) -> LROPoller[''models.CreateDataFlowDebugSessionResponse'']'
parameters:
- name: request
- description: 'Data flow debug session definition. Is either a
-
- CreateDataFlowDebugSessionRequest type or a IO type. Required.'
+ description: Data flow debug session definition.
isRequired: true
types:
- <xref:azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest>
- - <xref:typing.IO>
- - name: content_type
- description: 'Body Parameter content-type. Known values are: ''application/json''.
-
- Default value is None.'
- types:
- - <xref:str>
- name: cls
description: A custom type or function that will be passed the direct response
types:
@@ -71,27 +72,20 @@ methods:
types:
- <xref:str>
- 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
+ description: 'True for ARMPolling, False for no polling, or a
- polling strategy.'
+ polling object for personal polling strategy'
types:
- <xref:bool>
- <xref:azure.core.polling.PollingMethod>
- name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
+ description: Default waiting time between two polls for LRO operations if no Retry-After
+ header is present.
types:
- <xref:int>
return:
- description: 'An instance of LROPoller that returns either CreateDataFlowDebugSessionResponse
- or the
-
- result of cls(response)'
+ description: An instance of LROPoller that returns either CreateDataFlowDebugSessionResponse
+ or the result of cls(response)
types:
- <xref:azure.core.polling.LROPoller>[<xref:azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse>]
exceptions:
@@ -99,23 +93,14 @@ methods:
- 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,
- *, content_type: str = ''application/json'', **kwargs: Any) -> LROPoller[_models.DataFlowDebugCommandResponse]'
+ signature: 'begin_execute_command(request: ''models.DataFlowDebugCommandRequest'',
+ **kwargs: Any) -> LROPoller[''models.DataFlowDebugCommandResponse'']'
parameters:
- name: request
- description: 'Data flow debug command definition. Is either a DataFlowDebugCommandRequest
-
- type or a IO type. Required.'
+ description: Data flow debug command definition.
isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DataFlowDebugCommandRequest>
- - <xref:typing.IO>
- - name: content_type
- description: 'Body Parameter content-type. Known values are: ''application/json''.
-
- Default value is None.'
- types:
- - <xref:str>
- name: cls
description: A custom type or function that will be passed the direct response
types:
@@ -125,27 +110,20 @@ methods:
types:
- <xref:str>
- name: polling
- description: 'By default, your polling method will be LROBasePolling. Pass in
- False for
+ description: 'True for ARMPolling, False for no polling, or a
- this operation to not poll, or pass in your own initialized polling object for
- a personal
-
- polling strategy.'
+ polling object for personal polling strategy'
types:
- <xref:bool>
- <xref:azure.core.polling.PollingMethod>
- name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
+ description: Default waiting time between two polls for LRO operations if no Retry-After
+ header is present.
types:
- <xref:int>
return:
- description: 'An instance of LROPoller that returns either DataFlowDebugCommandResponse
- or the
-
- result of cls(response)'
+ description: An instance of LROPoller that returns either DataFlowDebugCommandResponse
+ or the result of cls(response)
types:
- <xref:azure.core.polling.LROPoller>[<xref:azure.synapse.artifacts.models.DataFlowDebugCommandResponse>]
exceptions:
@@ -153,29 +131,20 @@ methods:
- 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,
- *, content_type: str = ''application/json'', **kwargs: Any) -> None'
+ signature: 'delete_data_flow_debug_session(request: ''models.DeleteDataFlowDebugSessionRequest'',
+ **kwargs: Any) -> None'
parameters:
- name: request
- description: 'Data flow debug session definition for deletion. Is either a
-
- DeleteDataFlowDebugSessionRequest type or a IO type. Required.'
+ description: Data flow debug session definition for deletion.
isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest>
- - <xref:typing.IO>
- - name: content_type
- description: 'Body Parameter content-type. Known values are: ''application/json''.
-
- Default value is None.'
- types:
- - <xref:str>
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
- description: None or the result of cls(response)
+ description: None, or the result of cls(response)
types:
- <xref:None>
exceptions:
@@ -183,19 +152,17 @@ methods:
- 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[DataFlowDebugSessionInfo]'
+ signature: 'query_data_flow_debug_sessions_by_workspace(**kwargs: Any) -> Iterable[''models.QueryDataFlowDebugSessionsResponse'']'
parameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
- description: 'An iterator like instance of either DataFlowDebugSessionInfo or
- the result of
-
- cls(response)'
+ description: An iterator like instance of either QueryDataFlowDebugSessionsResponse
+ or the result of cls(response)
types:
- - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.DataFlowDebugSessionInfo>]
+ - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DataFlowOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DataFlowOperations.yml
index 825229895402..ec416f637014 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DataFlowOperations.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DataFlowOperations.yml
@@ -5,25 +5,45 @@ fullName: azure.synapse.artifacts.operations.DataFlowOperations
module: azure.synapse.artifacts.operations
inheritances:
- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:data_flow> attribute.\n>"
+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(*args, **kwargs)
+ 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.begin_create_or_update_data_flow
- name: begin_create_or_update_data_flow
+- 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: 'begin_create_or_update_data_flow(data_flow_name: str, properties: DataFlow,
- if_match: str | None = None, **kwargs: Any) -> LROPoller[DataFlowResource]'
+ 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. Required.
+ description: The data flow name.
isRequired: true
types:
- <xref:str>
- name: properties
- description: Data flow properties. Required.
+ description: Data flow properties.
isRequired: true
types:
- <xref:azure.synapse.artifacts.models.DataFlow>
@@ -31,52 +51,27 @@ methods:
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. Default
- value is None.'
- isRequired: true
+ it should match existing entity or can be * for unconditional update.'
+ defaultValue: None
types:
- <xref:str>
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
return:
- description: 'An instance of LROPoller that returns either DataFlowResource or
- the result of
-
- cls(response)'
+ description: DataFlowResource, or the result of cls(response)
types:
- - <xref:azure.core.polling.LROPoller>[<xref:azure.synapse.artifacts.models.DataFlowResource>]
+ - <xref:azure.synapse.artifacts.models.DataFlowResource>
exceptions:
- type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.DataFlowOperations.begin_delete_data_flow
- name: begin_delete_data_flow
+- uid: azure.synapse.artifacts.operations.DataFlowOperations.delete_data_flow
+ name: delete_data_flow
summary: Deletes a data flow.
- signature: 'begin_delete_data_flow(data_flow_name: str, **kwargs: Any) -> LROPoller[None]'
+ signature: 'delete_data_flow(data_flow_name: str, **kwargs: Any) -> None'
parameters:
- name: data_flow_name
- description: The data flow name. Required.
+ description: The data flow name.
isRequired: true
types:
- <xref:str>
@@ -84,90 +79,20 @@ methods:
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
return:
- description: An instance of LROPoller that returns either None or the result of
- cls(response)
+ description: None, or the result of cls(response)
types:
- - <xref:azure.core.polling.LROPoller>[<xref:None>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.DataFlowOperations.begin_rename_data_flow
- name: begin_rename_data_flow
- summary: Renames a dataflow.
- signature: 'begin_rename_data_flow(data_flow_name: str, new_name: str | None = None,
- **kwargs: Any) -> LROPoller[None]'
- parameters:
- - name: data_flow_name
- description: The data flow name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: new_name
- description: New name of the artifact. Default value is None.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
- return:
- description: An instance of LROPoller that returns either None or the result of
- cls(response)
- types:
- - <xref:azure.core.polling.LROPoller>[<xref:None>]
+ - <xref:None>
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) -> DataFlowResource'
+ **kwargs: Any) -> models.DataFlowResource'
parameters:
- name: data_flow_name
- description: The data flow name. Required.
+ description: The data flow name.
isRequired: true
types:
- <xref:str>
@@ -176,10 +101,8 @@ methods:
If the
ETag matches the existing entity tag, or if * was provided, then no content
- will be returned.
-
- Default value is None.'
- isRequired: true
+ will be returned.'
+ defaultValue: None
types:
- <xref:str>
- name: cls
@@ -187,7 +110,7 @@ methods:
types:
- <xref:callable>
return:
- description: DataFlowResource or the result of cls(response)
+ description: DataFlowResource, or the result of cls(response)
types:
- <xref:azure.synapse.artifacts.models.DataFlowResource>
exceptions:
@@ -195,17 +118,17 @@ methods:
- 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[DataFlowResource]'
+ signature: 'get_data_flows_by_workspace(**kwargs: Any) -> Iterable[''models.DataFlowListResponse'']'
parameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
- description: An iterator like instance of either DataFlowResource or the result
+ description: An iterator like instance of either DataFlowListResponse or the result
of cls(response)
types:
- - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.DataFlowResource>]
+ - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.DataFlowListResponse>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DatasetOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DatasetOperations.yml
index b381fd133297..311bd6b9d54c 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DatasetOperations.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DatasetOperations.yml
@@ -5,25 +5,45 @@ fullName: azure.synapse.artifacts.operations.DatasetOperations
module: azure.synapse.artifacts.operations
inheritances:
- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:dataset> attribute.\n>"
+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(*args, **kwargs)
+ 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.begin_create_or_update_dataset
- name: begin_create_or_update_dataset
+- uid: azure.synapse.artifacts.operations.DatasetOperations.create_or_update_dataset
+ name: create_or_update_dataset
summary: Creates or updates a dataset.
- signature: 'begin_create_or_update_dataset(dataset_name: str, properties: Dataset,
- if_match: str | None = None, **kwargs: Any) -> LROPoller[DatasetResource]'
+ 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. Required.
+ description: The dataset name.
isRequired: true
types:
- <xref:str>
- name: properties
- description: Dataset properties. Required.
+ description: Dataset properties.
isRequired: true
types:
- <xref:azure.synapse.artifacts.models.Dataset>
@@ -31,100 +51,27 @@ methods:
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. Default value
- is None.'
- isRequired: true
+ should match existing entity or can be * for unconditional update.'
+ defaultValue: None
types:
- <xref:str>
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
return:
- description: 'An instance of LROPoller that returns either DatasetResource or
- the result of
-
- cls(response)'
+ description: DatasetResource, or the result of cls(response)
types:
- - <xref:azure.core.polling.LROPoller>[<xref:azure.synapse.artifacts.models.DatasetResource>]
+ - <xref:azure.synapse.artifacts.models.DatasetResource>
exceptions:
- type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.DatasetOperations.begin_delete_dataset
- name: begin_delete_dataset
+- uid: azure.synapse.artifacts.operations.DatasetOperations.delete_dataset
+ name: delete_dataset
summary: Deletes a dataset.
- signature: 'begin_delete_dataset(dataset_name: str, **kwargs: Any) -> LROPoller[None]'
- parameters:
- - name: dataset_name
- description: The dataset name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
- return:
- description: An instance of LROPoller that returns either None or the result of
- cls(response)
- types:
- - <xref:azure.core.polling.LROPoller>[<xref:None>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.DatasetOperations.begin_rename_dataset
- name: begin_rename_dataset
- summary: Renames a dataset.
- signature: 'begin_rename_dataset(dataset_name: str, new_name: str | None = None,
- **kwargs: Any) -> LROPoller[None]'
+ signature: 'delete_dataset(dataset_name: str, **kwargs: Any) -> None'
parameters:
- name: dataset_name
- description: The dataset name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: new_name
- description: New name of the artifact. Default value is None.
+ description: The dataset name.
isRequired: true
types:
- <xref:str>
@@ -132,42 +79,20 @@ methods:
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
return:
- description: An instance of LROPoller that returns either None or the result of
- cls(response)
+ description: None, or the result of cls(response)
types:
- - <xref:azure.core.polling.LROPoller>[<xref:None>]
+ - <xref:None>
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) -> DatasetResource | None'
+ Any) -> ''models.DatasetResource'' | None'
parameters:
- name: dataset_name
- description: The dataset name. Required.
+ description: The dataset name.
isRequired: true
types:
- <xref:str>
@@ -176,10 +101,8 @@ methods:
the ETag
matches the existing entity tag, or if * was provided, then no content will
- be returned.
-
- Default value is None.'
- isRequired: true
+ be returned.'
+ defaultValue: None
types:
- <xref:str>
- name: cls
@@ -187,7 +110,7 @@ methods:
types:
- <xref:callable>
return:
- description: DatasetResource or None or the result of cls(response)
+ description: DatasetResource, or the result of cls(response)
types:
- <xref:azure.synapse.artifacts.models.DatasetResource>
- <xref:None>
@@ -196,17 +119,17 @@ methods:
- 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[DatasetResource]'
+ signature: 'get_datasets_by_workspace(**kwargs: Any) -> Iterable[''models.DatasetListResponse'']'
parameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
- description: An iterator like instance of either DatasetResource or the result
+ description: An iterator like instance of either DatasetListResponse or the result
of cls(response)
types:
- - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.DatasetResource>]
+ - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.DatasetListResponse>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.IntegrationRuntimesOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.IntegrationRuntimesOperations.yml
deleted file mode 100644
index 3ded3172b474..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.IntegrationRuntimesOperations.yml
+++ /dev/null
@@ -1,52 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.operations.IntegrationRuntimesOperations
-name: IntegrationRuntimesOperations
-fullName: azure.synapse.artifacts.operations.IntegrationRuntimesOperations
-module: azure.synapse.artifacts.operations
-inheritances:
-- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:integration_runtimes> attribute.\n>"
-constructor:
- syntax: IntegrationRuntimesOperations(*args, **kwargs)
-methods:
-- uid: azure.synapse.artifacts.operations.IntegrationRuntimesOperations.get
- name: get
- summary: Get Integration Runtime.
- signature: 'get(integration_runtime_name: str, **kwargs: Any) -> IntegrationRuntimeResource'
- parameters:
- - name: integration_runtime_name
- description: The Integration Runtime name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: IntegrationRuntimeResource or the result of cls(response)
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeResource>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.IntegrationRuntimesOperations.list
- name: list
- summary: List Integration Runtimes.
- signature: 'list(**kwargs: Any) -> IntegrationRuntimeListResponse'
- parameters:
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: IntegrationRuntimeListResponse or the result of cls(response)
- types:
- - <xref:azure.synapse.artifacts.models.IntegrationRuntimeListResponse>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-attributes:
-- uid: azure.synapse.artifacts.operations.IntegrationRuntimesOperations.models
- name: models
- signature: models = <module 'azure.synapse.artifacts.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.5\\x64\\Lib\\site-packages\\azure\\synapse\\artifacts\\models\\__init__.py'>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.KqlScriptOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.KqlScriptOperations.yml
deleted file mode 100644
index 5929b07b943b..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.KqlScriptOperations.yml
+++ /dev/null
@@ -1,184 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.operations.KqlScriptOperations
-name: KqlScriptOperations
-fullName: azure.synapse.artifacts.operations.KqlScriptOperations
-module: azure.synapse.artifacts.operations
-inheritances:
-- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:kql_script> attribute.\n>"
-constructor:
- syntax: KqlScriptOperations(*args, **kwargs)
-methods:
-- uid: azure.synapse.artifacts.operations.KqlScriptOperations.begin_create_or_update
- name: begin_create_or_update
- summary: Creates or updates a KQL Script.
- signature: 'begin_create_or_update(kql_script_name: str, kql_script: _models.KqlScriptResource,
- *, content_type: str = ''application/json'', **kwargs: Any) -> LROPoller[_models.KqlScriptResource]'
- parameters:
- - name: kql_script_name
- description: KQL script name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: kql_script
- description: KQL script. Is either a KqlScriptResource type or a IO type. Required.
- isRequired: true
- types:
- - <xref:azure.synapse.artifacts.models.KqlScriptResource>
- - <xref:typing.IO>
- - name: content_type
- description: 'Body Parameter content-type. Known values are: ''application/json''.
-
- Default value is None.'
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
- return:
- description: 'An instance of LROPoller that returns either KqlScriptResource or
- the result of
-
- cls(response)'
- types:
- - <xref:azure.core.polling.LROPoller>[<xref:azure.synapse.artifacts.models.KqlScriptResource>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.KqlScriptOperations.begin_delete_by_name
- name: begin_delete_by_name
- summary: Delete KQL script by name.
- signature: 'begin_delete_by_name(kql_script_name: str, **kwargs: Any) -> LROPoller[None]'
- parameters:
- - name: kql_script_name
- description: KQL script name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
- return:
- description: An instance of LROPoller that returns either None or the result of
- cls(response)
- types:
- - <xref:azure.core.polling.LROPoller>[<xref:None>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.KqlScriptOperations.begin_rename
- name: begin_rename
- summary: Rename KQL script.
- signature: 'begin_rename(kql_script_name: str, new_name: str | None = None, **kwargs:
- Any) -> LROPoller[None]'
- parameters:
- - name: kql_script_name
- description: KQL script name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: new_name
- description: New name of the artifact. Default value is None.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
- return:
- description: An instance of LROPoller that returns either None or the result of
- cls(response)
- types:
- - <xref:azure.core.polling.LROPoller>[<xref:None>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.KqlScriptOperations.get_by_name
- name: get_by_name
- summary: Get KQL script by name.
- signature: 'get_by_name(kql_script_name: str, **kwargs: Any) -> KqlScriptResource'
- parameters:
- - name: kql_script_name
- description: KQL script name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: KqlScriptResource or the result of cls(response)
- types:
- - <xref:azure.synapse.artifacts.models.KqlScriptResource>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-attributes:
-- uid: azure.synapse.artifacts.operations.KqlScriptOperations.models
- name: models
- signature: models = <module 'azure.synapse.artifacts.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.5\\x64\\Lib\\site-packages\\azure\\synapse\\artifacts\\models\\__init__.py'>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.KqlScriptsOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.KqlScriptsOperations.yml
deleted file mode 100644
index 333bbc331f5c..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.KqlScriptsOperations.yml
+++ /dev/null
@@ -1,33 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.operations.KqlScriptsOperations
-name: KqlScriptsOperations
-fullName: azure.synapse.artifacts.operations.KqlScriptsOperations
-module: azure.synapse.artifacts.operations
-inheritances:
-- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:kql_scripts> attribute.\n>"
-constructor:
- syntax: KqlScriptsOperations(*args, **kwargs)
-methods:
-- uid: azure.synapse.artifacts.operations.KqlScriptsOperations.get_all
- name: get_all
- summary: Get all KQL scripts.
- signature: 'get_all(**kwargs: Any) -> Iterable[KqlScriptResource]'
- parameters:
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: An iterator like instance of either KqlScriptResource or the result
- of cls(response)
- types:
- - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.KqlScriptResource>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-attributes:
-- uid: azure.synapse.artifacts.operations.KqlScriptsOperations.models
- name: models
- signature: models = <module 'azure.synapse.artifacts.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.5\\x64\\Lib\\site-packages\\azure\\synapse\\artifacts\\models\\__init__.py'>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.LibraryOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.LibraryOperations.yml
deleted file mode 100644
index 5235ece0babe..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.LibraryOperations.yml
+++ /dev/null
@@ -1,267 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.operations.LibraryOperations
-name: LibraryOperations
-fullName: azure.synapse.artifacts.operations.LibraryOperations
-module: azure.synapse.artifacts.operations
-inheritances:
-- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:library> attribute.\n>"
-constructor:
- syntax: LibraryOperations(*args, **kwargs)
-methods:
-- uid: azure.synapse.artifacts.operations.LibraryOperations.append
- name: append
- summary: 'Append the content to the library resource created using the create operation.
- The maximum
-
- content size is 4MiB. Content larger than 4MiB must be appended in 4MiB chunks.'
- signature: 'append(comp: str | Enum13, library_name: str, content: IO, blob_condition_append_position:
- int | None = None, **kwargs: Any) -> None'
- parameters:
- - name: comp
- description: '"appendblock" Required.'
- isRequired: true
- types:
- - <xref:str>
- - <xref:azure.synapse.artifacts.models.Enum13>
- - name: library_name
- description: 'file name to upload. Minimum length of the filename should be 1
- excluding
-
- the extension length. Required.'
- isRequired: true
- types:
- - <xref:str>
- - name: content
- description: Library file chunk. Required.
- isRequired: true
- types:
- - <xref:typing.IO>
- - name: blob_condition_append_position
- description: "Set this header to a byte offset at which the block is\nexpected\
- \ to be appended. The request succeeds only if the current offset matches this\
- \ value.\nOtherwise, the request fails with the AppendPositionConditionNotMet\
- \ error (HTTP status code 412\n\u2013 Precondition Failed). Default value is\
- \ None."
- isRequired: true
- types:
- - <xref:int>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: None or the result of cls(response)
- types:
- - <xref:None>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.LibraryOperations.begin_create
- name: begin_create
- summary: Creates a library with the library name.
- signature: 'begin_create(library_name: str, **kwargs: Any) -> LROPoller[LibraryResourceInfo]'
- parameters:
- - name: library_name
- description: 'file name to upload. Minimum length of the filename should be 1
- excluding
-
- the extension length. Required.'
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
- return:
- description: 'An instance of LROPoller that returns either LibraryResourceInfo
- or the result of
-
- cls(response)'
- types:
- - <xref:azure.core.polling.LROPoller>[<xref:azure.synapse.artifacts.models.LibraryResourceInfo>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.LibraryOperations.begin_delete
- name: begin_delete
- summary: Delete Library.
- signature: 'begin_delete(library_name: str, **kwargs: Any) -> LROPoller[LibraryResourceInfo]'
- parameters:
- - name: library_name
- description: 'file name to upload. Minimum length of the filename should be 1
- excluding
-
- the extension length. Required.'
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
- return:
- description: 'An instance of LROPoller that returns either LibraryResourceInfo
- or the result of
-
- cls(response)'
- types:
- - <xref:azure.core.polling.LROPoller>[<xref:azure.synapse.artifacts.models.LibraryResourceInfo>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.LibraryOperations.begin_flush
- name: begin_flush
- summary: Flush Library.
- signature: 'begin_flush(library_name: str, **kwargs: Any) -> LROPoller[LibraryResourceInfo]'
- parameters:
- - name: library_name
- description: 'file name to upload. Minimum length of the filename should be 1
- excluding
-
- the extension length. Required.'
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
- return:
- description: 'An instance of LROPoller that returns either LibraryResourceInfo
- or the result of
-
- cls(response)'
- types:
- - <xref:azure.core.polling.LROPoller>[<xref:azure.synapse.artifacts.models.LibraryResourceInfo>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.LibraryOperations.get
- name: get
- summary: Get Library.
- signature: 'get(library_name: str, **kwargs: Any) -> LibraryResource | None'
- parameters:
- - name: library_name
- description: 'file name to upload. Minimum length of the filename should be 1
- excluding
-
- the extension length. Required.'
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: LibraryResource or None or the result of cls(response)
- types:
- - <xref:azure.synapse.artifacts.models.LibraryResource>
- - <xref:None>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.LibraryOperations.get_operation_result
- name: get_operation_result
- summary: Get Operation result for Library.
- signature: 'get_operation_result(operation_id: str, **kwargs: Any) -> LibraryResource
- | OperationResult'
- parameters:
- - name: operation_id
- description: operation id for which status is requested. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: LibraryResource or OperationResult or the result of cls(response)
- types:
- - <xref:azure.synapse.artifacts.models.LibraryResource>
- - <xref:azure.synapse.artifacts.models.OperationResult>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.LibraryOperations.list
- name: list
- summary: Lists Library.
- signature: 'list(**kwargs: Any) -> Iterable[LibraryResource]'
- parameters:
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: An iterator like instance of either LibraryResource or the result
- of cls(response)
- types:
- - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.LibraryResource>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-attributes:
-- uid: azure.synapse.artifacts.operations.LibraryOperations.models
- name: models
- signature: models = <module 'azure.synapse.artifacts.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.5\\x64\\Lib\\site-packages\\azure\\synapse\\artifacts\\models\\__init__.py'>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.LinkConnectionOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.LinkConnectionOperations.yml
deleted file mode 100644
index eecb06cb4f64..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.LinkConnectionOperations.yml
+++ /dev/null
@@ -1,330 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.operations.LinkConnectionOperations
-name: LinkConnectionOperations
-fullName: azure.synapse.artifacts.operations.LinkConnectionOperations
-module: azure.synapse.artifacts.operations
-inheritances:
-- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:link_connection> attribute.\n>"
-constructor:
- syntax: LinkConnectionOperations(*args, **kwargs)
-methods:
-- uid: azure.synapse.artifacts.operations.LinkConnectionOperations.create_or_update
- name: create_or_update
- summary: Creates or updates a link connection.
- signature: 'create_or_update(link_connection_name: str, link_connection: _models.LinkConnectionResource,
- *, content_type: str = ''application/json'', **kwargs: Any) -> _models.LinkConnectionResource'
- parameters:
- - name: link_connection_name
- description: The link connection name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: link_connection
- description: 'Link connection resource definition. Is either a LinkConnectionResource
-
- type or a IO type. Required.'
- isRequired: true
- types:
- - <xref:azure.synapse.artifacts.models.LinkConnectionResource>
- - <xref:typing.IO>
- - name: content_type
- description: 'Body Parameter content-type. Known values are: ''application/json''.
-
- Default value is None.'
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: LinkConnectionResource or the result of cls(response)
- types:
- - <xref:azure.synapse.artifacts.models.LinkConnectionResource>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.LinkConnectionOperations.delete
- name: delete
- summary: Delete a link connection.
- signature: 'delete(link_connection_name: str, **kwargs: Any) -> None'
- parameters:
- - name: link_connection_name
- description: The link connection name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: None or the result of cls(response)
- types:
- - <xref:None>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.LinkConnectionOperations.edit_tables
- name: edit_tables
- summary: Edit tables for a link connection.
- signature: 'edit_tables(link_connection_name: str, link_tables: List[LinkTableRequest]
- | None = None, **kwargs: Any) -> None'
- parameters:
- - name: link_connection_name
- description: The link connection name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: link_tables
- description: Edit link tables request. Default value is None.
- isRequired: true
- types:
- - <xref:list>[<xref:azure.synapse.artifacts.models.LinkTableRequest>]
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: None or the result of cls(response)
- types:
- - <xref:None>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.LinkConnectionOperations.get
- name: get
- summary: Get a link connection.
- signature: 'get(link_connection_name: str, **kwargs: Any) -> LinkConnectionResource'
- parameters:
- - name: link_connection_name
- description: The link connection name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: LinkConnectionResource or the result of cls(response)
- types:
- - <xref:azure.synapse.artifacts.models.LinkConnectionResource>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.LinkConnectionOperations.get_detailed_status
- name: get_detailed_status
- summary: Get the detailed status of a link connection.
- signature: 'get_detailed_status(link_connection_name: str, **kwargs: Any) -> LinkConnectionDetailedStatus'
- parameters:
- - name: link_connection_name
- description: The link connection name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: LinkConnectionDetailedStatus or the result of cls(response)
- types:
- - <xref:azure.synapse.artifacts.models.LinkConnectionDetailedStatus>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.LinkConnectionOperations.list_by_workspace
- name: list_by_workspace
- summary: List link connections.
- signature: 'list_by_workspace(**kwargs: Any) -> Iterable[LinkConnectionResource]'
- parameters:
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: 'An iterator like instance of either LinkConnectionResource or the
- result of
-
- cls(response)'
- types:
- - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.LinkConnectionResource>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.LinkConnectionOperations.list_link_tables
- name: list_link_tables
- summary: List the link tables of a link connection.
- signature: 'list_link_tables(link_connection_name: str, **kwargs: Any) -> LinkTableListResponse'
- parameters:
- - name: link_connection_name
- description: The link connection name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: LinkTableListResponse or the result of cls(response)
- types:
- - <xref:azure.synapse.artifacts.models.LinkTableListResponse>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.LinkConnectionOperations.pause
- name: pause
- summary: 'Pause a link connection. It may take a few minutes from Pausing to Paused,
- monitor the status
-
- with LinkConnection_GetDetailedStatus.'
- signature: 'pause(link_connection_name: str, **kwargs: Any) -> None'
- parameters:
- - name: link_connection_name
- description: The link connection name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: None or the result of cls(response)
- types:
- - <xref:None>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.LinkConnectionOperations.query_table_status
- name: query_table_status
- summary: Query the link table status of a link connection.
- signature: 'query_table_status(link_connection_name: str, query_table_status_request:
- _models.QueryTableStatusRequest, *, content_type: str = ''application/json'',
- **kwargs: Any) -> _models.LinkConnectionQueryTableStatus'
- parameters:
- - name: link_connection_name
- description: The link connection name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: query_table_status_request
- description: 'Query table status request. Is either a
-
- QueryTableStatusRequest type or a IO type. Required.'
- isRequired: true
- types:
- - <xref:azure.synapse.artifacts.models.QueryTableStatusRequest>
- - <xref:typing.IO>
- - name: content_type
- description: 'Body Parameter content-type. Known values are: ''application/json''.
-
- Default value is None.'
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: LinkConnectionQueryTableStatus or the result of cls(response)
- types:
- - <xref:azure.synapse.artifacts.models.LinkConnectionQueryTableStatus>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.LinkConnectionOperations.resume
- name: resume
- summary: 'Resume a link connection. It may take a few minutes from Resuming to Running,
- monitor the
-
- status with LinkConnection_GetDetailedStatus.'
- signature: 'resume(link_connection_name: str, **kwargs: Any) -> None'
- parameters:
- - name: link_connection_name
- description: The link connection name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: None or the result of cls(response)
- types:
- - <xref:None>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.LinkConnectionOperations.start
- name: start
- summary: 'Start a link connection. It may take a few minutes from Starting to Running,
- monitor the status
-
- with LinkConnection_GetDetailedStatus.'
- signature: 'start(link_connection_name: str, **kwargs: Any) -> None'
- parameters:
- - name: link_connection_name
- description: The link connection name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: None or the result of cls(response)
- types:
- - <xref:None>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.LinkConnectionOperations.stop
- name: stop
- summary: 'Stop a link connection. It may take a few minutes from Stopping to stopped,
- monitor the status
-
- with LinkConnection_GetDetailedStatus.'
- signature: 'stop(link_connection_name: str, **kwargs: Any) -> None'
- parameters:
- - name: link_connection_name
- description: The link connection name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: None or the result of cls(response)
- types:
- - <xref:None>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.LinkConnectionOperations.update_landing_zone_credential
- name: update_landing_zone_credential
- summary: Update landing zone credential of a link connection.
- signature: 'update_landing_zone_credential(link_connection_name: str, sas_token:
- SecureString | None = None, **kwargs: Any) -> None'
- parameters:
- - name: link_connection_name
- description: The link connection name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: sas_token
- description: Landing zone's sas token. Default value is None.
- isRequired: true
- types:
- - <xref:azure.synapse.artifacts.models.SecureString>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: None or the result of cls(response)
- types:
- - <xref:None>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-attributes:
-- uid: azure.synapse.artifacts.operations.LinkConnectionOperations.models
- name: models
- signature: models = <module 'azure.synapse.artifacts.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.5\\x64\\Lib\\site-packages\\azure\\synapse\\artifacts\\models\\__init__.py'>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.LinkedServiceOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.LinkedServiceOperations.yml
index 27f5f58cedee..cca4cb35e8cb 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.LinkedServiceOperations.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.LinkedServiceOperations.yml
@@ -5,25 +5,45 @@ fullName: azure.synapse.artifacts.operations.LinkedServiceOperations
module: azure.synapse.artifacts.operations
inheritances:
- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:linked_service> attribute.\n>"
+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(*args, **kwargs)
+ 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.begin_create_or_update_linked_service
- name: begin_create_or_update_linked_service
+- 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: 'begin_create_or_update_linked_service(linked_service_name: str, properties:
- LinkedService, if_match: str | None = None, **kwargs: Any) -> LROPoller[LinkedServiceResource]'
+ 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. Required.
+ description: The linked service name.
isRequired: true
types:
- <xref:str>
- name: properties
- description: Properties of linked service. Required.
+ description: Properties of linked service.
isRequired: true
types:
- <xref:azure.synapse.artifacts.models.LinkedService>
@@ -31,55 +51,27 @@ methods:
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.
- Default value is
-
- None.'
- isRequired: true
+ which it should match existing entity or can be * for unconditional update.'
+ defaultValue: None
types:
- <xref:str>
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
return:
- description: 'An instance of LROPoller that returns either LinkedServiceResource
- or the result of
-
- cls(response)'
+ description: LinkedServiceResource, or the result of cls(response)
types:
- - <xref:azure.core.polling.LROPoller>[<xref:azure.synapse.artifacts.models.LinkedServiceResource>]
+ - <xref:azure.synapse.artifacts.models.LinkedServiceResource>
exceptions:
- type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.LinkedServiceOperations.begin_delete_linked_service
- name: begin_delete_linked_service
+- uid: azure.synapse.artifacts.operations.LinkedServiceOperations.delete_linked_service
+ name: delete_linked_service
summary: Deletes a linked service.
- signature: 'begin_delete_linked_service(linked_service_name: str, **kwargs: Any)
- -> LROPoller[None]'
+ signature: 'delete_linked_service(linked_service_name: str, **kwargs: Any) -> None'
parameters:
- name: linked_service_name
- description: The linked service name. Required.
+ description: The linked service name.
isRequired: true
types:
- <xref:str>
@@ -87,90 +79,20 @@ methods:
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
return:
- description: An instance of LROPoller that returns either None or the result of
- cls(response)
+ description: None, or the result of cls(response)
types:
- - <xref:azure.core.polling.LROPoller>[<xref:None>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.LinkedServiceOperations.begin_rename_linked_service
- name: begin_rename_linked_service
- summary: Renames a linked service.
- signature: 'begin_rename_linked_service(linked_service_name: str, new_name: str
- | None = None, **kwargs: Any) -> LROPoller[None]'
- parameters:
- - name: linked_service_name
- description: The linked service name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: new_name
- description: New name of the artifact. Default value is None.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
- return:
- description: An instance of LROPoller that returns either None or the result of
- cls(response)
- types:
- - <xref:azure.core.polling.LROPoller>[<xref:None>]
+ - <xref:None>
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) -> LinkedServiceResource | None'
+ = None, **kwargs: Any) -> ''models.LinkedServiceResource'' | None'
parameters:
- name: linked_service_name
- description: The linked service name. Required.
+ description: The linked service name.
isRequired: true
types:
- <xref:str>
@@ -181,8 +103,8 @@ methods:
the ETag matches the existing entity tag, or if * was provided, then no content
will be
- returned. Default value is None.'
- isRequired: true
+ returned.'
+ defaultValue: None
types:
- <xref:str>
- name: cls
@@ -190,7 +112,7 @@ methods:
types:
- <xref:callable>
return:
- description: LinkedServiceResource or None or the result of cls(response)
+ description: LinkedServiceResource, or the result of cls(response)
types:
- <xref:azure.synapse.artifacts.models.LinkedServiceResource>
- <xref:None>
@@ -199,19 +121,17 @@ methods:
- 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[LinkedServiceResource]'
+ signature: 'get_linked_services_by_workspace(**kwargs: Any) -> Iterable[''models.LinkedServiceListResponse'']'
parameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
- description: 'An iterator like instance of either LinkedServiceResource or the
- result of
-
- cls(response)'
+ description: An iterator like instance of either LinkedServiceListResponse or
+ the result of cls(response)
types:
- - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.LinkedServiceResource>]
+ - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.LinkedServiceListResponse>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.MetastoreOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.MetastoreOperations.yml
deleted file mode 100644
index 20df975104e8..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.MetastoreOperations.yml
+++ /dev/null
@@ -1,110 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.operations.MetastoreOperations
-name: MetastoreOperations
-fullName: azure.synapse.artifacts.operations.MetastoreOperations
-module: azure.synapse.artifacts.operations
-inheritances:
-- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:metastore> attribute.\n>"
-constructor:
- syntax: MetastoreOperations(*args, **kwargs)
-methods:
-- uid: azure.synapse.artifacts.operations.MetastoreOperations.delete
- name: delete
- summary: Remove files in Syms.
- signature: 'delete(id: str, **kwargs: Any) -> None'
- parameters:
- - name: id
- description: Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: None or the result of cls(response)
- types:
- - <xref:None>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.MetastoreOperations.get_database_operations
- name: get_database_operations
- summary: Gets status of the database.
- signature: 'get_database_operations(id: str, **kwargs: Any) -> MetastoreRequestSuccessResponse'
- parameters:
- - name: id
- description: Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: MetastoreRequestSuccessResponse or the result of cls(response)
- types:
- - <xref:azure.synapse.artifacts.models.MetastoreRequestSuccessResponse>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.MetastoreOperations.register
- name: register
- summary: Register files in Syms.
- signature: 'register(id: str, input_folder: str, **kwargs: Any) -> MetastoreRegistrationResponse'
- parameters:
- - name: id
- description: 'The name of the database to be created. The name can contain only
- alphanumeric
-
- characters and should not exceed 24 characters. Required.'
- isRequired: true
- types:
- - <xref:str>
- - name: input_folder
- description: The input folder containing CDM files. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: MetastoreRegistrationResponse or the result of cls(response)
- types:
- - <xref:azure.synapse.artifacts.models.MetastoreRegistrationResponse>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.MetastoreOperations.update
- name: update
- summary: Update files in Syms.
- signature: 'update(id: str, input_folder: str, **kwargs: Any) -> MetastoreUpdationResponse'
- parameters:
- - name: id
- description: The name of the database to be updated. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: input_folder
- description: The input folder containing CDM files. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: MetastoreUpdationResponse or the result of cls(response)
- types:
- - <xref:azure.synapse.artifacts.models.MetastoreUpdationResponse>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-attributes:
-- uid: azure.synapse.artifacts.operations.MetastoreOperations.models
- name: models
- signature: models = <module 'azure.synapse.artifacts.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.5\\x64\\Lib\\site-packages\\azure\\synapse\\artifacts\\models\\__init__.py'>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.NotebookOperationResultOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.NotebookOperationResultOperations.yml
deleted file mode 100644
index 9a20a2a36659..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.NotebookOperationResultOperations.yml
+++ /dev/null
@@ -1,37 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.operations.NotebookOperationResultOperations
-name: NotebookOperationResultOperations
-fullName: azure.synapse.artifacts.operations.NotebookOperationResultOperations
-module: azure.synapse.artifacts.operations
-inheritances:
-- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:notebook_operation_result> attribute.\n>"
-constructor:
- syntax: NotebookOperationResultOperations(*args, **kwargs)
-methods:
-- uid: azure.synapse.artifacts.operations.NotebookOperationResultOperations.get
- name: get
- summary: Get notebook operation result.
- signature: 'get(operation_id: str, **kwargs: Any) -> None'
- parameters:
- - name: operation_id
- description: Operation ID. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: None or the result of cls(response)
- types:
- - <xref:None>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-attributes:
-- uid: azure.synapse.artifacts.operations.NotebookOperationResultOperations.models
- name: models
- signature: models = <module 'azure.synapse.artifacts.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.5\\x64\\Lib\\site-packages\\azure\\synapse\\artifacts\\models\\__init__.py'>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.NotebookOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.NotebookOperations.yml
index a1ab9ca7c30c..9529bbd5e7c7 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.NotebookOperations.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.NotebookOperations.yml
@@ -5,89 +5,73 @@ fullName: azure.synapse.artifacts.operations.NotebookOperations
module: azure.synapse.artifacts.operations
inheritances:
- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:notebook> attribute.\n>"
+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(*args, **kwargs)
+ 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.begin_create_or_update_notebook
- name: begin_create_or_update_notebook
+- uid: azure.synapse.artifacts.operations.NotebookOperations.create_or_update_notebook
+ name: create_or_update_notebook
summary: Creates or updates a Note Book.
- signature: 'begin_create_or_update_notebook(notebook_name: str, notebook: _models.NotebookResource,
- if_match: str | None = None, *, content_type: str = ''application/json'', **kwargs:
- Any) -> LROPoller[_models.NotebookResource]'
+ 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. Required.
+ description: The notebook name.
isRequired: true
types:
- <xref:str>
- - name: notebook
- description: 'Note book resource definition. Is either a NotebookResource type
- or a IO type.
-
- Required.'
+ - name: properties
+ description: Properties of Notebook.
isRequired: true
types:
- - <xref:azure.synapse.artifacts.models.NotebookResource>
- - <xref:typing.IO>
+ - <xref:azure.synapse.artifacts.models.Notebook>
- 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. Default
- value is None.'
- isRequired: true
- types:
- - <xref:str>
- - name: content_type
- description: 'Body Parameter content-type. Known values are: ''application/json''.
-
- Default value is None.'
+ it should match existing entity or can be * for unconditional update.'
+ defaultValue: None
types:
- <xref:str>
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
return:
- description: 'An instance of LROPoller that returns either NotebookResource or
- the result of
-
- cls(response)'
+ description: NotebookResource, or the result of cls(response)
types:
- - <xref:azure.core.polling.LROPoller>[<xref:azure.synapse.artifacts.models.NotebookResource>]
+ - <xref:azure.synapse.artifacts.models.NotebookResource>
exceptions:
- type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.NotebookOperations.begin_delete_notebook
- name: begin_delete_notebook
+- uid: azure.synapse.artifacts.operations.NotebookOperations.delete_notebook
+ name: delete_notebook
summary: Deletes a Note book.
- signature: 'begin_delete_notebook(notebook_name: str, **kwargs: Any) -> LROPoller[None]'
+ signature: 'delete_notebook(notebook_name: str, **kwargs: Any) -> None'
parameters:
- name: notebook_name
- description: The notebook name. Required.
+ description: The notebook name.
isRequired: true
types:
- <xref:str>
@@ -95,90 +79,20 @@ methods:
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
- return:
- description: An instance of LROPoller that returns either None or the result of
- cls(response)
- types:
- - <xref:azure.core.polling.LROPoller>[<xref:None>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.NotebookOperations.begin_rename_notebook
- name: begin_rename_notebook
- summary: Renames a notebook.
- signature: 'begin_rename_notebook(notebook_name: str, new_name: str | None = None,
- **kwargs: Any) -> LROPoller[None]'
- parameters:
- - name: notebook_name
- description: The notebook name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: new_name
- description: New name of the artifact. Default value is None.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
return:
- description: An instance of LROPoller that returns either None or the result of
- cls(response)
+ description: None, or the result of cls(response)
types:
- - <xref:azure.core.polling.LROPoller>[<xref:None>]
+ - <xref:None>
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) -> NotebookResource | None'
+ Any) -> ''models.NotebookResource'' | None'
parameters:
- name: notebook_name
- description: The notebook name. Required.
+ description: The notebook name.
isRequired: true
types:
- <xref:str>
@@ -187,10 +101,8 @@ methods:
the
ETag matches the existing entity tag, or if * was provided, then no content
- will be returned.
-
- Default value is None.'
- isRequired: true
+ will be returned.'
+ defaultValue: None
types:
- <xref:str>
- name: cls
@@ -198,7 +110,7 @@ methods:
types:
- <xref:callable>
return:
- description: NotebookResource or None or the result of cls(response)
+ description: NotebookResource, or the result of cls(response)
types:
- <xref:azure.synapse.artifacts.models.NotebookResource>
- <xref:None>
@@ -207,33 +119,33 @@ methods:
- 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[NotebookResource]'
+ signature: 'get_notebook_summary_by_work_space(**kwargs: Any) -> Iterable[''models.NotebookListResponse'']'
parameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
- description: An iterator like instance of either NotebookResource or the result
+ description: An iterator like instance of either NotebookListResponse or the result
of cls(response)
types:
- - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.NotebookResource>]
+ - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.NotebookListResponse>]
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[NotebookResource]'
+ signature: 'get_notebooks_by_workspace(**kwargs: Any) -> Iterable[''models.NotebookListResponse'']'
parameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
- description: An iterator like instance of either NotebookResource or the result
+ description: An iterator like instance of either NotebookListResponse or the result
of cls(response)
types:
- - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.NotebookResource>]
+ - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.NotebookListResponse>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.PipelineOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.PipelineOperations.yml
index cf864be43a9d..9f1301d4cffc 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.PipelineOperations.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.PipelineOperations.yml
@@ -5,170 +5,64 @@ fullName: azure.synapse.artifacts.operations.PipelineOperations
module: azure.synapse.artifacts.operations
inheritances:
- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:pipeline> attribute.\n>"
+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(*args, **kwargs)
+ 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.begin_create_or_update_pipeline
- name: begin_create_or_update_pipeline
+- uid: azure.synapse.artifacts.operations.PipelineOperations.create_or_update_pipeline
+ name: create_or_update_pipeline
summary: Creates or updates a pipeline.
- signature: 'begin_create_or_update_pipeline(pipeline_name: str, pipeline: _models.PipelineResource,
- if_match: str | None = None, *, content_type: str = ''application/json'', **kwargs:
- Any) -> LROPoller[_models.PipelineResource]'
+ 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. Required.
+ description: The pipeline name.
isRequired: true
types:
- <xref:str>
- name: pipeline
- description: 'Pipeline resource definition. Is either a PipelineResource type
- or a IO type.
-
- Required.'
+ description: Pipeline resource definition.
isRequired: true
types:
- <xref:azure.synapse.artifacts.models.PipelineResource>
- - <xref:typing.IO>
- 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. Default
- value is None.'
- isRequired: true
- types:
- - <xref:str>
- - name: content_type
- description: 'Body Parameter content-type. Known values are: ''application/json''.
-
- Default value is None.'
+ it should match existing entity or can be * for unconditional update.'
+ defaultValue: None
types:
- <xref:str>
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
return:
- description: 'An instance of LROPoller that returns either PipelineResource or
- the result of
-
- cls(response)'
+ description: PipelineResource, or the result of cls(response)
types:
- - <xref:azure.core.polling.LROPoller>[<xref:azure.synapse.artifacts.models.PipelineResource>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.PipelineOperations.begin_delete_pipeline
- name: begin_delete_pipeline
- summary: Deletes a pipeline.
- signature: 'begin_delete_pipeline(pipeline_name: str, **kwargs: Any) -> LROPoller[None]'
- parameters:
- - name: pipeline_name
- description: The pipeline name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
- return:
- description: An instance of LROPoller that returns either None or the result of
- cls(response)
- types:
- - <xref:azure.core.polling.LROPoller>[<xref:None>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.PipelineOperations.begin_rename_pipeline
- name: begin_rename_pipeline
- summary: Renames a pipeline.
- signature: 'begin_rename_pipeline(pipeline_name: str, new_name: str | None = None,
- **kwargs: Any) -> LROPoller[None]'
- parameters:
- - name: pipeline_name
- description: The pipeline name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: new_name
- description: New name of the artifact. Default value is None.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
- return:
- description: An instance of LROPoller that returns either None or the result of
- cls(response)
- types:
- - <xref:azure.core.polling.LROPoller>[<xref:None>]
+ - <xref:azure.synapse.artifacts.models.PipelineResource>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.synapse.artifacts.operations.PipelineOperations.create_pipeline_run
@@ -176,53 +70,60 @@ methods:
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, JSON] | None = None, *, content_type: str = ''application/json'',
- **kwargs: Any) -> _models.CreateRunResponse'
+ = None, parameters: Dict[str, object] | None = None, **kwargs: Any) -> models.CreateRunResponse'
parameters:
- name: pipeline_name
- description: The pipeline name. Required.
+ description: The pipeline name.
isRequired: true
types:
- <xref:str>
- 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. Default value
- is None.'
- isRequired: true
+ parameters of the specified run will be used to create a new run.'
+ defaultValue: None
types:
- <xref:str>
- 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.
- Default value
-
- is None.'
- isRequired: true
+ referenced pipeline run and the new run will be grouped under the same groupId.'
+ defaultValue: None
types:
- <xref:bool>
- name: start_activity_name
description: 'In recovery mode, the rerun will start from this activity. If not
- specified, all activities will run. Default value is None.'
- isRequired: true
+ specified, all activities will run.'
+ defaultValue: None
types:
- <xref:str>
- name: parameters
description: 'Parameters of the pipeline run. These parameters will be used only
if the
- runId is not specified. Is either a {str: JSON} type or a IO type. Default value
- is None.'
- isRequired: true
+ runId is not specified.'
+ defaultValue: None
types:
- - <xref:dict>[<xref:str>, <xref:JSON>]
- - <xref:typing.IO>
- - name: content_type
- description: 'Body Parameter content-type. Known values are: ''application/json''.
-
- Default value is None.'
+ - <xref:dict>[<xref:str>, <xref:object>]
+ - name: cls
+ description: A custom type or function that will be passed the direct response
+ types:
+ - <xref:callable>
+ return:
+ description: CreateRunResponse, or the result of cls(response)
+ types:
+ - <xref:azure.synapse.artifacts.models.CreateRunResponse>
+ 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:
- <xref:str>
- name: cls
@@ -230,19 +131,19 @@ methods:
types:
- <xref:callable>
return:
- description: CreateRunResponse or the result of cls(response)
+ description: None, or the result of cls(response)
types:
- - <xref:azure.synapse.artifacts.models.CreateRunResponse>
+ - <xref:None>
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) -> PipelineResource | None'
+ Any) -> ''models.PipelineResource'' | None'
parameters:
- name: pipeline_name
- description: The pipeline name. Required.
+ description: The pipeline name.
isRequired: true
types:
- <xref:str>
@@ -251,10 +152,8 @@ methods:
the
ETag matches the existing entity tag, or if * was provided, then no content
- will be returned.
-
- Default value is None.'
- isRequired: true
+ will be returned.'
+ defaultValue: None
types:
- <xref:str>
- name: cls
@@ -262,7 +161,7 @@ methods:
types:
- <xref:callable>
return:
- description: PipelineResource or None or the result of cls(response)
+ description: PipelineResource, or the result of cls(response)
types:
- <xref:azure.synapse.artifacts.models.PipelineResource>
- <xref:None>
@@ -271,17 +170,17 @@ methods:
- 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[PipelineResource]'
+ signature: 'get_pipelines_by_workspace(**kwargs: Any) -> Iterable[''models.PipelineListResponse'']'
parameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
- description: An iterator like instance of either PipelineResource or the result
+ description: An iterator like instance of either PipelineListResponse or the result
of cls(response)
types:
- - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.PipelineResource>]
+ - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.PipelineListResponse>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.PipelineRunOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.PipelineRunOperations.yml
index fa8a327a7568..6faae57e679b 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.PipelineRunOperations.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.PipelineRunOperations.yml
@@ -5,11 +5,31 @@ fullName: azure.synapse.artifacts.operations.PipelineRunOperations
module: azure.synapse.artifacts.operations
inheritances:
- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:pipeline_run> attribute.\n>"
+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(*args, **kwargs)
+ 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
@@ -18,7 +38,7 @@ methods:
Any) -> None'
parameters:
- name: run_id
- description: The pipeline run identifier. Required.
+ description: The pipeline run identifier.
isRequired: true
types:
- <xref:str>
@@ -26,8 +46,8 @@ methods:
description: 'If true, cancel all the Child pipelines that are triggered by the
current
- pipeline. Default value is None.'
- isRequired: true
+ pipeline.'
+ defaultValue: None
types:
- <xref:bool>
- name: cls
@@ -35,7 +55,7 @@ methods:
types:
- <xref:callable>
return:
- description: None or the result of cls(response)
+ description: None, or the result of cls(response)
types:
- <xref:None>
exceptions:
@@ -43,10 +63,10 @@ methods:
- 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) -> PipelineRun'
+ signature: 'get_pipeline_run(run_id: str, **kwargs: Any) -> models.PipelineRun'
parameters:
- name: run_id
- description: The pipeline run identifier. Required.
+ description: The pipeline run identifier.
isRequired: true
types:
- <xref:str>
@@ -55,7 +75,7 @@ methods:
types:
- <xref:callable>
return:
- description: PipelineRun or the result of cls(response)
+ description: PipelineRun, or the result of cls(response)
types:
- <xref:azure.synapse.artifacts.models.PipelineRun>
exceptions:
@@ -64,39 +84,29 @@ methods:
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, *, content_type: str = ''application/json'', **kwargs:
- Any) -> _models.ActivityRunsQueryResponse'
+ ''models.RunFilterParameters'', **kwargs: Any) -> models.ActivityRunsQueryResponse'
parameters:
- name: pipeline_name
- description: The pipeline name. Required.
+ description: The pipeline name.
isRequired: true
types:
- <xref:str>
- name: run_id
- description: The pipeline run identifier. Required.
+ description: The pipeline run identifier.
isRequired: true
types:
- <xref:str>
- name: filter_parameters
- description: 'Parameters to filter the activity runs. Is either a
-
- RunFilterParameters type or a IO type. Required.'
+ description: Parameters to filter the activity runs.
isRequired: true
types:
- <xref:azure.synapse.artifacts.models.RunFilterParameters>
- - <xref:typing.IO>
- - name: content_type
- description: 'Body Parameter content-type. Known values are: ''application/json''.
-
- Default value is None.'
- types:
- - <xref:str>
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
- description: ActivityRunsQueryResponse or the result of cls(response)
+ description: ActivityRunsQueryResponse, or the result of cls(response)
types:
- <xref:azure.synapse.artifacts.models.ActivityRunsQueryResponse>
exceptions:
@@ -104,29 +114,20 @@ methods:
- 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,
- *, content_type: str = ''application/json'', **kwargs: Any) -> _models.PipelineRunsQueryResponse'
+ 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. Is either a
-
- RunFilterParameters type or a IO type. Required.'
+ description: Parameters to filter the pipeline run.
isRequired: true
types:
- <xref:azure.synapse.artifacts.models.RunFilterParameters>
- - <xref:typing.IO>
- - name: content_type
- description: 'Body Parameter content-type. Known values are: ''application/json''.
-
- Default value is None.'
- types:
- - <xref:str>
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
- description: PipelineRunsQueryResponse or the result of cls(response)
+ description: PipelineRunsQueryResponse, or the result of cls(response)
types:
- <xref:azure.synapse.artifacts.models.PipelineRunsQueryResponse>
exceptions:
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.RunNotebookOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.RunNotebookOperations.yml
deleted file mode 100644
index db97f15b5a04..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.RunNotebookOperations.yml
+++ /dev/null
@@ -1,136 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.operations.RunNotebookOperations
-name: RunNotebookOperations
-fullName: azure.synapse.artifacts.operations.RunNotebookOperations
-module: azure.synapse.artifacts.operations
-inheritances:
-- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:run_notebook> attribute.\n>"
-constructor:
- syntax: RunNotebookOperations(*args, **kwargs)
-methods:
-- uid: azure.synapse.artifacts.operations.RunNotebookOperations.begin_create_run
- name: begin_create_run
- summary: Run notebook.
- signature: 'begin_create_run(run_id: str, run_notebook_request: _models.RunNotebookRequest,
- *, content_type: str = ''application/json'', **kwargs: Any) -> LROPoller[_models.RunNotebookResponse]'
- parameters:
- - name: run_id
- description: Notebook run id. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: run_notebook_request
- description: 'Run notebook request payload. Is either a RunNotebookRequest type
-
- or a IO type. Required.'
- isRequired: true
- types:
- - <xref:azure.synapse.artifacts.models.RunNotebookRequest>
- - <xref:typing.IO>
- - name: content_type
- description: 'Body Parameter content-type. Known values are: ''application/json''.
-
- Default value is None.'
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
- return:
- description: 'An instance of LROPoller that returns either RunNotebookResponse
- or the result of
-
- cls(response)'
- types:
- - <xref:azure.core.polling.LROPoller>[<xref:azure.synapse.artifacts.models.RunNotebookResponse>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.RunNotebookOperations.cancel_run
- name: cancel_run
- summary: Cancel notebook run.
- signature: 'cancel_run(run_id: str, **kwargs: Any) -> RunNotebookResponse'
- parameters:
- - name: run_id
- description: Notebook run id. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: RunNotebookResponse or the result of cls(response)
- types:
- - <xref:azure.synapse.artifacts.models.RunNotebookResponse>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.RunNotebookOperations.get_snapshot
- name: get_snapshot
- summary: Get RunNotebook Snapshot for run id.
- signature: 'get_snapshot(run_id: str, **kwargs: Any) -> RunNotebookSnapshotResponse'
- parameters:
- - name: run_id
- description: Notebook run id. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: RunNotebookSnapshotResponse or the result of cls(response)
- types:
- - <xref:azure.synapse.artifacts.models.RunNotebookSnapshotResponse>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.RunNotebookOperations.get_status
- name: get_status
- summary: Get RunNotebook Status for run id.
- signature: 'get_status(run_id: str, **kwargs: Any) -> RunNotebookResponse'
- parameters:
- - name: run_id
- description: Notebook run id. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: RunNotebookResponse or the result of cls(response)
- types:
- - <xref:azure.synapse.artifacts.models.RunNotebookResponse>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-attributes:
-- uid: azure.synapse.artifacts.operations.RunNotebookOperations.models
- name: models
- signature: models = <module 'azure.synapse.artifacts.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.5\\x64\\Lib\\site-packages\\azure\\synapse\\artifacts\\models\\__init__.py'>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.SparkConfigurationOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.SparkConfigurationOperations.yml
deleted file mode 100644
index 68a1ce3c1b0f..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.SparkConfigurationOperations.yml
+++ /dev/null
@@ -1,221 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.operations.SparkConfigurationOperations
-name: SparkConfigurationOperations
-fullName: azure.synapse.artifacts.operations.SparkConfigurationOperations
-module: azure.synapse.artifacts.operations
-inheritances:
-- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:spark_configuration> attribute.\n>"
-constructor:
- syntax: SparkConfigurationOperations(*args, **kwargs)
-methods:
-- uid: azure.synapse.artifacts.operations.SparkConfigurationOperations.begin_create_or_update_spark_configuration
- name: begin_create_or_update_spark_configuration
- summary: Creates or updates a sparkconfiguration.
- signature: 'begin_create_or_update_spark_configuration(spark_configuration_name:
- str, properties: SparkConfiguration, if_match: str | None = None, **kwargs: Any)
- -> LROPoller[SparkConfigurationResource]'
- parameters:
- - name: spark_configuration_name
- description: The spark Configuration name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: properties
- description: Properties of Spark Configuration. Required.
- isRequired: true
- types:
- - <xref:azure.synapse.artifacts.models.SparkConfiguration>
- - name: if_match
- description: 'ETag of the sparkConfiguration entity. Should only be specified
- for update,
-
- for which it should match existing entity or can be * for unconditional update.
- Default value
-
- is None.'
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
- return:
- description: 'An instance of LROPoller that returns either SparkConfigurationResource
- or the result
-
- of cls(response)'
- types:
- - <xref:azure.core.polling.LROPoller>[<xref:azure.synapse.artifacts.models.SparkConfigurationResource>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.SparkConfigurationOperations.begin_delete_spark_configuration
- name: begin_delete_spark_configuration
- summary: Deletes a sparkConfiguration.
- signature: 'begin_delete_spark_configuration(spark_configuration_name: str, **kwargs:
- Any) -> LROPoller[None]'
- parameters:
- - name: spark_configuration_name
- description: The spark Configuration name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
- return:
- description: An instance of LROPoller that returns either None or the result of
- cls(response)
- types:
- - <xref:azure.core.polling.LROPoller>[<xref:None>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.SparkConfigurationOperations.begin_rename_spark_configuration
- name: begin_rename_spark_configuration
- summary: Renames a sparkConfiguration.
- signature: 'begin_rename_spark_configuration(spark_configuration_name: str, new_name:
- str | None = None, **kwargs: Any) -> LROPoller[None]'
- parameters:
- - name: spark_configuration_name
- description: The spark Configuration name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: new_name
- description: New name of the artifact. Default value is None.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
- return:
- description: An instance of LROPoller that returns either None or the result of
- cls(response)
- types:
- - <xref:azure.core.polling.LROPoller>[<xref:None>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.SparkConfigurationOperations.get_spark_configuration
- name: get_spark_configuration
- summary: Gets a sparkConfiguration.
- signature: 'get_spark_configuration(spark_configuration_name: str, if_none_match:
- str | None = None, **kwargs: Any) -> SparkConfigurationResource | None'
- parameters:
- - name: spark_configuration_name
- description: The spark Configuration name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: if_none_match
- description: 'ETag of the sparkConfiguration 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. Default value is None.'
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: SparkConfigurationResource or None or the result of cls(response)
- types:
- - <xref:azure.synapse.artifacts.models.SparkConfigurationResource>
- - <xref:None>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.SparkConfigurationOperations.get_spark_configurations_by_workspace
- name: get_spark_configurations_by_workspace
- summary: Lists sparkconfigurations.
- signature: 'get_spark_configurations_by_workspace(**kwargs: Any) -> Iterable[SparkConfigurationResource]'
- parameters:
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: 'An iterator like instance of either SparkConfigurationResource or
- the result of
-
- cls(response)'
- types:
- - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.SparkConfigurationResource>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-attributes:
-- uid: azure.synapse.artifacts.operations.SparkConfigurationOperations.models
- name: models
- signature: models = <module 'azure.synapse.artifacts.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.5\\x64\\Lib\\site-packages\\azure\\synapse\\artifacts\\models\\__init__.py'>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.SparkJobDefinitionOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.SparkJobDefinitionOperations.yml
index d5b5ad6d8a3f..45e0f55849a9 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.SparkJobDefinitionOperations.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.SparkJobDefinitionOperations.yml
@@ -5,82 +5,40 @@ fullName: azure.synapse.artifacts.operations.SparkJobDefinitionOperations
module: azure.synapse.artifacts.operations
inheritances:
- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:spark_job_definition> attribute.\n>"
+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(*args, **kwargs)
-methods:
-- uid: azure.synapse.artifacts.operations.SparkJobDefinitionOperations.begin_create_or_update_spark_job_definition
- name: begin_create_or_update_spark_job_definition
- summary: Creates or updates a Spark Job Definition.
- signature: 'begin_create_or_update_spark_job_definition(spark_job_definition_name:
- str, properties: SparkJobDefinition, if_match: str | None = None, **kwargs: Any)
- -> LROPoller[SparkJobDefinitionResource]'
+ syntax: SparkJobDefinitionOperations(client, config, serializer, deserializer)
parameters:
- - name: spark_job_definition_name
- description: The spark job definition name. Required.
+ - name: client
+ description: Client for service requests.
isRequired: true
- types:
- - <xref:str>
- - name: properties
- description: Properties of spark job definition. Required.
+ - name: config
+ description: Configuration of service client.
isRequired: true
- types:
- - <xref:azure.synapse.artifacts.models.SparkJobDefinition>
- - 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.
- Default value
-
- is None.'
+ - name: serializer
+ description: An object model serializer.
isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
- return:
- description: 'An instance of LROPoller that returns either SparkJobDefinitionResource
- or the result
-
- of cls(response)'
- types:
- - <xref:azure.core.polling.LROPoller>[<xref:azure.synapse.artifacts.models.SparkJobDefinitionResource>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
+ - 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: SparkJobDefinition, **kwargs:
- Any) -> LROPoller[SparkBatchJob]'
+ signature: 'begin_debug_spark_job_definition(properties: ''models.SparkJobDefinition'',
+ **kwargs: Any) -> LROPoller[''models.SparkBatchJob'']'
parameters:
- name: properties
- description: Properties of spark job definition. Required.
+ description: Properties of spark job definition.
isRequired: true
types:
- <xref:azure.synapse.artifacts.models.SparkJobDefinition>
@@ -93,39 +51,32 @@ methods:
types:
- <xref:str>
- 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
+ description: 'True for ARMPolling, False for no polling, or a
- polling strategy.'
+ polling object for personal polling strategy'
types:
- <xref:bool>
- <xref:azure.core.polling.PollingMethod>
- name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
+ description: Default waiting time between two polls for LRO operations if no Retry-After
+ header is present.
types:
- <xref:int>
return:
- description: 'An instance of LROPoller that returns either SparkBatchJob or the
- result of
-
- cls(response)'
+ description: An instance of LROPoller that returns either SparkBatchJob or the
+ result of cls(response)
types:
- <xref:azure.core.polling.LROPoller>[<xref:azure.synapse.artifacts.models.SparkBatchJob>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.SparkJobDefinitionOperations.begin_delete_spark_job_definition
- name: begin_delete_spark_job_definition
- summary: Deletes a Spark Job Definition.
- signature: 'begin_delete_spark_job_definition(spark_job_definition_name: str, **kwargs:
- Any) -> LROPoller[None]'
+- 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. Required.
+ description: The spark job definition name.
isRequired: true
types:
- <xref:str>
@@ -138,87 +89,67 @@ methods:
types:
- <xref:str>
- 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
+ description: 'True for ARMPolling, False for no polling, or a
- polling strategy.'
+ polling object for personal polling strategy'
types:
- <xref:bool>
- <xref:azure.core.polling.PollingMethod>
- name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
+ description: Default waiting time between two polls for LRO operations if no Retry-After
+ header is present.
types:
- <xref:int>
return:
- description: An instance of LROPoller that returns either None or the result of
- cls(response)
+ description: An instance of LROPoller that returns either SparkBatchJob or the
+ result of cls(response)
types:
- - <xref:azure.core.polling.LROPoller>[<xref:None>]
+ - <xref:azure.core.polling.LROPoller>[<xref:azure.synapse.artifacts.models.SparkBatchJob>]
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[SparkBatchJob]'
+- 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. Required.
+ description: The spark job definition name.
isRequired: true
types:
- <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
+ - name: properties
+ description: Properties of spark job definition.
+ isRequired: true
types:
- - <xref:str>
- - 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
+ - <xref:azure.synapse.artifacts.models.SparkJobDefinition>
+ - name: if_match
+ description: 'ETag of the Spark Job Definition entity. Should only be specified
+ for update,
- polling strategy.'
+ for which it should match existing entity or can be * for unconditional update.'
+ defaultValue: None
types:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
+ - <xref:str>
+ - name: cls
+ description: A custom type or function that will be passed the direct response
types:
- - <xref:int>
+ - <xref:callable>
return:
- description: 'An instance of LROPoller that returns either SparkBatchJob or the
- result of
-
- cls(response)'
+ description: SparkJobDefinitionResource, or the result of cls(response)
types:
- - <xref:azure.core.polling.LROPoller>[<xref:azure.synapse.artifacts.models.SparkBatchJob>]
+ - <xref:azure.synapse.artifacts.models.SparkJobDefinitionResource>
exceptions:
- type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.SparkJobDefinitionOperations.begin_rename_spark_job_definition
- name: begin_rename_spark_job_definition
- summary: Renames a sparkJobDefinition.
- signature: 'begin_rename_spark_job_definition(spark_job_definition_name: str, new_name:
- str | None = None, **kwargs: Any) -> LROPoller[None]'
+- 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. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: new_name
- description: New name of the artifact. Default value is None.
+ description: The spark job definition name.
isRequired: true
types:
- <xref:str>
@@ -226,42 +157,20 @@ methods:
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
return:
- description: An instance of LROPoller that returns either None or the result of
- cls(response)
+ description: None, or the result of cls(response)
types:
- - <xref:azure.core.polling.LROPoller>[<xref:None>]
+ - <xref:None>
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) -> SparkJobDefinitionResource | None'
+ str | None = None, **kwargs: Any) -> ''models.SparkJobDefinitionResource'' | None'
parameters:
- name: spark_job_definition_name
- description: The spark job definition name. Required.
+ description: The spark job definition name.
isRequired: true
types:
- <xref:str>
@@ -272,8 +181,8 @@ methods:
get. If the ETag matches the existing entity tag, or if * was provided, then
no content will be
- returned. Default value is None.'
- isRequired: true
+ returned.'
+ defaultValue: None
types:
- <xref:str>
- name: cls
@@ -281,7 +190,7 @@ methods:
types:
- <xref:callable>
return:
- description: SparkJobDefinitionResource or None or the result of cls(response)
+ description: SparkJobDefinitionResource, or the result of cls(response)
types:
- <xref:azure.synapse.artifacts.models.SparkJobDefinitionResource>
- <xref:None>
@@ -290,19 +199,17 @@ methods:
- 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[SparkJobDefinitionResource]'
+ signature: 'get_spark_job_definitions_by_workspace(**kwargs: Any) -> Iterable[''models.SparkJobDefinitionsListResponse'']'
parameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
- description: 'An iterator like instance of either SparkJobDefinitionResource or
- the result of
-
- cls(response)'
+ description: An iterator like instance of either SparkJobDefinitionsListResponse
+ or the result of cls(response)
types:
- - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.SparkJobDefinitionResource>]
+ - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.SparkJobDefinitionsListResponse>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.SqlPoolsOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.SqlPoolsOperations.yml
deleted file mode 100644
index 634e3ab2c8cd..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.SqlPoolsOperations.yml
+++ /dev/null
@@ -1,52 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.operations.SqlPoolsOperations
-name: SqlPoolsOperations
-fullName: azure.synapse.artifacts.operations.SqlPoolsOperations
-module: azure.synapse.artifacts.operations
-inheritances:
-- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:sql_pools> attribute.\n>"
-constructor:
- syntax: SqlPoolsOperations(*args, **kwargs)
-methods:
-- uid: azure.synapse.artifacts.operations.SqlPoolsOperations.get
- name: get
- summary: Get Sql Pool.
- signature: 'get(sql_pool_name: str, **kwargs: Any) -> SqlPool'
- parameters:
- - name: sql_pool_name
- description: The Sql Pool name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: SqlPool or the result of cls(response)
- types:
- - <xref:azure.synapse.artifacts.models.SqlPool>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.SqlPoolsOperations.list
- name: list
- summary: List Sql Pools.
- signature: 'list(**kwargs: Any) -> SqlPoolInfoListResult'
- parameters:
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: SqlPoolInfoListResult or the result of cls(response)
- types:
- - <xref:azure.synapse.artifacts.models.SqlPoolInfoListResult>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-attributes:
-- uid: azure.synapse.artifacts.operations.SqlPoolsOperations.models
- name: models
- signature: models = <module 'azure.synapse.artifacts.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.5\\x64\\Lib\\site-packages\\azure\\synapse\\artifacts\\models\\__init__.py'>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.SqlScriptOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.SqlScriptOperations.yml
index 176165f3c8e8..1f48c930f8a4 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.SqlScriptOperations.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.SqlScriptOperations.yml
@@ -5,89 +5,73 @@ fullName: azure.synapse.artifacts.operations.SqlScriptOperations
module: azure.synapse.artifacts.operations
inheritances:
- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:sql_script> attribute.\n>"
+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(*args, **kwargs)
+ 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.begin_create_or_update_sql_script
- name: begin_create_or_update_sql_script
+- 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: 'begin_create_or_update_sql_script(sql_script_name: str, sql_script:
- _models.SqlScriptResource, if_match: str | None = None, *, content_type: str =
- ''application/json'', **kwargs: Any) -> LROPoller[_models.SqlScriptResource]'
+ 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. Required.
+ description: The sql script name.
isRequired: true
types:
- <xref:str>
- - name: sql_script
- description: 'Sql Script resource definition. Is either a SqlScriptResource type
- or a IO
-
- type. Required.'
+ - name: properties
+ description: Properties of sql script.
isRequired: true
types:
- - <xref:azure.synapse.artifacts.models.SqlScriptResource>
- - <xref:typing.IO>
+ - <xref:azure.synapse.artifacts.models.SqlScript>
- 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. Default
- value is None.'
- isRequired: true
- types:
- - <xref:str>
- - name: content_type
- description: 'Body Parameter content-type. Known values are: ''application/json''.
-
- Default value is None.'
+ it should match existing entity or can be * for unconditional update.'
+ defaultValue: None
types:
- <xref:str>
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
return:
- description: 'An instance of LROPoller that returns either SqlScriptResource or
- the result of
-
- cls(response)'
+ description: SqlScriptResource, or the result of cls(response)
types:
- - <xref:azure.core.polling.LROPoller>[<xref:azure.synapse.artifacts.models.SqlScriptResource>]
+ - <xref:azure.synapse.artifacts.models.SqlScriptResource>
exceptions:
- type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.SqlScriptOperations.begin_delete_sql_script
- name: begin_delete_sql_script
+- uid: azure.synapse.artifacts.operations.SqlScriptOperations.delete_sql_script
+ name: delete_sql_script
summary: Deletes a Sql Script.
- signature: 'begin_delete_sql_script(sql_script_name: str, **kwargs: Any) -> LROPoller[None]'
+ signature: 'delete_sql_script(sql_script_name: str, **kwargs: Any) -> None'
parameters:
- name: sql_script_name
- description: The sql script name. Required.
+ description: The sql script name.
isRequired: true
types:
- <xref:str>
@@ -95,90 +79,20 @@ methods:
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
- return:
- description: An instance of LROPoller that returns either None or the result of
- cls(response)
- types:
- - <xref:azure.core.polling.LROPoller>[<xref:None>]
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.SqlScriptOperations.begin_rename_sql_script
- name: begin_rename_sql_script
- summary: Renames a sqlScript.
- signature: 'begin_rename_sql_script(sql_script_name: str, new_name: str | None =
- None, **kwargs: Any) -> LROPoller[None]'
- parameters:
- - name: sql_script_name
- description: The sql script name. Required.
- isRequired: true
- types:
- - <xref:str>
- - name: new_name
- description: New name of the artifact. Default value is None.
- isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
return:
- description: An instance of LROPoller that returns either None or the result of
- cls(response)
+ description: None, or the result of cls(response)
types:
- - <xref:azure.core.polling.LROPoller>[<xref:None>]
+ - <xref:None>
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) -> SqlScriptResource | None'
+ **kwargs: Any) -> ''models.SqlScriptResource'' | None'
parameters:
- name: sql_script_name
- description: The sql script name. Required.
+ description: The sql script name.
isRequired: true
types:
- <xref:str>
@@ -187,10 +101,8 @@ methods:
If the
ETag matches the existing entity tag, or if * was provided, then no content
- will be returned.
-
- Default value is None.'
- isRequired: true
+ will be returned.'
+ defaultValue: None
types:
- <xref:str>
- name: cls
@@ -198,7 +110,7 @@ methods:
types:
- <xref:callable>
return:
- description: SqlScriptResource or None or the result of cls(response)
+ description: SqlScriptResource, or the result of cls(response)
types:
- <xref:azure.synapse.artifacts.models.SqlScriptResource>
- <xref:None>
@@ -207,17 +119,17 @@ methods:
- 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[SqlScriptResource]'
+ signature: 'get_sql_scripts_by_workspace(**kwargs: Any) -> Iterable[''models.SqlScriptsListResponse'']'
parameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
- description: An iterator like instance of either SqlScriptResource or the result
- of cls(response)
+ description: An iterator like instance of either SqlScriptsListResponse or the
+ result of cls(response)
types:
- - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.SqlScriptResource>]
+ - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.SqlScriptsListResponse>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.TriggerOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.TriggerOperations.yml
index 4dd031ff7257..145b298376fa 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.TriggerOperations.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.TriggerOperations.yml
@@ -5,34 +5,39 @@ fullName: azure.synapse.artifacts.operations.TriggerOperations
module: azure.synapse.artifacts.operations
inheritances:
- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:trigger> attribute.\n>"
+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(*args, **kwargs)
-methods:
-- uid: azure.synapse.artifacts.operations.TriggerOperations.begin_create_or_update_trigger
- name: begin_create_or_update_trigger
- summary: Creates or updates a trigger.
- signature: 'begin_create_or_update_trigger(trigger_name: str, properties: Trigger,
- if_match: str | None = None, **kwargs: Any) -> LROPoller[TriggerResource]'
+ syntax: TriggerOperations(client, config, serializer, deserializer)
parameters:
- - name: trigger_name
- description: The trigger name. Required.
+ - name: client
+ description: Client for service requests.
isRequired: true
- types:
- - <xref:str>
- - name: properties
- description: Properties of the trigger. Required.
+ - name: config
+ description: Configuration of service client.
isRequired: true
- types:
- - <xref:azure.synapse.artifacts.models.Trigger>
- - 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. Default value
- is None.'
+ - 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:
- <xref:str>
@@ -45,38 +50,31 @@ methods:
types:
- <xref:str>
- 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
+ description: 'True for ARMPolling, False for no polling, or a
- polling strategy.'
+ polling object for personal polling strategy'
types:
- <xref:bool>
- <xref:azure.core.polling.PollingMethod>
- name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
+ description: Default waiting time between two polls for LRO operations if no Retry-After
+ header is present.
types:
- <xref:int>
return:
- description: 'An instance of LROPoller that returns either TriggerResource or
- the result of
-
- cls(response)'
+ description: An instance of LROPoller that returns either None or the result of
+ cls(response)
types:
- - <xref:azure.core.polling.LROPoller>[<xref:azure.synapse.artifacts.models.TriggerResource>]
+ - <xref:azure.core.polling.LROPoller>[<xref:None>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
-- uid: azure.synapse.artifacts.operations.TriggerOperations.begin_delete_trigger
- name: begin_delete_trigger
- summary: Deletes a trigger.
- signature: 'begin_delete_trigger(trigger_name: str, **kwargs: Any) -> LROPoller[None]'
+- 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. Required.
+ description: The trigger name.
isRequired: true
types:
- <xref:str>
@@ -89,20 +87,15 @@ methods:
types:
- <xref:str>
- 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
+ description: 'True for ARMPolling, False for no polling, or a
- polling strategy.'
+ polling object for personal polling strategy'
types:
- <xref:bool>
- <xref:azure.core.polling.PollingMethod>
- name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
+ description: Default waiting time between two polls for LRO operations if no Retry-After
+ header is present.
types:
- <xref:int>
return:
@@ -112,13 +105,14 @@ methods:
- <xref:azure.core.polling.LROPoller>[<xref:None>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
-- 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]'
+- 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. Required.
+ description: The trigger name.
isRequired: true
types:
- <xref:str>
@@ -131,36 +125,32 @@ methods:
types:
- <xref:str>
- name: polling
- description: 'By default, your polling method will be LROBasePolling. Pass in
- False for
+ description: 'True for ARMPolling, False for no polling, or a
- this operation to not poll, or pass in your own initialized polling object for
- a personal
-
- polling strategy.'
+ polling object for personal polling strategy'
types:
- <xref:bool>
- <xref:azure.core.polling.PollingMethod>
- name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
+ description: Default waiting time between two polls for LRO operations if no Retry-After
+ header is present.
types:
- <xref:int>
return:
- description: An instance of LROPoller that returns either None or the result of
- cls(response)
+ description: An instance of LROPoller that returns either TriggerSubscriptionOperationStatus
+ or the result of cls(response)
types:
- - <xref:azure.core.polling.LROPoller>[<xref:None>]
+ - <xref:azure.core.polling.LROPoller>[<xref:azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus>]
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]'
+- 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. Required.
+ description: The trigger name.
isRequired: true
types:
- <xref:str>
@@ -173,82 +163,65 @@ methods:
types:
- <xref:str>
- 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
+ description: 'True for ARMPolling, False for no polling, or a
- polling strategy.'
+ polling object for personal polling strategy'
types:
- <xref:bool>
- <xref:azure.core.polling.PollingMethod>
- name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
+ description: Default waiting time between two polls for LRO operations if no Retry-After
+ header is present.
types:
- <xref:int>
return:
- description: An instance of LROPoller that returns either None or the result of
- cls(response)
+ description: An instance of LROPoller that returns either TriggerSubscriptionOperationStatus
+ or the result of cls(response)
types:
- - <xref:azure.core.polling.LROPoller>[<xref:None>]
+ - <xref:azure.core.polling.LROPoller>[<xref:azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus>]
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[TriggerSubscriptionOperationStatus]'
+- 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. Required.
+ description: The trigger name.
isRequired: true
types:
- <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
+ - name: properties
+ description: Properties of the trigger.
+ isRequired: true
types:
- - <xref:str>
- - 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
+ - <xref:azure.synapse.artifacts.models.Trigger>
+ - name: if_match
+ description: 'ETag of the trigger entity. Should only be specified for update,
+ for which it
- polling strategy.'
+ should match existing entity or can be * for unconditional update.'
+ defaultValue: None
types:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
+ - <xref:str>
+ - name: cls
+ description: A custom type or function that will be passed the direct response
types:
- - <xref:int>
+ - <xref:callable>
return:
- description: 'An instance of LROPoller that returns either TriggerSubscriptionOperationStatus
- or the
-
- result of cls(response)'
+ description: TriggerResource, or the result of cls(response)
types:
- - <xref:azure.core.polling.LROPoller>[<xref:azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus>]
+ - <xref:azure.synapse.artifacts.models.TriggerResource>
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[TriggerSubscriptionOperationStatus]'
+- 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. Required.
+ description: The trigger name.
isRequired: true
types:
- <xref:str>
@@ -256,43 +229,19 @@ methods:
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
- - name: continuation_token
- description: A continuation token to restart a poller from a saved state.
- types:
- - <xref:str>
- - 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:
- - <xref:bool>
- - <xref:azure.core.polling.PollingMethod>
- - name: polling_interval
- description: 'Default waiting time between two polls for LRO operations if no
-
- Retry-After header is present.'
- types:
- - <xref:int>
return:
- description: 'An instance of LROPoller that returns either TriggerSubscriptionOperationStatus
- or the
-
- result of cls(response)'
+ description: None, or the result of cls(response)
types:
- - <xref:azure.core.polling.LROPoller>[<xref:azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus>]
+ - <xref:None>
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) -> TriggerSubscriptionOperationStatus'
+ signature: 'get_event_subscription_status(trigger_name: str, **kwargs: Any) -> models.TriggerSubscriptionOperationStatus'
parameters:
- name: trigger_name
- description: The trigger name. Required.
+ description: The trigger name.
isRequired: true
types:
- <xref:str>
@@ -301,7 +250,7 @@ methods:
types:
- <xref:callable>
return:
- description: TriggerSubscriptionOperationStatus or the result of cls(response)
+ description: TriggerSubscriptionOperationStatus, or the result of cls(response)
types:
- <xref:azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus>
exceptions:
@@ -310,10 +259,10 @@ methods:
name: get_trigger
summary: Gets a trigger.
signature: 'get_trigger(trigger_name: str, if_none_match: str | None = None, **kwargs:
- Any) -> TriggerResource | None'
+ Any) -> ''models.TriggerResource'' | None'
parameters:
- name: trigger_name
- description: The trigger name. Required.
+ description: The trigger name.
isRequired: true
types:
- <xref:str>
@@ -322,10 +271,8 @@ methods:
the ETag
matches the existing entity tag, or if * was provided, then no content will
- be returned.
-
- Default value is None.'
- isRequired: true
+ be returned.'
+ defaultValue: None
types:
- <xref:str>
- name: cls
@@ -333,7 +280,7 @@ methods:
types:
- <xref:callable>
return:
- description: TriggerResource or None or the result of cls(response)
+ description: TriggerResource, or the result of cls(response)
types:
- <xref:azure.synapse.artifacts.models.TriggerResource>
- <xref:None>
@@ -342,17 +289,17 @@ methods:
- 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[TriggerResource]'
+ signature: 'get_triggers_by_workspace(**kwargs: Any) -> Iterable[''models.TriggerListResponse'']'
parameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
- description: An iterator like instance of either TriggerResource or the result
+ description: An iterator like instance of either TriggerListResponse or the result
of cls(response)
types:
- - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.TriggerResource>]
+ - <xref:azure.core.paging.ItemPaged>[<xref:azure.synapse.artifacts.models.TriggerListResponse>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.TriggerRunOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.TriggerRunOperations.yml
index fd442927faec..c152988890cd 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.TriggerRunOperations.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.TriggerRunOperations.yml
@@ -5,64 +5,49 @@ fullName: azure.synapse.artifacts.operations.TriggerRunOperations
module: azure.synapse.artifacts.operations
inheritances:
- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:trigger_run> attribute.\n>"
+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(*args, **kwargs)
-methods:
-- uid: azure.synapse.artifacts.operations.TriggerRunOperations.cancel_trigger_instance
- name: cancel_trigger_instance
- summary: Cancel single trigger instance by runId.
- signature: 'cancel_trigger_instance(trigger_name: str, run_id: str, **kwargs: Any)
- -> None'
+ syntax: TriggerRunOperations(client, config, serializer, deserializer)
parameters:
- - name: trigger_name
- description: The trigger name. Required.
+ - name: client
+ description: Client for service requests.
isRequired: true
- types:
- - <xref:str>
- - name: run_id
- description: The pipeline run identifier. Required.
+ - name: config
+ description: Configuration of service client.
isRequired: true
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: None or the result of cls(response)
- types:
- - <xref:None>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
+ - 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,
- *, content_type: str = ''application/json'', **kwargs: Any) -> _models.TriggerRunsQueryResponse'
+ 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. Is either a
-
- RunFilterParameters type or a IO type. Required.'
+ description: Parameters to filter the pipeline run.
isRequired: true
types:
- <xref:azure.synapse.artifacts.models.RunFilterParameters>
- - <xref:typing.IO>
- - name: content_type
- description: 'Body Parameter content-type. Known values are: ''application/json''.
-
- Default value is None.'
- types:
- - <xref:str>
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
- description: TriggerRunsQueryResponse or the result of cls(response)
+ description: TriggerRunsQueryResponse, or the result of cls(response)
types:
- <xref:azure.synapse.artifacts.models.TriggerRunsQueryResponse>
exceptions:
@@ -74,12 +59,12 @@ methods:
-> None'
parameters:
- name: trigger_name
- description: The trigger name. Required.
+ description: The trigger name.
isRequired: true
types:
- <xref:str>
- name: run_id
- description: The pipeline run identifier. Required.
+ description: The pipeline run identifier.
isRequired: true
types:
- <xref:str>
@@ -88,7 +73,7 @@ methods:
types:
- <xref:callable>
return:
- description: None or the result of cls(response)
+ description: None, or the result of cls(response)
types:
- <xref:None>
exceptions:
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.WorkspaceGitRepoManagementOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.WorkspaceGitRepoManagementOperations.yml
deleted file mode 100644
index c864ac2b97d2..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.WorkspaceGitRepoManagementOperations.yml
+++ /dev/null
@@ -1,55 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.operations.WorkspaceGitRepoManagementOperations
-name: WorkspaceGitRepoManagementOperations
-fullName: azure.synapse.artifacts.operations.WorkspaceGitRepoManagementOperations
-module: azure.synapse.artifacts.operations
-inheritances:
-- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:workspace_git_repo_management> attribute.\n>"
-constructor:
- syntax: WorkspaceGitRepoManagementOperations(*args, **kwargs)
-methods:
-- uid: azure.synapse.artifacts.operations.WorkspaceGitRepoManagementOperations.get_git_hub_access_token
- name: get_git_hub_access_token
- summary: Get the GitHub access token.
- signature: 'get_git_hub_access_token(git_hub_access_token_request: _models.GitHubAccessTokenRequest,
- client_request_id: str | None = None, *, content_type: str = ''application/json'',
- **kwargs: Any) -> _models.GitHubAccessTokenResponse'
- parameters:
- - name: git_hub_access_token_request
- description: 'Is either a GitHubAccessTokenRequest type or a IO type.
-
- Required.'
- isRequired: true
- types:
- - <xref:azure.synapse.artifacts.models.GitHubAccessTokenRequest>
- - <xref:typing.IO>
- - name: client_request_id
- description: 'Can provide a guid, which is helpful for debugging and to provide
-
- better customer support. Default value is None.'
- isRequired: true
- types:
- - <xref:str>
- - name: content_type
- description: 'Body Parameter content-type. Known values are: ''application/json''.
-
- Default value is None.'
- types:
- - <xref:str>
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: GitHubAccessTokenResponse or the result of cls(response)
- types:
- - <xref:azure.synapse.artifacts.models.GitHubAccessTokenResponse>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-attributes:
-- uid: azure.synapse.artifacts.operations.WorkspaceGitRepoManagementOperations.models
- name: models
- signature: models = <module 'azure.synapse.artifacts.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.5\\x64\\Lib\\site-packages\\azure\\synapse\\artifacts\\models\\__init__.py'>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.WorkspaceOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.WorkspaceOperations.yml
deleted file mode 100644
index 8a479efe9814..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.WorkspaceOperations.yml
+++ /dev/null
@@ -1,32 +0,0 @@
-### YamlMime:PythonClass
-uid: azure.synapse.artifacts.operations.WorkspaceOperations
-name: WorkspaceOperations
-fullName: azure.synapse.artifacts.operations.WorkspaceOperations
-module: azure.synapse.artifacts.operations
-inheritances:
-- builtins.object
-summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
- \ you should access the following operations through\n>\n> <xref:azure.synapse.artifacts.ArtifactsClient>'s\n\
- >\n> <xref:workspace> attribute.\n>"
-constructor:
- syntax: WorkspaceOperations(*args, **kwargs)
-methods:
-- uid: azure.synapse.artifacts.operations.WorkspaceOperations.get
- name: get
- summary: Get Workspace.
- signature: 'get(**kwargs: Any) -> Workspace'
- parameters:
- - name: cls
- description: A custom type or function that will be passed the direct response
- types:
- - <xref:callable>
- return:
- description: Workspace or the result of cls(response)
- types:
- - <xref:azure.synapse.artifacts.models.Workspace>
- exceptions:
- - type: azure.core.exceptions.HttpResponseError
-attributes:
-- uid: azure.synapse.artifacts.operations.WorkspaceOperations.models
- name: models
- signature: models = <module 'azure.synapse.artifacts.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.5\\x64\\Lib\\site-packages\\azure\\synapse\\artifacts\\models\\__init__.py'>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.yml
index 81d9bf71c82c..5d99c46ca44d 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.yml
@@ -4,27 +4,14 @@ name: operations
fullName: azure.synapse.artifacts.operations
type: import
classes:
-- azure.synapse.artifacts.operations.BigDataPoolsOperations
- azure.synapse.artifacts.operations.DataFlowDebugSessionOperations
- azure.synapse.artifacts.operations.DataFlowOperations
- azure.synapse.artifacts.operations.DatasetOperations
-- azure.synapse.artifacts.operations.IntegrationRuntimesOperations
-- azure.synapse.artifacts.operations.KqlScriptOperations
-- azure.synapse.artifacts.operations.KqlScriptsOperations
-- azure.synapse.artifacts.operations.LibraryOperations
-- azure.synapse.artifacts.operations.LinkConnectionOperations
- azure.synapse.artifacts.operations.LinkedServiceOperations
-- azure.synapse.artifacts.operations.MetastoreOperations
-- azure.synapse.artifacts.operations.NotebookOperationResultOperations
- azure.synapse.artifacts.operations.NotebookOperations
- azure.synapse.artifacts.operations.PipelineOperations
- azure.synapse.artifacts.operations.PipelineRunOperations
-- azure.synapse.artifacts.operations.RunNotebookOperations
-- azure.synapse.artifacts.operations.SparkConfigurationOperations
- azure.synapse.artifacts.operations.SparkJobDefinitionOperations
-- azure.synapse.artifacts.operations.SqlPoolsOperations
- azure.synapse.artifacts.operations.SqlScriptOperations
- azure.synapse.artifacts.operations.TriggerOperations
- azure.synapse.artifacts.operations.TriggerRunOperations
-- azure.synapse.artifacts.operations.WorkspaceGitRepoManagementOperations
-- azure.synapse.artifacts.operations.WorkspaceOperations
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.SparkClient.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.SparkClient.yml
index a5adbcd1bb3a..c3a50a5c0946 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.SparkClient.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.SparkClient.yml
@@ -30,6 +30,11 @@ constructor:
defaultValue: 2019-11-01-preview
types:
- <xref:str>
+ - name: polling_interval
+ description: Default waiting time between two polls for LRO operations if no Retry-After
+ header is present.
+ types:
+ - <xref:int>
variables:
- description: SparkBatchOperations operations
name: spark_batch
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.SparkClient.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.SparkClient.yml
index 7c8d0526bef8..5461b5cd1a7e 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.SparkClient.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.SparkClient.yml
@@ -30,15 +30,20 @@ constructor:
defaultValue: 2019-11-01-preview
types:
- <xref:str>
+ - name: polling_interval
+ description: Default waiting time between two polls for LRO operations if no Retry-After
+ header is present.
+ types:
+ - <xref:int>
variables:
- description: SparkBatchOperations operations
name: spark_batch
types:
- - <xref:azure.synapse.spark.aio.operations.SparkBatchOperations>
+ - <xref:azure.synapse.spark.aio.operations_async.SparkBatchOperations>
- description: SparkSessionOperations operations
name: spark_session
types:
- - <xref:azure.synapse.spark.aio.operations.SparkSessionOperations>
+ - <xref:azure.synapse.spark.aio.operations_async.SparkSessionOperations>
methods:
- uid: azure.synapse.spark.aio.SparkClient.close
name: close
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.LivyStatementStates.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.LivyStatementStates.yml
deleted file mode 100644
index 60bd6f824199..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.LivyStatementStates.yml
+++ /dev/null
@@ -1,24 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.spark.models.LivyStatementStates
-name: LivyStatementStates
-fullName: azure.synapse.spark.models.LivyStatementStates
-module: azure.synapse.spark.models
-constructor:
- syntax: LivyStatementStates(value, names=None, *, module=None, qualname=None, type=None,
- start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: AVAILABLE
- uid: azure.synapse.spark.models.LivyStatementStates.AVAILABLE
-- name: CANCELLED
- uid: azure.synapse.spark.models.LivyStatementStates.CANCELLED
-- name: CANCELLING
- uid: azure.synapse.spark.models.LivyStatementStates.CANCELLING
-- name: ERROR
- uid: azure.synapse.spark.models.LivyStatementStates.ERROR
-- name: RUNNING
- uid: azure.synapse.spark.models.LivyStatementStates.RUNNING
-- name: WAITING
- uid: azure.synapse.spark.models.LivyStatementStates.WAITING
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.LivyStates.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.LivyStates.yml
deleted file mode 100644
index 408e148b89d2..000000000000
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.LivyStates.yml
+++ /dev/null
@@ -1,35 +0,0 @@
-### YamlMime:PythonEnum
-uid: azure.synapse.spark.models.LivyStates
-name: LivyStates
-fullName: azure.synapse.spark.models.LivyStates
-summary: The batch state
-module: azure.synapse.spark.models
-constructor:
- syntax: LivyStates(value, names=None, *, module=None, qualname=None, type=None,
- start=1, boundary=None)
-inheritances:
-- builtins.str
-- enum.Enum
-fields:
-- name: BUSY
- uid: azure.synapse.spark.models.LivyStates.BUSY
-- name: DEAD
- uid: azure.synapse.spark.models.LivyStates.DEAD
-- name: ERROR
- uid: azure.synapse.spark.models.LivyStates.ERROR
-- name: IDLE
- uid: azure.synapse.spark.models.LivyStates.IDLE
-- name: KILLED
- uid: azure.synapse.spark.models.LivyStates.KILLED
-- name: NOT_STARTED
- uid: azure.synapse.spark.models.LivyStates.NOT_STARTED
-- name: RECOVERING
- uid: azure.synapse.spark.models.LivyStates.RECOVERING
-- name: RUNNING
- uid: azure.synapse.spark.models.LivyStates.RUNNING
-- name: SHUTTING_DOWN
- uid: azure.synapse.spark.models.LivyStates.SHUTTING_DOWN
-- name: STARTING
- uid: azure.synapse.spark.models.LivyStates.STARTING
-- name: SUCCESS
- uid: azure.synapse.spark.models.LivyStates.SUCCESS
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.PluginCurrentState.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.PluginCurrentState.yml
index 9a634ffc4bd3..f0c5ed411684 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.PluginCurrentState.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.PluginCurrentState.yml
@@ -10,17 +10,17 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SchedulerCurrentState.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SchedulerCurrentState.yml
index 64a7830ad05f..256d85fef2ed 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SchedulerCurrentState.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SchedulerCurrentState.yml
@@ -10,9 +10,9 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJob.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJob.yml
index 46f7e885bd2f..5c63b0ab2b09 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJob.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJob.yml
@@ -17,8 +17,8 @@ constructor:
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 | LivyStates | None = None,
- log_lines: List[str] | None = None, **kwargs)'
+ app_info: Dict[str, str] | None = None, state: str | None = None, log_lines: List[str]
+ | None = None, **kwargs)'
parameters:
- name: livy_info
isRequired: true
@@ -105,14 +105,10 @@ constructor:
types:
- <xref:dict>[<xref:str>, <xref:str>]
- name: state
- description: 'The batch state. Possible values include: "not_started", "starting",
- "idle",
-
- "busy", "shutting_down", "error", "dead", "killed", "success", "running", "recovering".'
+ description: The batch state.
isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.spark.models.LivyStates>
- name: log_lines
description: The log lines.
isRequired: true
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobResultType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobResultType.yml
index 2d612c2bc899..c8abe46e4da6 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobResultType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobResultType.yml
@@ -11,11 +11,11 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkErrorSource.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkErrorSource.yml
index 1ccce8e0a286..a856491951bc 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkErrorSource.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkErrorSource.yml
@@ -10,11 +10,11 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkJobType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkJobType.yml
index e4a33877e3b4..e9feaac82ecb 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkJobType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkJobType.yml
@@ -11,7 +11,7 @@ inheritances:
- builtins.str
- enum.Enum
fields:
-- name: SPARK_BATCH
- uid: azure.synapse.spark.models.SparkJobType.SPARK_BATCH
-- name: SPARK_SESSION
- uid: azure.synapse.spark.models.SparkJobType.SPARK_SESSION
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSession.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSession.yml
index 79101441470c..c8a67599bd43 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSession.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSession.yml
@@ -17,8 +17,7 @@ constructor:
| 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 | LivyStates | None = None, log_lines: List[str] | None = None,
- **kwargs)'
+ = None, state: str | None = None, log_lines: List[str] | None = None, **kwargs)'
parameters:
- name: livy_info
isRequired: true
@@ -92,14 +91,9 @@ constructor:
types:
- <xref:dict>[<xref:str>, <xref:str>]
- name: state
- description: 'The session state. Possible values include: "not_started", "starting",
- "idle",
-
- "busy", "shutting_down", "error", "dead", "killed", "success", "running", "recovering".'
isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.spark.models.LivyStates>
- name: log_lines
isRequired: true
types:
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionResultType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionResultType.yml
index bb6c5ae87239..e9c8320abeea 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionResultType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionResultType.yml
@@ -10,11 +10,11 @@ inheritances:
- builtins.str
- enum.Enum
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
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatement.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatement.yml
index 2d53944c7f4a..49f0ea33e1fd 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatement.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatement.yml
@@ -10,8 +10,8 @@ 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 | LivyStatementStates
- | None = None, output: SparkStatementOutput | None = None, **kwargs)'
+ syntax: 'SparkStatement(*, id: int, code: str | None = None, state: str | None =
+ None, output: SparkStatementOutput | None = None, **kwargs)'
parameters:
- name: id
description: Required.
@@ -23,13 +23,9 @@ constructor:
types:
- <xref:str>
- name: state
- description: 'Possible values include: "waiting", "running", "available", "error",
-
- "cancelling", "cancelled".'
isRequired: true
types:
- <xref:str>
- - <xref:azure.synapse.spark.models.LivyStatementStates>
- name: output
isRequired: true
types:
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementCancellationResult.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementCancellationResult.yml
index f68e07773123..faa865b6b419 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementCancellationResult.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementCancellationResult.yml
@@ -7,10 +7,9 @@ inheritances:
- msrest.serialization.Model
summary: SparkStatementCancellationResult.
constructor:
- syntax: 'SparkStatementCancellationResult(*, message: str | None = None, **kwargs)'
+ syntax: 'SparkStatementCancellationResult(*, msg: str | None = None, **kwargs)'
parameters:
- - name: message
- description: The msg property from the Livy API. The value is always "canceled".
+ - name: msg
isRequired: true
types:
- <xref:str>
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementLanguageType.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementLanguageType.yml
index 2ba4086a99a3..bcc034e7947c 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementLanguageType.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementLanguageType.yml
@@ -10,11 +10,11 @@ inheritances:
- builtins.str
- enum.Enum
fields:
-- name: DOT_NET_SPARK
- uid: azure.synapse.spark.models.SparkStatementLanguageType.DOT_NET_SPARK
-- name: PY_SPARK
- uid: azure.synapse.spark.models.SparkStatementLanguageType.PY_SPARK
-- name: SPARK
- uid: azure.synapse.spark.models.SparkStatementLanguageType.SPARK
-- name: SQL
- uid: azure.synapse.spark.models.SparkStatementLanguageType.SQL
+- 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/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementOutput.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementOutput.yml
index 63f37a67371b..a68953b2c997 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementOutput.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementOutput.yml
@@ -11,8 +11,8 @@ 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: Any | None = None, error_name: str | None = None, error_value: str | None
- = None, traceback: List[str] | None = None, **kwargs)'
+ 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
@@ -27,7 +27,7 @@ constructor:
description: Any object.
isRequired: true
types:
- - <xref:any>
+ - <xref:object>
- name: error_name
isRequired: true
types:
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.yml
index 73841fd98039..309fa81a51ab 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.yml
@@ -22,8 +22,6 @@ classes:
- azure.synapse.spark.models.SparkStatementOptions
- azure.synapse.spark.models.SparkStatementOutput
enums:
-- azure.synapse.spark.models.LivyStatementStates
-- azure.synapse.spark.models.LivyStates
- azure.synapse.spark.models.PluginCurrentState
- azure.synapse.spark.models.SchedulerCurrentState
- azure.synapse.spark.models.SparkBatchJobResultType
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.operations.SparkBatchOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.operations.SparkBatchOperations.yml
index 463617ac8a4a..2cfaa15f3936 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.operations.SparkBatchOperations.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.operations.SparkBatchOperations.yml
@@ -54,8 +54,8 @@ methods:
- 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'
+ 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.
@@ -84,7 +84,7 @@ methods:
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'
+ Any) -> models.SparkBatchJob'
parameters:
- name: batch_id
description: Identifier for the batch job.
@@ -113,7 +113,7 @@ methods:
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'
+ 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.
diff --git a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.operations.SparkSessionOperations.yml b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.operations.SparkSessionOperations.yml
index 6c783381cc4d..d2f9566a01c5 100644
--- a/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.operations.SparkSessionOperations.yml
+++ b/preview/docs-ref-autogen/azure-synapse/azure.synapse.spark.operations.SparkSessionOperations.yml
@@ -55,7 +55,7 @@ methods:
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'
+ Any) -> models.SparkStatementCancellationResult'
parameters:
- name: session_id
description: Identifier for the session.
@@ -80,8 +80,8 @@ methods:
- 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'
+ 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.
@@ -109,8 +109,8 @@ methods:
- 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'
+ 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.
@@ -136,7 +136,7 @@ methods:
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'
+ Any) -> models.SparkSession'
parameters:
- name: session_id
description: Identifier for the session.
@@ -165,7 +165,7 @@ methods:
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'
+ = None, detailed: bool | None = None, **kwargs: Any) -> models.SparkSessionCollection'
parameters:
- name: from_parameter
description: Optional param specifying which index the list should begin from.
@@ -201,7 +201,7 @@ methods:
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'
+ -> models.SparkStatement'
parameters:
- name: session_id
description: Identifier for the session.
@@ -226,7 +226,7 @@ methods:
- 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'
+ signature: 'get_spark_statements(session_id: int, **kwargs: Any) -> models.SparkStatementCollection'
parameters:
- name: session_id
description: Identifier for the session.
diff --git a/preview/docs-ref-autogen/toc.yml b/preview/docs-ref-autogen/toc.yml
index 5ca26b8242a7..42fea43b4b64 100644
--- a/preview/docs-ref-autogen/toc.yml
+++ b/preview/docs-ref-autogen/toc.yml
@@ -160,7 +160,6 @@
uid: azure.cognitiveservices.personalizer.PersonalizerClient
name: azure.cognitiveservices.personalizer
name: azure-cognitiveservices-personalizer
-
- items:
- name: Overview
uid: project-azure-schemaregistry-avroserializer
@@ -176,18 +175,21 @@
name: azure.schemaregistry.serializer.avroserializer.exceptions
- items:
- name: Overview
- uid: azure.schemaregistry.serializer.avroserializer
+ uid: azure.schemaregistry.serializer
- items:
- name: Overview
- uid: azure.schemaregistry.serializer.avroserializer.aio
- - name: azure.schemaregistry.serializer.avroserializer.aio.AvroSerializer
- uid: azure.schemaregistry.serializer.avroserializer.aio.AvroSerializer
- name: azure.schemaregistry.serializer.avroserializer.aio
- - name: azure.schemaregistry.serializer.avroserializer.AvroSerializer
- uid: azure.schemaregistry.serializer.avroserializer.AvroSerializer
- name: azure.schemaregistry.serializer.avroserializer
+ uid: azure.schemaregistry.serializer.avroserializer
+ - items:
+ - name: Overview
+ uid: azure.schemaregistry.serializer.avroserializer.aio
+ - name: azure.schemaregistry.serializer.avroserializer.aio.AvroSerializer
+ uid: azure.schemaregistry.serializer.avroserializer.aio.AvroSerializer
+ name: azure.schemaregistry.serializer.avroserializer.aio
+ - name: azure.schemaregistry.serializer.avroserializer.AvroSerializer
+ uid: azure.schemaregistry.serializer.avroserializer.AvroSerializer
+ name: azure.schemaregistry.serializer.avroserializer
+ name: azure.schemaregistry.serializer
name: azure-schemaregistry-avroserializer
-
- items:
- name: Overview
uid: project-azure-agrifood-farming
@@ -360,7 +362,6 @@
uid: azure.agrifood.farming.FarmBeatsClient
name: azure.agrifood.farming
name: azure-agrifood-farming
-
- items:
- name: Overview
uid: project-azure-ai-anomalydetector
@@ -449,7 +450,6 @@
uid: azure.ai.anomalydetector.AnomalyDetectorClient
name: azure.ai.anomalydetector
name: azure-ai-anomalydetector
-
- items:
- name: Overview
uid: project-azure-ai-contentsafety
@@ -502,7 +502,6 @@
uid: azure.ai.contentsafety.ContentSafetyClient
name: azure.ai.contentsafety
name: azure-ai-contentsafety
-
- items:
- name: Overview
uid: project-azure-ai-formrecognizer
@@ -667,7 +666,6 @@
uid: azure.ai.formrecognizer.TrainingStatus
name: azure.ai.formrecognizer
name: azure-ai-formrecognizer
-
- items:
- name: Overview
uid: project-azure-ai-language-conversations
@@ -696,7 +694,6 @@
uid: azure.ai.language.conversations.ConversationAnalysisClient
name: azure.ai.language.conversations
name: azure-ai-language-conversations
-
- items:
- name: Overview
uid: project-azure-ai-language-questionanswering
@@ -767,7 +764,6 @@
uid: azure.ai.language.questionanswering.QuestionAnsweringClient
name: azure.ai.language.questionanswering
name: azure-ai-language-questionanswering
-
- items:
- name: Overview
uid: project-azure-ai-ml
@@ -1296,7 +1292,6 @@
uid: azure.ai.ml.UserIdentity
name: azure.ai.ml
name: azure-ai-ml
-
- items:
- name: Overview
uid: project-azure-ai-personalizer
@@ -1317,7 +1312,6 @@
uid: azure.ai.personalizer.PersonalizerClient
name: azure.ai.personalizer
name: azure-ai-personalizer
-
- items:
- name: Overview
uid: project-azure-ai-textanalytics
@@ -1522,7 +1516,6 @@
uid: azure.ai.textanalytics.WeightUnit
name: azure.ai.textanalytics
name: azure-ai-textanalytics
-
- items:
- name: Overview
uid: project-azure-ai-translation-document
@@ -1561,7 +1554,6 @@
uid: azure.ai.translation.document.TranslationTarget
name: azure.ai.translation.document
name: azure-ai-translation-document
-
- items:
- name: Overview
uid: project-azure-ai-translation-text
@@ -1640,7 +1632,6 @@
uid: azure.ai.translation.text.TranslatorCredential
name: azure.ai.translation.text
name: azure-ai-translation-text
-
- items:
- name: Overview
uid: project-azure-ai-vision
@@ -1771,7 +1762,6 @@
uid: azure.ai.vision.VisionSource
name: azure.ai.vision
name: azure-ai-vision
-
- items:
- name: Overview
uid: project-azure-appconfiguration
@@ -1800,7 +1790,6 @@
uid: azure.appconfiguration.Snapshot
name: azure.appconfiguration
name: azure-appconfiguration
-
- items:
- name: Overview
uid: project-azure-appconfiguration-provider
@@ -1823,7 +1812,6 @@
uid: azure.appconfiguration.provider.SettingSelector
name: azure.appconfiguration.provider
name: azure-appconfiguration-provider
-
- items:
- name: Overview
uid: project-azure-cognitiveservices-knowledge-qnamaker
@@ -2604,7 +2592,6 @@
uid: azure.cognitiveservices.knowledge.qnamaker.QnAMakerClient
name: azure.cognitiveservices.knowledge.qnamaker
name: azure-cognitiveservices-knowledge-qnamaker
-
- items:
- name: Overview
uid: project-azure-cognitiveservices-language-luis
@@ -2616,304 +2603,307 @@
uid: azure.cognitiveservices.language.luis.version
- items:
- name: Overview
- uid: azure.cognitiveservices.language.luis.authoring
- - items:
- - name: Overview
- uid: azure.cognitiveservices.language.luis.authoring.models
- - name: azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject
- uid: azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject
- - name: azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse
- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse
- - name: azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject
- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject
- - name: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettings
- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettings
- - name: azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.AvailableCulture
- uid: azure.cognitiveservices.language.luis.authoring.models.AvailableCulture
- - name: azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel
- uid: azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel
- - name: azure.cognitiveservices.language.luis.authoring.models.AzureAccountInfoObject
- uid: azure.cognitiveservices.language.luis.authoring.models.AzureAccountInfoObject
- - name: azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample
- uid: azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample
- - name: azure.cognitiveservices.language.luis.authoring.models.ChildEntity
- uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntity
- - name: azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.ClosedList
- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedList
- - name: azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor
- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor
- - name: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject
- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject
- - name: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray
- uid: azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray
- - name: azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor
- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor
- - name: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel
- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel
- - name: azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel
- uid: azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel
- - name: azure.cognitiveservices.language.luis.authoring.models.EndpointInfo
- uid: azure.cognitiveservices.language.luis.authoring.models.EndpointInfo
- - name: azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse
- uid: azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse
- - name: azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample
- uid: azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample
- - name: azure.cognitiveservices.language.luis.authoring.models.EntityExtractor
- uid: azure.cognitiveservices.language.luis.authoring.models.EntityExtractor
- - name: azure.cognitiveservices.language.luis.authoring.models.EntityLabel
- uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabel
- - name: azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject
- uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject
- - name: azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo
- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo
- - name: azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.EntityPrediction
- uid: azure.cognitiveservices.language.luis.authoring.models.EntityPrediction
- - name: azure.cognitiveservices.language.luis.authoring.models.EntityRole
- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRole
- - name: azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.ErrorResponse
- uid: azure.cognitiveservices.language.luis.authoring.models.ErrorResponse
- - name: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException
- uid: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException
- - name: azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject
- uid: azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject
- - name: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem
- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem
- - name: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject
- uid: azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject
- - name: azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject
- uid: azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject
- - name: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity
- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity
- - name: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor
- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor
- - name: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel
- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel
- - name: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2
- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2
- - name: azure.cognitiveservices.language.luis.authoring.models.IntentClassifier
- uid: azure.cognitiveservices.language.luis.authoring.models.IntentClassifier
- - name: azure.cognitiveservices.language.luis.authoring.models.IntentPrediction
- uid: azure.cognitiveservices.language.luis.authoring.models.IntentPrediction
- - name: azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample
- uid: azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample
- - name: azure.cognitiveservices.language.luis.authoring.models.JSONEntity
- uid: azure.cognitiveservices.language.luis.authoring.models.JSONEntity
- - name: azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature
- uid: azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature
- - name: azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature
- uid: azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature
- - name: azure.cognitiveservices.language.luis.authoring.models.JSONUtterance
- uid: azure.cognitiveservices.language.luis.authoring.models.JSONUtterance
- - name: azure.cognitiveservices.language.luis.authoring.models.JsonChild
- uid: azure.cognitiveservices.language.luis.authoring.models.JsonChild
- - name: azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation
- uid: azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation
- - name: azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse
- uid: azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse
- - name: azure.cognitiveservices.language.luis.authoring.models.LabelTextObject
- uid: azure.cognitiveservices.language.luis.authoring.models.LabelTextObject
- - name: azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance
- uid: azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance
- - name: azure.cognitiveservices.language.luis.authoring.models.LuisApp
- uid: azure.cognitiveservices.language.luis.authoring.models.LuisApp
- - name: azure.cognitiveservices.language.luis.authoring.models.LuisAppV2
- uid: azure.cognitiveservices.language.luis.authoring.models.LuisAppV2
- - name: azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation
- uid: azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation
- - name: azure.cognitiveservices.language.luis.authoring.models.ModelInfo
- uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfo
- - name: azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse
- uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse
- - name: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails
- uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails
- - name: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo
- uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo
- - name: azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor
- uid: azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor
- - name: azure.cognitiveservices.language.luis.authoring.models.OperationError
- uid: azure.cognitiveservices.language.luis.authoring.models.OperationError
- - name: azure.cognitiveservices.language.luis.authoring.models.OperationStatus
- uid: azure.cognitiveservices.language.luis.authoring.models.OperationStatus
- - name: azure.cognitiveservices.language.luis.authoring.models.OperationStatusType
- uid: azure.cognitiveservices.language.luis.authoring.models.OperationStatusType
- - name: azure.cognitiveservices.language.luis.authoring.models.PatternAny
- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAny
- - name: azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor
- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor
- - name: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo
- uid: azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo
- - name: azure.cognitiveservices.language.luis.authoring.models.PatternRule
- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRule
- - name: azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo
- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo
- - name: azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse
- uid: azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse
- - name: azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo
- uid: azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo
- - name: azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain
- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain
- - name: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject
- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject
- - name: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem
- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem
- - name: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject
- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject
- - name: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity
- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity
- - name: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor
- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor
- - name: azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo
- uid: azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo
- - name: azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.PublishSettings
- uid: azure.cognitiveservices.language.luis.authoring.models.PublishSettings
- - name: azure.cognitiveservices.language.luis.authoring.models.RegexEntity
- uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntity
- - name: azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor
- uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor
- - name: azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.SubClosedList
- uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedList
- - name: azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse
- uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse
- - name: azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.TrainingStatus
- uid: azure.cognitiveservices.language.luis.authoring.models.TrainingStatus
- - name: azure.cognitiveservices.language.luis.authoring.models.UserAccessList
- uid: azure.cognitiveservices.language.luis.authoring.models.UserAccessList
- - name: azure.cognitiveservices.language.luis.authoring.models.UserCollaborator
- uid: azure.cognitiveservices.language.luis.authoring.models.UserCollaborator
- - name: azure.cognitiveservices.language.luis.authoring.models.VersionInfo
- uid: azure.cognitiveservices.language.luis.authoring.models.VersionInfo
- - name: azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject
- uid: azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject
- - name: azure.cognitiveservices.language.luis.authoring.models.WordListObject
- uid: azure.cognitiveservices.language.luis.authoring.models.WordListObject
- name: azure.cognitiveservices.language.luis.authoring.models
- - items:
- - name: Overview
- uid: azure.cognitiveservices.language.luis.authoring.operations
- - name: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations
- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations
- - name: azure.cognitiveservices.language.luis.authoring.operations.AzureAccountsOperations
- uid: azure.cognitiveservices.language.luis.authoring.operations.AzureAccountsOperations
- - name: azure.cognitiveservices.language.luis.authoring.operations.ExamplesOperations
- uid: azure.cognitiveservices.language.luis.authoring.operations.ExamplesOperations
- - name: azure.cognitiveservices.language.luis.authoring.operations.FeaturesOperations
- uid: azure.cognitiveservices.language.luis.authoring.operations.FeaturesOperations
- - name: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations
- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations
- - name: azure.cognitiveservices.language.luis.authoring.operations.PatternOperations
- uid: azure.cognitiveservices.language.luis.authoring.operations.PatternOperations
- - name: azure.cognitiveservices.language.luis.authoring.operations.SettingsOperations
- uid: azure.cognitiveservices.language.luis.authoring.operations.SettingsOperations
- - name: azure.cognitiveservices.language.luis.authoring.operations.TrainOperations
- uid: azure.cognitiveservices.language.luis.authoring.operations.TrainOperations
- - name: azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations
- uid: azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations
- name: azure.cognitiveservices.language.luis.authoring.operations
- - name: azure.cognitiveservices.language.luis.authoring.LUISAuthoringClient
- uid: azure.cognitiveservices.language.luis.authoring.LUISAuthoringClient
- - name: azure.cognitiveservices.language.luis.authoring.LUISAuthoringClientConfiguration
- uid: azure.cognitiveservices.language.luis.authoring.LUISAuthoringClientConfiguration
- name: azure.cognitiveservices.language.luis.authoring
- - items:
- - name: Overview
- uid: azure.cognitiveservices.language.luis.runtime
- - items:
- - name: Overview
- uid: azure.cognitiveservices.language.luis.runtime.models
- - name: azure.cognitiveservices.language.luis.runtime.models.DynamicList
- uid: azure.cognitiveservices.language.luis.runtime.models.DynamicList
- - name: azure.cognitiveservices.language.luis.runtime.models.Error
- uid: azure.cognitiveservices.language.luis.runtime.models.Error
- - name: azure.cognitiveservices.language.luis.runtime.models.ErrorBody
- uid: azure.cognitiveservices.language.luis.runtime.models.ErrorBody
- - name: azure.cognitiveservices.language.luis.runtime.models.ErrorException
- uid: azure.cognitiveservices.language.luis.runtime.models.ErrorException
- - name: azure.cognitiveservices.language.luis.runtime.models.ExternalEntity
- uid: azure.cognitiveservices.language.luis.runtime.models.ExternalEntity
- - name: azure.cognitiveservices.language.luis.runtime.models.Intent
- uid: azure.cognitiveservices.language.luis.runtime.models.Intent
- - name: azure.cognitiveservices.language.luis.runtime.models.Prediction
- uid: azure.cognitiveservices.language.luis.runtime.models.Prediction
- - name: azure.cognitiveservices.language.luis.runtime.models.PredictionRequest
- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequest
- - name: azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions
- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions
- - name: azure.cognitiveservices.language.luis.runtime.models.PredictionResponse
- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionResponse
- - name: azure.cognitiveservices.language.luis.runtime.models.RequestList
- uid: azure.cognitiveservices.language.luis.runtime.models.RequestList
- - name: azure.cognitiveservices.language.luis.runtime.models.Sentiment
- uid: azure.cognitiveservices.language.luis.runtime.models.Sentiment
- name: azure.cognitiveservices.language.luis.runtime.models
- - items:
- - name: Overview
- uid: azure.cognitiveservices.language.luis.runtime.operations
- - name: azure.cognitiveservices.language.luis.runtime.operations.PredictionOperations
- uid: azure.cognitiveservices.language.luis.runtime.operations.PredictionOperations
- name: azure.cognitiveservices.language.luis.runtime.operations
- - name: azure.cognitiveservices.language.luis.runtime.LUISRuntimeClient
- uid: azure.cognitiveservices.language.luis.runtime.LUISRuntimeClient
- - name: azure.cognitiveservices.language.luis.runtime.LUISRuntimeClientConfiguration
- uid: azure.cognitiveservices.language.luis.runtime.LUISRuntimeClientConfiguration
- name: azure.cognitiveservices.language.luis.runtime
+ 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: azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse
+ uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse
+ - name: azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettings
+ uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettings
+ - name: azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.AvailableCulture
+ uid: azure.cognitiveservices.language.luis.authoring.models.AvailableCulture
+ - name: azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel
+ uid: azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel
+ - name: azure.cognitiveservices.language.luis.authoring.models.AzureAccountInfoObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.AzureAccountInfoObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample
+ uid: azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample
+ - name: azure.cognitiveservices.language.luis.authoring.models.ChildEntity
+ uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntity
+ - name: azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.ClosedList
+ uid: azure.cognitiveservices.language.luis.authoring.models.ClosedList
+ - name: azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor
+ uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor
+ - name: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray
+ uid: azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray
+ - name: azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor
+ uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor
+ - name: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel
+ uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel
+ - name: azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel
+ uid: azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel
+ - name: azure.cognitiveservices.language.luis.authoring.models.EndpointInfo
+ uid: azure.cognitiveservices.language.luis.authoring.models.EndpointInfo
+ - name: azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse
+ uid: azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse
+ - name: azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample
+ uid: azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample
+ - name: azure.cognitiveservices.language.luis.authoring.models.EntityExtractor
+ uid: azure.cognitiveservices.language.luis.authoring.models.EntityExtractor
+ - name: azure.cognitiveservices.language.luis.authoring.models.EntityLabel
+ uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabel
+ - name: azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo
+ uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo
+ - name: azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.EntityPrediction
+ uid: azure.cognitiveservices.language.luis.authoring.models.EntityPrediction
+ - name: azure.cognitiveservices.language.luis.authoring.models.EntityRole
+ uid: azure.cognitiveservices.language.luis.authoring.models.EntityRole
+ - name: azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.ErrorResponse
+ uid: azure.cognitiveservices.language.luis.authoring.models.ErrorResponse
+ - name: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException
+ uid: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException
+ - name: azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem
+ uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem
+ - name: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity
+ uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity
+ - name: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor
+ uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor
+ - name: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel
+ uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel
+ - name: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2
+ uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2
+ - name: azure.cognitiveservices.language.luis.authoring.models.IntentClassifier
+ uid: azure.cognitiveservices.language.luis.authoring.models.IntentClassifier
+ - name: azure.cognitiveservices.language.luis.authoring.models.IntentPrediction
+ uid: azure.cognitiveservices.language.luis.authoring.models.IntentPrediction
+ - name: azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample
+ uid: azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample
+ - name: azure.cognitiveservices.language.luis.authoring.models.JSONEntity
+ uid: azure.cognitiveservices.language.luis.authoring.models.JSONEntity
+ - name: azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature
+ uid: azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature
+ - name: azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature
+ uid: azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature
+ - name: azure.cognitiveservices.language.luis.authoring.models.JSONUtterance
+ uid: azure.cognitiveservices.language.luis.authoring.models.JSONUtterance
+ - name: azure.cognitiveservices.language.luis.authoring.models.JsonChild
+ uid: azure.cognitiveservices.language.luis.authoring.models.JsonChild
+ - name: azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation
+ uid: azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation
+ - name: azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse
+ uid: azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse
+ - name: azure.cognitiveservices.language.luis.authoring.models.LabelTextObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.LabelTextObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance
+ uid: azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance
+ - name: azure.cognitiveservices.language.luis.authoring.models.LuisApp
+ uid: azure.cognitiveservices.language.luis.authoring.models.LuisApp
+ - name: azure.cognitiveservices.language.luis.authoring.models.LuisAppV2
+ uid: azure.cognitiveservices.language.luis.authoring.models.LuisAppV2
+ - name: azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation
+ uid: azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation
+ - name: azure.cognitiveservices.language.luis.authoring.models.ModelInfo
+ uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfo
+ - name: azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse
+ uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse
+ - name: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails
+ uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails
+ - name: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo
+ uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo
+ - name: azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor
+ uid: azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor
+ - name: azure.cognitiveservices.language.luis.authoring.models.OperationError
+ uid: azure.cognitiveservices.language.luis.authoring.models.OperationError
+ - name: azure.cognitiveservices.language.luis.authoring.models.OperationStatus
+ uid: azure.cognitiveservices.language.luis.authoring.models.OperationStatus
+ - name: azure.cognitiveservices.language.luis.authoring.models.OperationStatusType
+ uid: azure.cognitiveservices.language.luis.authoring.models.OperationStatusType
+ - name: azure.cognitiveservices.language.luis.authoring.models.PatternAny
+ uid: azure.cognitiveservices.language.luis.authoring.models.PatternAny
+ - name: azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor
+ uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor
+ - name: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo
+ uid: azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo
+ - name: azure.cognitiveservices.language.luis.authoring.models.PatternRule
+ uid: azure.cognitiveservices.language.luis.authoring.models.PatternRule
+ - name: azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo
+ uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo
+ - name: azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse
+ uid: azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse
+ - name: azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo
+ uid: azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo
+ - name: azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain
+ uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain
+ - name: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem
+ uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem
+ - name: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity
+ uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity
+ - name: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor
+ uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor
+ - name: azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo
+ uid: azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo
+ - name: azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.PublishSettings
+ uid: azure.cognitiveservices.language.luis.authoring.models.PublishSettings
+ - name: azure.cognitiveservices.language.luis.authoring.models.RegexEntity
+ uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntity
+ - name: azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor
+ uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor
+ - name: azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.SubClosedList
+ uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedList
+ - name: azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse
+ uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse
+ - name: azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.TrainingStatus
+ uid: azure.cognitiveservices.language.luis.authoring.models.TrainingStatus
+ - name: azure.cognitiveservices.language.luis.authoring.models.UserAccessList
+ uid: azure.cognitiveservices.language.luis.authoring.models.UserAccessList
+ - name: azure.cognitiveservices.language.luis.authoring.models.UserCollaborator
+ uid: azure.cognitiveservices.language.luis.authoring.models.UserCollaborator
+ - name: azure.cognitiveservices.language.luis.authoring.models.VersionInfo
+ uid: azure.cognitiveservices.language.luis.authoring.models.VersionInfo
+ - name: azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject
+ - name: azure.cognitiveservices.language.luis.authoring.models.WordListObject
+ uid: azure.cognitiveservices.language.luis.authoring.models.WordListObject
+ name: azure.cognitiveservices.language.luis.authoring.models
+ - items:
+ - name: Overview
+ uid: azure.cognitiveservices.language.luis.authoring.operations
+ - name: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations
+ uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations
+ - name: azure.cognitiveservices.language.luis.authoring.operations.AzureAccountsOperations
+ uid: azure.cognitiveservices.language.luis.authoring.operations.AzureAccountsOperations
+ - name: azure.cognitiveservices.language.luis.authoring.operations.ExamplesOperations
+ uid: azure.cognitiveservices.language.luis.authoring.operations.ExamplesOperations
+ - name: azure.cognitiveservices.language.luis.authoring.operations.FeaturesOperations
+ uid: azure.cognitiveservices.language.luis.authoring.operations.FeaturesOperations
+ - name: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations
+ uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations
+ - name: azure.cognitiveservices.language.luis.authoring.operations.PatternOperations
+ uid: azure.cognitiveservices.language.luis.authoring.operations.PatternOperations
+ - name: azure.cognitiveservices.language.luis.authoring.operations.SettingsOperations
+ uid: azure.cognitiveservices.language.luis.authoring.operations.SettingsOperations
+ - name: azure.cognitiveservices.language.luis.authoring.operations.TrainOperations
+ uid: azure.cognitiveservices.language.luis.authoring.operations.TrainOperations
+ - name: azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations
+ uid: azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations
+ name: azure.cognitiveservices.language.luis.authoring.operations
+ - name: azure.cognitiveservices.language.luis.authoring.LUISAuthoringClient
+ uid: azure.cognitiveservices.language.luis.authoring.LUISAuthoringClient
+ - name: azure.cognitiveservices.language.luis.authoring.LUISAuthoringClientConfiguration
+ uid: azure.cognitiveservices.language.luis.authoring.LUISAuthoringClientConfiguration
+ name: azure.cognitiveservices.language.luis.authoring
+ - items:
+ - name: Overview
+ uid: azure.cognitiveservices.language.luis.runtime
+ - items:
+ - name: Overview
+ uid: azure.cognitiveservices.language.luis.runtime.models
+ - name: azure.cognitiveservices.language.luis.runtime.models.DynamicList
+ uid: azure.cognitiveservices.language.luis.runtime.models.DynamicList
+ - name: azure.cognitiveservices.language.luis.runtime.models.Error
+ uid: azure.cognitiveservices.language.luis.runtime.models.Error
+ - name: azure.cognitiveservices.language.luis.runtime.models.ErrorBody
+ uid: azure.cognitiveservices.language.luis.runtime.models.ErrorBody
+ - name: azure.cognitiveservices.language.luis.runtime.models.ErrorException
+ uid: azure.cognitiveservices.language.luis.runtime.models.ErrorException
+ - name: azure.cognitiveservices.language.luis.runtime.models.ExternalEntity
+ uid: azure.cognitiveservices.language.luis.runtime.models.ExternalEntity
+ - name: azure.cognitiveservices.language.luis.runtime.models.Intent
+ uid: azure.cognitiveservices.language.luis.runtime.models.Intent
+ - name: azure.cognitiveservices.language.luis.runtime.models.Prediction
+ uid: azure.cognitiveservices.language.luis.runtime.models.Prediction
+ - name: azure.cognitiveservices.language.luis.runtime.models.PredictionRequest
+ uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequest
+ - name: azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions
+ uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions
+ - name: azure.cognitiveservices.language.luis.runtime.models.PredictionResponse
+ uid: azure.cognitiveservices.language.luis.runtime.models.PredictionResponse
+ - name: azure.cognitiveservices.language.luis.runtime.models.RequestList
+ uid: azure.cognitiveservices.language.luis.runtime.models.RequestList
+ - name: azure.cognitiveservices.language.luis.runtime.models.Sentiment
+ uid: azure.cognitiveservices.language.luis.runtime.models.Sentiment
+ name: azure.cognitiveservices.language.luis.runtime.models
+ - items:
+ - name: Overview
+ uid: azure.cognitiveservices.language.luis.runtime.operations
+ - name: azure.cognitiveservices.language.luis.runtime.operations.PredictionOperations
+ uid: azure.cognitiveservices.language.luis.runtime.operations.PredictionOperations
+ name: azure.cognitiveservices.language.luis.runtime.operations
+ - name: azure.cognitiveservices.language.luis.runtime.LUISRuntimeClient
+ uid: azure.cognitiveservices.language.luis.runtime.LUISRuntimeClient
+ - name: azure.cognitiveservices.language.luis.runtime.LUISRuntimeClientConfiguration
+ uid: azure.cognitiveservices.language.luis.runtime.LUISRuntimeClientConfiguration
+ name: azure.cognitiveservices.language.luis.runtime
+ name: azure.cognitiveservices.language.luis
name: azure-cognitiveservices-language-luis
-
- items:
- name: Overview
uid: project-azure-cognitiveservices-search-autosuggest
@@ -2978,7 +2968,6 @@
uid: azure.cognitiveservices.search.autosuggest.AutoSuggestClientConfiguration
name: azure.cognitiveservices.search.autosuggest
name: azure-cognitiveservices-search-autosuggest
-
- items:
- name: Overview
uid: project-azure-cognitiveservices-search-customimagesearch
@@ -3053,7 +3042,6 @@
uid: azure.cognitiveservices.search.customimagesearch.CustomImageSearchClientConfiguration
name: azure.cognitiveservices.search.customimagesearch
name: azure-cognitiveservices-search-customimagesearch
-
- items:
- name: Overview
uid: project-azure-cognitiveservices-search-customsearch
@@ -3118,7 +3106,6 @@
uid: azure.cognitiveservices.search.customsearch.CustomSearchClientConfiguration
name: azure.cognitiveservices.search.customsearch
name: azure-cognitiveservices-search-customsearch
-
- items:
- name: Overview
uid: project-azure-cognitiveservices-search-visualsearch
@@ -3759,7 +3746,6 @@
uid: azure.cognitiveservices.search.visualsearch.VisualSearchClient
name: azure.cognitiveservices.search.visualsearch
name: azure-cognitiveservices-search-visualsearch
-
- items:
- name: Overview
uid: project-azure-cognitiveservices-vision-computervision
@@ -3892,7 +3878,6 @@
uid: azure.cognitiveservices.vision.computervision.ComputerVisionClientConfiguration
name: azure.cognitiveservices.vision.computervision
name: azure-cognitiveservices-vision-computervision
-
- items:
- name: Overview
uid: project-azure-cognitiveservices-vision-face
@@ -4057,7 +4042,6 @@
uid: azure.cognitiveservices.vision.face.FaceClientConfiguration
name: azure.cognitiveservices.vision.face
name: azure-cognitiveservices-vision-face
-
- items:
- name: Overview
uid: project-azure-communication-administration
@@ -4138,7 +4122,6 @@
uid: azure.communication.administration.UpdatePhoneNumberCapabilitiesResponse
name: azure.communication.administration
name: azure-communication-administration
-
- items:
- name: Overview
uid: project-azure-communication-callautomation
@@ -4219,7 +4202,6 @@
uid: azure.communication.callautomation.VoiceKind
name: azure.communication.callautomation
name: azure-communication-callautomation
-
- items:
- name: Overview
uid: project-azure-communication-email
@@ -4236,7 +4218,6 @@
uid: azure.communication.email.EmailClient
name: azure.communication.email
name: azure-communication-email
-
- items:
- name: Overview
uid: project-azure-communication-identity
@@ -4279,7 +4260,6 @@
uid: azure.communication.identity.UnknownIdentifier
name: azure.communication.identity
name: azure-communication-identity
-
- items:
- name: Overview
uid: project-azure-communication-jobrouter
@@ -4428,7 +4408,6 @@
uid: azure.communication.jobrouter.WorkerWeightedAllocation
name: azure.communication.jobrouter
name: azure-communication-jobrouter
-
- items:
- name: Overview
uid: project-azure-communication-networktraversal
@@ -4443,7 +4422,6 @@
name: azure.communication.networktraversal.aio
name: azure.communication.networktraversal
name: azure-communication-networktraversal
-
- items:
- name: Overview
uid: project-azure-communication-phonenumbers
@@ -4504,7 +4482,6 @@
uid: azure.communication.phonenumbers.PurchasedPhoneNumber
name: azure.communication.phonenumbers
name: azure-communication-phonenumbers
-
- items:
- name: Overview
uid: project-azure-communication-rooms
@@ -4551,7 +4528,6 @@
uid: azure.communication.rooms.UnknownIdentifier
name: azure.communication.rooms
name: azure-communication-rooms
-
- items:
- name: Overview
uid: project-azure-containerregistry
@@ -4588,7 +4564,6 @@
uid: azure.containerregistry.RepositoryProperties
name: azure.containerregistry
name: azure-containerregistry
-
- items:
- name: Overview
uid: project-azure-core-experimental
@@ -4599,29 +4574,34 @@
uid: azure.core.experimental.transport
name: azure.core.experimental
name: azure-core-experimental
-
- items:
- name: Overview
uid: project-azure-core-tracing-opencensus
- items:
- name: Overview
- uid: azure.core.tracing.ext.opencensus_span
- - name: azure.core.tracing.ext.opencensus_span.OpenCensusSpan
- uid: azure.core.tracing.ext.opencensus_span.OpenCensusSpan
- name: azure.core.tracing.ext.opencensus_span
+ uid: azure.core.tracing.ext
+ - items:
+ - name: Overview
+ uid: azure.core.tracing.ext.opencensus_span
+ - name: azure.core.tracing.ext.opencensus_span.OpenCensusSpan
+ uid: azure.core.tracing.ext.opencensus_span.OpenCensusSpan
+ name: azure.core.tracing.ext.opencensus_span
+ name: azure.core.tracing.ext
name: azure-core-tracing-opencensus
-
- items:
- name: Overview
uid: project-azure-core-tracing-opentelemetry
- items:
- name: Overview
- uid: azure.core.tracing.ext.opentelemetry_span
- - name: azure.core.tracing.ext.opentelemetry_span.OpenTelemetrySpan
- uid: azure.core.tracing.ext.opentelemetry_span.OpenTelemetrySpan
- name: azure.core.tracing.ext.opentelemetry_span
+ uid: azure.core.tracing.ext
+ - items:
+ - name: Overview
+ uid: azure.core.tracing.ext.opentelemetry_span
+ - name: azure.core.tracing.ext.opentelemetry_span.OpenTelemetrySpan
+ uid: azure.core.tracing.ext.opentelemetry_span.OpenTelemetrySpan
+ name: azure.core.tracing.ext.opentelemetry_span
+ name: azure.core.tracing.ext
name: azure-core-tracing-opentelemetry
-
- items:
- name: Overview
uid: project-azure-cosmos
@@ -4820,7 +4800,6 @@
uid: azure.cosmos.UserProxy
name: azure.cosmos
name: azure-cosmos
-
- items:
- name: Overview
uid: project-azure-defender-easm
@@ -4869,7 +4848,6 @@
uid: azure.defender.easm.EasmClient
name: azure.defender.easm
name: azure-defender-easm
-
- items:
- name: Overview
uid: project-azure-developer-devcenter
@@ -4906,7 +4884,6 @@
uid: azure.developer.devcenter.DevCenterClient
name: azure.developer.devcenter
name: azure-developer-devcenter
-
- items:
- name: Overview
uid: project-azure-developer-loadtesting
@@ -4947,7 +4924,6 @@
uid: azure.developer.loadtesting.LoadTestingClient
name: azure.developer.loadtesting
name: azure-developer-loadtesting
-
- items:
- name: Overview
uid: project-azure-digitaltwins-core
@@ -4970,7 +4946,6 @@
uid: azure.digitaltwins.core.IncomingRelationship
name: azure.digitaltwins.core
name: azure-digitaltwins-core
-
- items:
- name: Overview
uid: project-azure-eventgrid
@@ -5019,7 +4994,6 @@
uid: azure.eventgrid.SystemEventNames
name: azure.eventgrid
name: azure-eventgrid
-
- items:
- name: Overview
uid: project-azure-eventhub
@@ -5074,6 +5048,8 @@
- name: azure.eventhub.amqp.AmqpMessageProperties
uid: azure.eventhub.amqp.AmqpMessageProperties
name: azure.eventhub.amqp
+ - name: azure.eventhub.extensions
+ uid: azure.eventhub.extensions
- name: azure.eventhub.CheckpointStore
uid: azure.eventhub.CheckpointStore
- name: azure.eventhub.CloseReason
@@ -5098,7 +5074,6 @@
uid: azure.eventhub.TransportType
name: azure.eventhub
name: azure-eventhub
-
- items:
- name: Overview
uid: project-azure-healthinsights-cancerprofiling
@@ -5163,7 +5138,6 @@
uid: azure.healthinsights.cancerprofiling.CancerProfilingClient
name: azure.healthinsights.cancerprofiling
name: azure-healthinsights-cancerprofiling
-
- items:
- name: Overview
uid: project-azure-healthinsights-clinicalmatching
@@ -5276,7 +5250,6 @@
uid: azure.healthinsights.clinicalmatching.ClinicalMatchingClient
name: azure.healthinsights.clinicalmatching
name: azure-healthinsights-clinicalmatching
-
- items:
- name: Overview
uid: project-azure-identity
@@ -5367,7 +5340,6 @@
uid: azure.identity.WorkloadIdentityCredential
name: azure.identity
name: azure-identity
-
- items:
- name: Overview
uid: project-azure-iot-device
@@ -5502,7 +5474,6 @@
- name: azure.iot.device
uid: azure.iot.device
name: azure-iot-device
-
- items:
- name: Overview
uid: project-azure-iot-deviceprovisioning
@@ -5541,7 +5512,6 @@
uid: azure.iot.deviceprovisioning.DeviceProvisioningClient
name: azure.iot.deviceprovisioning
name: azure-iot-deviceprovisioning
-
- items:
- name: Overview
uid: project-azure-iot-deviceupdate
@@ -5574,7 +5544,6 @@
uid: azure.iot.deviceupdate.DeviceUpdateClient
name: azure.iot.deviceupdate
name: azure-iot-deviceupdate
-
- items:
- name: Overview
uid: project-azure-iot-hub
@@ -6179,7 +6148,6 @@
uid: azure.iot.hub.IoTHubRegistryManager
name: azure.iot.hub
name: azure-iot-hub
-
- items:
- name: Overview
uid: project-azure-iot-modelsrepository
@@ -6200,7 +6168,6 @@
uid: azure.iot.modelsrepository.ModelsRepositoryClient
name: azure.iot.modelsrepository
name: azure-iot-modelsrepository
-
- items:
- name: Overview
uid: project-azure-keyvault-administration
@@ -6245,7 +6212,6 @@
uid: azure.keyvault.administration.KeyVaultSettingsClient
name: azure.keyvault.administration
name: azure-keyvault-administration
-
- items:
- name: Overview
uid: project-azure-keyvault-certificates
@@ -6300,7 +6266,6 @@
uid: azure.keyvault.certificates.WellKnownIssuerNames
name: azure.keyvault.certificates
name: azure-keyvault-certificates
-
- items:
- name: Overview
uid: project-azure-keyvault-keys
@@ -6389,7 +6354,6 @@
uid: azure.keyvault.keys.ReleaseKeyResult
name: azure.keyvault.keys
name: azure-keyvault-keys
-
- items:
- name: Overview
uid: project-azure-keyvault-secrets
@@ -6416,7 +6380,6 @@
uid: azure.keyvault.secrets.SecretProperties
name: azure.keyvault.secrets
name: azure-keyvault-secrets
-
- items:
- name: Overview
uid: project-azure-maps-geolocation
@@ -6439,7 +6402,6 @@
uid: azure.maps.geolocation.MapsGeolocationClient
name: azure.maps.geolocation
name: azure-maps-geolocation
-
- items:
- name: Overview
uid: project-azure-maps-render
@@ -6490,7 +6452,6 @@
uid: azure.maps.render.MapsRenderClient
name: azure.maps.render
name: azure-maps-render
-
- items:
- name: Overview
uid: project-azure-maps-route
@@ -6609,7 +6570,6 @@
uid: azure.maps.route.MapsRouteClient
name: azure.maps.route
name: azure-maps-route
-
- items:
- name: Overview
uid: project-azure-maps-search
@@ -6686,7 +6646,6 @@
uid: azure.maps.search.MapsSearchClient
name: azure.maps.search
name: azure-maps-search
-
- items:
- name: Overview
uid: project-azure-media-analytics-edge
@@ -6827,7 +6786,6 @@
uid: azure.media.analyticsedge.MethodRequest
name: azure.media.analyticsedge
name: azure-media-analytics-edge
-
- items:
- name: Overview
uid: project-azure-media-videoanalyzer-edge
@@ -7086,7 +7044,6 @@
uid: azure.media.videoanalyzeredge.VideoSink
name: azure.media.videoanalyzeredge
name: azure-media-videoanalyzer-edge
-
- items:
- name: Overview
uid: project-azure-messaging-webpubsubclient
@@ -7131,7 +7088,6 @@
uid: azure.messaging.webpubsubclient.WebPubSubClientCredential
name: azure.messaging.webpubsubclient
name: azure-messaging-webpubsubclient
-
- items:
- name: Overview
uid: project-azure-messaging-webpubsubservice
@@ -7148,7 +7104,6 @@
uid: azure.messaging.webpubsubservice.WebPubSubServiceClient
name: azure.messaging.webpubsubservice
name: azure-messaging-webpubsubservice
-
- items:
- name: Overview
uid: project-azure-mgmt-advisor
@@ -7245,7 +7200,6 @@
uid: azure.mgmt.advisor.AdvisorManagementClient
name: azure.mgmt.advisor
name: azure-mgmt-advisor
-
- items:
- name: Overview
uid: project-azure-mgmt-agrifood
@@ -7418,7 +7372,6 @@
uid: azure.mgmt.agrifood.AgriFoodMgmtClient
name: azure.mgmt.agrifood
name: azure-mgmt-agrifood
-
- items:
- name: Overview
uid: project-azure-mgmt-alertsmanagement
@@ -7627,7 +7580,6 @@
uid: azure.mgmt.alertsmanagement.AlertsManagementClient
name: azure.mgmt.alertsmanagement
name: azure-mgmt-alertsmanagement
-
- items:
- name: Overview
uid: project-azure-mgmt-apicenter
@@ -7702,7 +7654,6 @@
uid: azure.mgmt.apicenter.ApiCenterMgmtClient
name: azure.mgmt.apicenter
name: azure-mgmt-apicenter
-
- items:
- name: Overview
uid: project-azure-mgmt-appcomplianceautomation
@@ -7845,7 +7796,6 @@
uid: azure.mgmt.appcomplianceautomation.AppComplianceAutomationToolForMicrosoft365
name: azure.mgmt.appcomplianceautomation
name: azure-mgmt-appcomplianceautomation
-
- items:
- name: Overview
uid: project-azure-mgmt-appconfiguration
@@ -8146,7 +8096,6 @@
uid: azure.mgmt.appconfiguration.AppConfigurationManagementClient
name: azure.mgmt.appconfiguration
name: azure-mgmt-appconfiguration
-
- items:
- name: Overview
uid: project-azure-mgmt-appcontainers
@@ -8673,7 +8622,6 @@
uid: azure.mgmt.appcontainers.ContainerAppsAPIClient
name: azure.mgmt.appcontainers
name: azure-mgmt-appcontainers
-
- items:
- name: Overview
uid: project-azure-mgmt-applicationinsights
@@ -9652,7 +9600,6 @@
uid: azure.mgmt.applicationinsights.ApplicationInsightsManagementClient
name: azure.mgmt.applicationinsights
name: azure-mgmt-applicationinsights
-
- items:
- name: Overview
uid: project-azure-mgmt-appplatform
@@ -14423,7 +14370,6 @@
uid: azure.mgmt.appplatform.AppPlatformManagementClient
name: azure.mgmt.appplatform
name: azure-mgmt-appplatform
-
- items:
- name: Overview
uid: project-azure-mgmt-attestation
@@ -14508,7 +14454,6 @@
uid: azure.mgmt.attestation.AttestationManagementClient
name: azure.mgmt.attestation
name: azure-mgmt-attestation
-
- items:
- name: Overview
uid: project-azure-mgmt-authorization
@@ -16195,7 +16140,6 @@
uid: azure.mgmt.authorization.AuthorizationManagementClient
name: azure.mgmt.authorization
name: azure-mgmt-authorization
-
- items:
- name: Overview
uid: project-azure-mgmt-automanage
@@ -16332,7 +16276,6 @@
uid: azure.mgmt.automanage.AutomanageClient
name: azure.mgmt.automanage
name: azure-mgmt-automanage
-
- items:
- name: Overview
uid: project-azure-mgmt-automation
@@ -16981,7 +16924,6 @@
uid: azure.mgmt.automation.AutomationClient
name: azure.mgmt.automation
name: azure-mgmt-automation
-
- items:
- name: Overview
uid: project-azure-mgmt-avs
@@ -17378,7 +17320,6 @@
uid: azure.mgmt.avs.AVSClient
name: azure.mgmt.avs
name: azure-mgmt-avs
-
- items:
- name: Overview
uid: project-azure-mgmt-azurearcdata
@@ -17557,7 +17498,6 @@
uid: azure.mgmt.azurearcdata.AzureArcDataManagementClient
name: azure.mgmt.azurearcdata
name: azure-mgmt-azurearcdata
-
- items:
- name: Overview
uid: project-azure-mgmt-azurestack
@@ -17688,7 +17628,6 @@
uid: azure.mgmt.azurestack.AzureStackManagementClient
name: azure.mgmt.azurestack
name: azure-mgmt-azurestack
-
- items:
- name: Overview
uid: project-azure-mgmt-azurestackhci
@@ -18063,7 +18002,6 @@
uid: azure.mgmt.azurestackhci.AzureStackHCIClient
name: azure.mgmt.azurestackhci
name: azure-mgmt-azurestackhci
-
- items:
- name: Overview
uid: project-azure-mgmt-baremetalinfrastructure
@@ -18146,7 +18084,6 @@
uid: azure.mgmt.baremetalinfrastructure.BareMetalInfrastructureClient
name: azure.mgmt.baremetalinfrastructure
name: azure-mgmt-baremetalinfrastructure
-
- items:
- name: Overview
uid: project-azure-mgmt-billing
@@ -18485,7 +18422,6 @@
uid: azure.mgmt.billing.BillingManagementClient
name: azure.mgmt.billing
name: azure-mgmt-billing
-
- items:
- name: Overview
uid: project-azure-mgmt-billingbenefits
@@ -18644,7 +18580,6 @@
uid: azure.mgmt.billingbenefits.BillingBenefitsRP
name: azure.mgmt.billingbenefits
name: azure-mgmt-billingbenefits
-
- items:
- name: Overview
uid: project-azure-mgmt-botservice
@@ -18889,7 +18824,6 @@
uid: azure.mgmt.botservice.AzureBotService
name: azure.mgmt.botservice
name: azure-mgmt-botservice
-
- items:
- name: Overview
uid: project-azure-mgmt-cdn
@@ -19772,7 +19706,6 @@
uid: azure.mgmt.cdn.CdnManagementClient
name: azure.mgmt.cdn
name: azure-mgmt-cdn
-
- items:
- name: Overview
uid: project-azure-mgmt-chaos
@@ -19937,7 +19870,6 @@
uid: azure.mgmt.chaos.ChaosManagementClient
name: azure.mgmt.chaos
name: azure-mgmt-chaos
-
- items:
- name: Overview
uid: project-azure-mgmt-cognitiveservices
@@ -20202,7 +20134,6 @@
uid: azure.mgmt.cognitiveservices.CognitiveServicesManagementClient
name: azure.mgmt.cognitiveservices
name: azure-mgmt-cognitiveservices
-
- items:
- name: Overview
uid: project-azure-mgmt-commerce
@@ -20265,7 +20196,6 @@
uid: azure.mgmt.commerce.UsageManagementClient
name: azure.mgmt.commerce
name: azure-mgmt-commerce
-
- items:
- name: Overview
uid: project-azure-mgmt-communication
@@ -20408,7 +20338,6 @@
uid: azure.mgmt.communication.CommunicationServiceManagementClient
name: azure.mgmt.communication
name: azure-mgmt-communication
-
- items:
- name: Overview
uid: project-azure-mgmt-compute
@@ -21757,7 +21686,6 @@
uid: azure.mgmt.compute.ComputeManagementClient
name: azure.mgmt.compute
name: azure-mgmt-compute
-
- items:
- name: Overview
uid: project-azure-mgmt-confidentialledger
@@ -21860,7 +21788,6 @@
uid: azure.mgmt.confidentialledger.ConfidentialLedger
name: azure.mgmt.confidentialledger
name: azure-mgmt-confidentialledger
-
- items:
- name: Overview
uid: project-azure-mgmt-confluent
@@ -21937,7 +21864,6 @@
uid: azure.mgmt.confluent.ConfluentManagementClient
name: azure.mgmt.confluent
name: azure-mgmt-confluent
-
- items:
- name: Overview
uid: project-azure-mgmt-connectedvmware
@@ -22244,7 +22170,6 @@
uid: azure.mgmt.connectedvmware.AzureArcVMwareManagementServiceAPI
name: azure.mgmt.connectedvmware
name: azure-mgmt-connectedvmware
-
- items:
- name: Overview
uid: project-azure-mgmt-consumption
@@ -22529,7 +22454,6 @@
uid: azure.mgmt.consumption.ConsumptionManagementClient
name: azure.mgmt.consumption
name: azure-mgmt-consumption
-
- items:
- name: Overview
uid: project-azure-mgmt-containerinstance
@@ -22710,7 +22634,6 @@
uid: azure.mgmt.containerinstance.ContainerInstanceManagementClient
name: azure.mgmt.containerinstance
name: azure-mgmt-containerinstance
-
- items:
- name: Overview
uid: project-azure-mgmt-containerservicefleet
@@ -23205,7 +23128,6 @@
uid: azure.mgmt.containerservicefleet.ContainerServiceFleetMgmtClient
name: azure.mgmt.containerservicefleet
name: azure-mgmt-containerservicefleet
-
- items:
- name: Overview
uid: project-azure-mgmt-cosmosdb
@@ -24146,7 +24068,6 @@
uid: azure.mgmt.cosmosdb.CosmosDBManagementClient
name: azure.mgmt.cosmosdb
name: azure-mgmt-cosmosdb
-
- items:
- name: Overview
uid: project-azure-mgmt-cosmosdbforpostgresql
@@ -24297,7 +24218,6 @@
uid: azure.mgmt.cosmosdbforpostgresql.CosmosdbForPostgresqlMgmtClient
name: azure.mgmt.cosmosdbforpostgresql
name: azure-mgmt-cosmosdbforpostgresql
-
- items:
- name: Overview
uid: project-azure-mgmt-customproviders
@@ -24376,7 +24296,6 @@
uid: azure.mgmt.customproviders.Customproviders
name: azure.mgmt.customproviders
name: azure-mgmt-customproviders
-
- items:
- name: Overview
uid: project-azure-mgmt-dashboard
@@ -24493,7 +24412,6 @@
uid: azure.mgmt.dashboard.DashboardManagementClient
name: azure.mgmt.dashboard
name: azure-mgmt-dashboard
-
- items:
- name: Overview
uid: project-azure-mgmt-databox
@@ -28118,7 +28036,6 @@
uid: azure.mgmt.databox.DataBoxManagementClient
name: azure.mgmt.databox
name: azure-mgmt-databox
-
- items:
- name: Overview
uid: project-azure-mgmt-databoxedge
@@ -32125,7 +32042,6 @@
uid: azure.mgmt.databoxedge.DataBoxEdgeManagementClient
name: azure.mgmt.databoxedge
name: azure-mgmt-databoxedge
-
- items:
- name: Overview
uid: project-azure-mgmt-databricks
@@ -32304,7 +32220,6 @@
uid: azure.mgmt.databricks.AzureDatabricksManagementClient
name: azure.mgmt.databricks
name: azure-mgmt-databricks
-
- items:
- name: Overview
uid: project-azure-mgmt-datadog
@@ -32449,196 +32364,198 @@
uid: azure.mgmt.datadog.MicrosoftDatadogClient
name: azure.mgmt.datadog
name: azure-mgmt-datadog
-
- items:
- name: Overview
uid: project-azure-mgmt-datalake-analytics
- items:
- name: Overview
- uid: azure.mgmt.datalake.analytics.account
- - items:
- - name: Overview
- uid: azure.mgmt.datalake.analytics.account.aio
- - items:
- - name: Overview
- uid: azure.mgmt.datalake.analytics.account.aio.operations
- - name: azure.mgmt.datalake.analytics.account.aio.operations.AccountsOperations
- uid: azure.mgmt.datalake.analytics.account.aio.operations.AccountsOperations
- - name: azure.mgmt.datalake.analytics.account.aio.operations.ComputePoliciesOperations
- uid: azure.mgmt.datalake.analytics.account.aio.operations.ComputePoliciesOperations
- - name: azure.mgmt.datalake.analytics.account.aio.operations.DataLakeStoreAccountsOperations
- uid: azure.mgmt.datalake.analytics.account.aio.operations.DataLakeStoreAccountsOperations
- - name: azure.mgmt.datalake.analytics.account.aio.operations.FirewallRulesOperations
- uid: azure.mgmt.datalake.analytics.account.aio.operations.FirewallRulesOperations
- - name: azure.mgmt.datalake.analytics.account.aio.operations.LocationsOperations
- uid: azure.mgmt.datalake.analytics.account.aio.operations.LocationsOperations
- - name: azure.mgmt.datalake.analytics.account.aio.operations.Operations
- uid: azure.mgmt.datalake.analytics.account.aio.operations.Operations
- - name: azure.mgmt.datalake.analytics.account.aio.operations.StorageAccountsOperations
- uid: azure.mgmt.datalake.analytics.account.aio.operations.StorageAccountsOperations
- name: azure.mgmt.datalake.analytics.account.aio.operations
- - name: azure.mgmt.datalake.analytics.account.aio.DataLakeAnalyticsAccountManagementClient
- uid: azure.mgmt.datalake.analytics.account.aio.DataLakeAnalyticsAccountManagementClient
- name: azure.mgmt.datalake.analytics.account.aio
- - items:
- - name: Overview
- uid: azure.mgmt.datalake.analytics.account.models
- - name: azure.mgmt.datalake.analytics.account.models.AADObjectType
- uid: azure.mgmt.datalake.analytics.account.models.AADObjectType
- - name: azure.mgmt.datalake.analytics.account.models.AddDataLakeStoreParameters
- uid: azure.mgmt.datalake.analytics.account.models.AddDataLakeStoreParameters
- - name: azure.mgmt.datalake.analytics.account.models.AddDataLakeStoreWithAccountParameters
- uid: azure.mgmt.datalake.analytics.account.models.AddDataLakeStoreWithAccountParameters
- - name: azure.mgmt.datalake.analytics.account.models.AddStorageAccountParameters
- uid: azure.mgmt.datalake.analytics.account.models.AddStorageAccountParameters
- - name: azure.mgmt.datalake.analytics.account.models.AddStorageAccountWithAccountParameters
- uid: azure.mgmt.datalake.analytics.account.models.AddStorageAccountWithAccountParameters
- - name: azure.mgmt.datalake.analytics.account.models.CapabilityInformation
- uid: azure.mgmt.datalake.analytics.account.models.CapabilityInformation
- - name: azure.mgmt.datalake.analytics.account.models.CheckNameAvailabilityParameters
- uid: azure.mgmt.datalake.analytics.account.models.CheckNameAvailabilityParameters
- - name: azure.mgmt.datalake.analytics.account.models.CheckNameAvailabilityParametersType
- uid: azure.mgmt.datalake.analytics.account.models.CheckNameAvailabilityParametersType
- - name: azure.mgmt.datalake.analytics.account.models.ComputePolicy
- uid: azure.mgmt.datalake.analytics.account.models.ComputePolicy
- - name: azure.mgmt.datalake.analytics.account.models.ComputePolicyListResult
- uid: azure.mgmt.datalake.analytics.account.models.ComputePolicyListResult
- - name: azure.mgmt.datalake.analytics.account.models.CreateComputePolicyWithAccountParameters
- uid: azure.mgmt.datalake.analytics.account.models.CreateComputePolicyWithAccountParameters
- - name: azure.mgmt.datalake.analytics.account.models.CreateDataLakeAnalyticsAccountParameters
- uid: azure.mgmt.datalake.analytics.account.models.CreateDataLakeAnalyticsAccountParameters
- - name: azure.mgmt.datalake.analytics.account.models.CreateFirewallRuleWithAccountParameters
- uid: azure.mgmt.datalake.analytics.account.models.CreateFirewallRuleWithAccountParameters
- - name: azure.mgmt.datalake.analytics.account.models.CreateOrUpdateComputePolicyParameters
- uid: azure.mgmt.datalake.analytics.account.models.CreateOrUpdateComputePolicyParameters
- - name: azure.mgmt.datalake.analytics.account.models.CreateOrUpdateFirewallRuleParameters
- uid: azure.mgmt.datalake.analytics.account.models.CreateOrUpdateFirewallRuleParameters
- - name: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccount
- uid: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccount
- - name: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountBasic
- uid: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountBasic
- - name: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountListResult
- uid: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountListResult
- - name: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountProperties
- uid: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountProperties
- - name: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountPropertiesBasic
- uid: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountPropertiesBasic
- - name: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountState
- uid: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountState
- - name: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountStatus
- uid: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountStatus
- - name: azure.mgmt.datalake.analytics.account.models.DataLakeStoreAccountInformation
- uid: azure.mgmt.datalake.analytics.account.models.DataLakeStoreAccountInformation
- - name: azure.mgmt.datalake.analytics.account.models.DataLakeStoreAccountInformationListResult
- uid: azure.mgmt.datalake.analytics.account.models.DataLakeStoreAccountInformationListResult
- - name: azure.mgmt.datalake.analytics.account.models.DebugDataAccessLevel
- uid: azure.mgmt.datalake.analytics.account.models.DebugDataAccessLevel
- - name: azure.mgmt.datalake.analytics.account.models.ErrorAdditionalInfo
- uid: azure.mgmt.datalake.analytics.account.models.ErrorAdditionalInfo
- - name: azure.mgmt.datalake.analytics.account.models.ErrorDetail
- uid: azure.mgmt.datalake.analytics.account.models.ErrorDetail
- - name: azure.mgmt.datalake.analytics.account.models.ErrorResponse
- uid: azure.mgmt.datalake.analytics.account.models.ErrorResponse
- - name: azure.mgmt.datalake.analytics.account.models.FirewallAllowAzureIpsState
- uid: azure.mgmt.datalake.analytics.account.models.FirewallAllowAzureIpsState
- - name: azure.mgmt.datalake.analytics.account.models.FirewallRule
- uid: azure.mgmt.datalake.analytics.account.models.FirewallRule
- - name: azure.mgmt.datalake.analytics.account.models.FirewallRuleListResult
- uid: azure.mgmt.datalake.analytics.account.models.FirewallRuleListResult
- - name: azure.mgmt.datalake.analytics.account.models.FirewallState
- uid: azure.mgmt.datalake.analytics.account.models.FirewallState
- - name: azure.mgmt.datalake.analytics.account.models.HiveMetastore
- uid: azure.mgmt.datalake.analytics.account.models.HiveMetastore
- - name: azure.mgmt.datalake.analytics.account.models.HiveMetastoreListResult
- uid: azure.mgmt.datalake.analytics.account.models.HiveMetastoreListResult
- - name: azure.mgmt.datalake.analytics.account.models.NameAvailabilityInformation
- uid: azure.mgmt.datalake.analytics.account.models.NameAvailabilityInformation
- - name: azure.mgmt.datalake.analytics.account.models.NestedResourceProvisioningState
- uid: azure.mgmt.datalake.analytics.account.models.NestedResourceProvisioningState
- - name: azure.mgmt.datalake.analytics.account.models.Operation
- uid: azure.mgmt.datalake.analytics.account.models.Operation
- - name: azure.mgmt.datalake.analytics.account.models.OperationDisplay
- uid: azure.mgmt.datalake.analytics.account.models.OperationDisplay
- - name: azure.mgmt.datalake.analytics.account.models.OperationListResult
- uid: azure.mgmt.datalake.analytics.account.models.OperationListResult
- - name: azure.mgmt.datalake.analytics.account.models.OperationMetaLogSpecification
- uid: azure.mgmt.datalake.analytics.account.models.OperationMetaLogSpecification
- - name: azure.mgmt.datalake.analytics.account.models.OperationMetaMetricAvailabilitiesSpecification
- uid: azure.mgmt.datalake.analytics.account.models.OperationMetaMetricAvailabilitiesSpecification
- - name: azure.mgmt.datalake.analytics.account.models.OperationMetaMetricSpecification
- uid: azure.mgmt.datalake.analytics.account.models.OperationMetaMetricSpecification
- - name: azure.mgmt.datalake.analytics.account.models.OperationMetaPropertyInfo
- uid: azure.mgmt.datalake.analytics.account.models.OperationMetaPropertyInfo
- - name: azure.mgmt.datalake.analytics.account.models.OperationMetaServiceSpecification
- uid: azure.mgmt.datalake.analytics.account.models.OperationMetaServiceSpecification
- - name: azure.mgmt.datalake.analytics.account.models.OperationOrigin
- uid: azure.mgmt.datalake.analytics.account.models.OperationOrigin
- - name: azure.mgmt.datalake.analytics.account.models.Resource
- uid: azure.mgmt.datalake.analytics.account.models.Resource
- - name: azure.mgmt.datalake.analytics.account.models.SasTokenInformation
- uid: azure.mgmt.datalake.analytics.account.models.SasTokenInformation
- - name: azure.mgmt.datalake.analytics.account.models.SasTokenInformationListResult
- uid: azure.mgmt.datalake.analytics.account.models.SasTokenInformationListResult
- - name: azure.mgmt.datalake.analytics.account.models.StorageAccountInformation
- uid: azure.mgmt.datalake.analytics.account.models.StorageAccountInformation
- - name: azure.mgmt.datalake.analytics.account.models.StorageAccountInformationListResult
- uid: azure.mgmt.datalake.analytics.account.models.StorageAccountInformationListResult
- - name: azure.mgmt.datalake.analytics.account.models.StorageContainer
- uid: azure.mgmt.datalake.analytics.account.models.StorageContainer
- - name: azure.mgmt.datalake.analytics.account.models.StorageContainerListResult
- uid: azure.mgmt.datalake.analytics.account.models.StorageContainerListResult
- - name: azure.mgmt.datalake.analytics.account.models.SubResource
- uid: azure.mgmt.datalake.analytics.account.models.SubResource
- - name: azure.mgmt.datalake.analytics.account.models.SubscriptionState
- uid: azure.mgmt.datalake.analytics.account.models.SubscriptionState
- - name: azure.mgmt.datalake.analytics.account.models.TierType
- uid: azure.mgmt.datalake.analytics.account.models.TierType
- - name: azure.mgmt.datalake.analytics.account.models.UpdateComputePolicyParameters
- uid: azure.mgmt.datalake.analytics.account.models.UpdateComputePolicyParameters
- - name: azure.mgmt.datalake.analytics.account.models.UpdateComputePolicyWithAccountParameters
- uid: azure.mgmt.datalake.analytics.account.models.UpdateComputePolicyWithAccountParameters
- - name: azure.mgmt.datalake.analytics.account.models.UpdateDataLakeAnalyticsAccountParameters
- uid: azure.mgmt.datalake.analytics.account.models.UpdateDataLakeAnalyticsAccountParameters
- - name: azure.mgmt.datalake.analytics.account.models.UpdateDataLakeStoreWithAccountParameters
- uid: azure.mgmt.datalake.analytics.account.models.UpdateDataLakeStoreWithAccountParameters
- - name: azure.mgmt.datalake.analytics.account.models.UpdateFirewallRuleParameters
- uid: azure.mgmt.datalake.analytics.account.models.UpdateFirewallRuleParameters
- - name: azure.mgmt.datalake.analytics.account.models.UpdateFirewallRuleWithAccountParameters
- uid: azure.mgmt.datalake.analytics.account.models.UpdateFirewallRuleWithAccountParameters
- - name: azure.mgmt.datalake.analytics.account.models.UpdateStorageAccountParameters
- uid: azure.mgmt.datalake.analytics.account.models.UpdateStorageAccountParameters
- - name: azure.mgmt.datalake.analytics.account.models.UpdateStorageAccountWithAccountParameters
- uid: azure.mgmt.datalake.analytics.account.models.UpdateStorageAccountWithAccountParameters
- - name: azure.mgmt.datalake.analytics.account.models.VirtualNetworkRule
- uid: azure.mgmt.datalake.analytics.account.models.VirtualNetworkRule
- - name: azure.mgmt.datalake.analytics.account.models.VirtualNetworkRuleListResult
- uid: azure.mgmt.datalake.analytics.account.models.VirtualNetworkRuleListResult
- - name: azure.mgmt.datalake.analytics.account.models.VirtualNetworkRuleState
- uid: azure.mgmt.datalake.analytics.account.models.VirtualNetworkRuleState
- name: azure.mgmt.datalake.analytics.account.models
- - items:
- - name: Overview
- uid: azure.mgmt.datalake.analytics.account.operations
- - name: azure.mgmt.datalake.analytics.account.operations.AccountsOperations
- uid: azure.mgmt.datalake.analytics.account.operations.AccountsOperations
- - name: azure.mgmt.datalake.analytics.account.operations.ComputePoliciesOperations
- uid: azure.mgmt.datalake.analytics.account.operations.ComputePoliciesOperations
- - name: azure.mgmt.datalake.analytics.account.operations.DataLakeStoreAccountsOperations
- uid: azure.mgmt.datalake.analytics.account.operations.DataLakeStoreAccountsOperations
- - name: azure.mgmt.datalake.analytics.account.operations.FirewallRulesOperations
- uid: azure.mgmt.datalake.analytics.account.operations.FirewallRulesOperations
- - name: azure.mgmt.datalake.analytics.account.operations.LocationsOperations
- uid: azure.mgmt.datalake.analytics.account.operations.LocationsOperations
- - name: azure.mgmt.datalake.analytics.account.operations.Operations
- uid: azure.mgmt.datalake.analytics.account.operations.Operations
- - name: azure.mgmt.datalake.analytics.account.operations.StorageAccountsOperations
- uid: azure.mgmt.datalake.analytics.account.operations.StorageAccountsOperations
- name: azure.mgmt.datalake.analytics.account.operations
- - name: azure.mgmt.datalake.analytics.account.DataLakeAnalyticsAccountManagementClient
- uid: azure.mgmt.datalake.analytics.account.DataLakeAnalyticsAccountManagementClient
- name: azure.mgmt.datalake.analytics.account
+ uid: azure.mgmt.datalake.analytics
+ - items:
+ - name: Overview
+ uid: azure.mgmt.datalake.analytics.account
+ - items:
+ - name: Overview
+ uid: azure.mgmt.datalake.analytics.account.aio
+ - items:
+ - name: Overview
+ uid: azure.mgmt.datalake.analytics.account.aio.operations
+ - name: azure.mgmt.datalake.analytics.account.aio.operations.AccountsOperations
+ uid: azure.mgmt.datalake.analytics.account.aio.operations.AccountsOperations
+ - name: azure.mgmt.datalake.analytics.account.aio.operations.ComputePoliciesOperations
+ uid: azure.mgmt.datalake.analytics.account.aio.operations.ComputePoliciesOperations
+ - name: azure.mgmt.datalake.analytics.account.aio.operations.DataLakeStoreAccountsOperations
+ uid: azure.mgmt.datalake.analytics.account.aio.operations.DataLakeStoreAccountsOperations
+ - name: azure.mgmt.datalake.analytics.account.aio.operations.FirewallRulesOperations
+ uid: azure.mgmt.datalake.analytics.account.aio.operations.FirewallRulesOperations
+ - name: azure.mgmt.datalake.analytics.account.aio.operations.LocationsOperations
+ uid: azure.mgmt.datalake.analytics.account.aio.operations.LocationsOperations
+ - name: azure.mgmt.datalake.analytics.account.aio.operations.Operations
+ uid: azure.mgmt.datalake.analytics.account.aio.operations.Operations
+ - name: azure.mgmt.datalake.analytics.account.aio.operations.StorageAccountsOperations
+ uid: azure.mgmt.datalake.analytics.account.aio.operations.StorageAccountsOperations
+ name: azure.mgmt.datalake.analytics.account.aio.operations
+ - name: azure.mgmt.datalake.analytics.account.aio.DataLakeAnalyticsAccountManagementClient
+ uid: azure.mgmt.datalake.analytics.account.aio.DataLakeAnalyticsAccountManagementClient
+ name: azure.mgmt.datalake.analytics.account.aio
+ - items:
+ - name: Overview
+ uid: azure.mgmt.datalake.analytics.account.models
+ - name: azure.mgmt.datalake.analytics.account.models.AADObjectType
+ uid: azure.mgmt.datalake.analytics.account.models.AADObjectType
+ - name: azure.mgmt.datalake.analytics.account.models.AddDataLakeStoreParameters
+ uid: azure.mgmt.datalake.analytics.account.models.AddDataLakeStoreParameters
+ - name: azure.mgmt.datalake.analytics.account.models.AddDataLakeStoreWithAccountParameters
+ uid: azure.mgmt.datalake.analytics.account.models.AddDataLakeStoreWithAccountParameters
+ - name: azure.mgmt.datalake.analytics.account.models.AddStorageAccountParameters
+ uid: azure.mgmt.datalake.analytics.account.models.AddStorageAccountParameters
+ - name: azure.mgmt.datalake.analytics.account.models.AddStorageAccountWithAccountParameters
+ uid: azure.mgmt.datalake.analytics.account.models.AddStorageAccountWithAccountParameters
+ - name: azure.mgmt.datalake.analytics.account.models.CapabilityInformation
+ uid: azure.mgmt.datalake.analytics.account.models.CapabilityInformation
+ - name: azure.mgmt.datalake.analytics.account.models.CheckNameAvailabilityParameters
+ uid: azure.mgmt.datalake.analytics.account.models.CheckNameAvailabilityParameters
+ - name: azure.mgmt.datalake.analytics.account.models.CheckNameAvailabilityParametersType
+ uid: azure.mgmt.datalake.analytics.account.models.CheckNameAvailabilityParametersType
+ - name: azure.mgmt.datalake.analytics.account.models.ComputePolicy
+ uid: azure.mgmt.datalake.analytics.account.models.ComputePolicy
+ - name: azure.mgmt.datalake.analytics.account.models.ComputePolicyListResult
+ uid: azure.mgmt.datalake.analytics.account.models.ComputePolicyListResult
+ - name: azure.mgmt.datalake.analytics.account.models.CreateComputePolicyWithAccountParameters
+ uid: azure.mgmt.datalake.analytics.account.models.CreateComputePolicyWithAccountParameters
+ - name: azure.mgmt.datalake.analytics.account.models.CreateDataLakeAnalyticsAccountParameters
+ uid: azure.mgmt.datalake.analytics.account.models.CreateDataLakeAnalyticsAccountParameters
+ - name: azure.mgmt.datalake.analytics.account.models.CreateFirewallRuleWithAccountParameters
+ uid: azure.mgmt.datalake.analytics.account.models.CreateFirewallRuleWithAccountParameters
+ - name: azure.mgmt.datalake.analytics.account.models.CreateOrUpdateComputePolicyParameters
+ uid: azure.mgmt.datalake.analytics.account.models.CreateOrUpdateComputePolicyParameters
+ - name: azure.mgmt.datalake.analytics.account.models.CreateOrUpdateFirewallRuleParameters
+ uid: azure.mgmt.datalake.analytics.account.models.CreateOrUpdateFirewallRuleParameters
+ - name: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccount
+ uid: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccount
+ - name: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountBasic
+ uid: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountBasic
+ - name: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountListResult
+ uid: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountListResult
+ - name: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountProperties
+ uid: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountProperties
+ - name: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountPropertiesBasic
+ uid: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountPropertiesBasic
+ - name: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountState
+ uid: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountState
+ - name: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountStatus
+ uid: azure.mgmt.datalake.analytics.account.models.DataLakeAnalyticsAccountStatus
+ - name: azure.mgmt.datalake.analytics.account.models.DataLakeStoreAccountInformation
+ uid: azure.mgmt.datalake.analytics.account.models.DataLakeStoreAccountInformation
+ - name: azure.mgmt.datalake.analytics.account.models.DataLakeStoreAccountInformationListResult
+ uid: azure.mgmt.datalake.analytics.account.models.DataLakeStoreAccountInformationListResult
+ - name: azure.mgmt.datalake.analytics.account.models.DebugDataAccessLevel
+ uid: azure.mgmt.datalake.analytics.account.models.DebugDataAccessLevel
+ - name: azure.mgmt.datalake.analytics.account.models.ErrorAdditionalInfo
+ uid: azure.mgmt.datalake.analytics.account.models.ErrorAdditionalInfo
+ - name: azure.mgmt.datalake.analytics.account.models.ErrorDetail
+ uid: azure.mgmt.datalake.analytics.account.models.ErrorDetail
+ - name: azure.mgmt.datalake.analytics.account.models.ErrorResponse
+ uid: azure.mgmt.datalake.analytics.account.models.ErrorResponse
+ - name: azure.mgmt.datalake.analytics.account.models.FirewallAllowAzureIpsState
+ uid: azure.mgmt.datalake.analytics.account.models.FirewallAllowAzureIpsState
+ - name: azure.mgmt.datalake.analytics.account.models.FirewallRule
+ uid: azure.mgmt.datalake.analytics.account.models.FirewallRule
+ - name: azure.mgmt.datalake.analytics.account.models.FirewallRuleListResult
+ uid: azure.mgmt.datalake.analytics.account.models.FirewallRuleListResult
+ - name: azure.mgmt.datalake.analytics.account.models.FirewallState
+ uid: azure.mgmt.datalake.analytics.account.models.FirewallState
+ - name: azure.mgmt.datalake.analytics.account.models.HiveMetastore
+ uid: azure.mgmt.datalake.analytics.account.models.HiveMetastore
+ - name: azure.mgmt.datalake.analytics.account.models.HiveMetastoreListResult
+ uid: azure.mgmt.datalake.analytics.account.models.HiveMetastoreListResult
+ - name: azure.mgmt.datalake.analytics.account.models.NameAvailabilityInformation
+ uid: azure.mgmt.datalake.analytics.account.models.NameAvailabilityInformation
+ - name: azure.mgmt.datalake.analytics.account.models.NestedResourceProvisioningState
+ uid: azure.mgmt.datalake.analytics.account.models.NestedResourceProvisioningState
+ - name: azure.mgmt.datalake.analytics.account.models.Operation
+ uid: azure.mgmt.datalake.analytics.account.models.Operation
+ - name: azure.mgmt.datalake.analytics.account.models.OperationDisplay
+ uid: azure.mgmt.datalake.analytics.account.models.OperationDisplay
+ - name: azure.mgmt.datalake.analytics.account.models.OperationListResult
+ uid: azure.mgmt.datalake.analytics.account.models.OperationListResult
+ - name: azure.mgmt.datalake.analytics.account.models.OperationMetaLogSpecification
+ uid: azure.mgmt.datalake.analytics.account.models.OperationMetaLogSpecification
+ - name: azure.mgmt.datalake.analytics.account.models.OperationMetaMetricAvailabilitiesSpecification
+ uid: azure.mgmt.datalake.analytics.account.models.OperationMetaMetricAvailabilitiesSpecification
+ - name: azure.mgmt.datalake.analytics.account.models.OperationMetaMetricSpecification
+ uid: azure.mgmt.datalake.analytics.account.models.OperationMetaMetricSpecification
+ - name: azure.mgmt.datalake.analytics.account.models.OperationMetaPropertyInfo
+ uid: azure.mgmt.datalake.analytics.account.models.OperationMetaPropertyInfo
+ - name: azure.mgmt.datalake.analytics.account.models.OperationMetaServiceSpecification
+ uid: azure.mgmt.datalake.analytics.account.models.OperationMetaServiceSpecification
+ - name: azure.mgmt.datalake.analytics.account.models.OperationOrigin
+ uid: azure.mgmt.datalake.analytics.account.models.OperationOrigin
+ - name: azure.mgmt.datalake.analytics.account.models.Resource
+ uid: azure.mgmt.datalake.analytics.account.models.Resource
+ - name: azure.mgmt.datalake.analytics.account.models.SasTokenInformation
+ uid: azure.mgmt.datalake.analytics.account.models.SasTokenInformation
+ - name: azure.mgmt.datalake.analytics.account.models.SasTokenInformationListResult
+ uid: azure.mgmt.datalake.analytics.account.models.SasTokenInformationListResult
+ - name: azure.mgmt.datalake.analytics.account.models.StorageAccountInformation
+ uid: azure.mgmt.datalake.analytics.account.models.StorageAccountInformation
+ - name: azure.mgmt.datalake.analytics.account.models.StorageAccountInformationListResult
+ uid: azure.mgmt.datalake.analytics.account.models.StorageAccountInformationListResult
+ - name: azure.mgmt.datalake.analytics.account.models.StorageContainer
+ uid: azure.mgmt.datalake.analytics.account.models.StorageContainer
+ - name: azure.mgmt.datalake.analytics.account.models.StorageContainerListResult
+ uid: azure.mgmt.datalake.analytics.account.models.StorageContainerListResult
+ - name: azure.mgmt.datalake.analytics.account.models.SubResource
+ uid: azure.mgmt.datalake.analytics.account.models.SubResource
+ - name: azure.mgmt.datalake.analytics.account.models.SubscriptionState
+ uid: azure.mgmt.datalake.analytics.account.models.SubscriptionState
+ - name: azure.mgmt.datalake.analytics.account.models.TierType
+ uid: azure.mgmt.datalake.analytics.account.models.TierType
+ - name: azure.mgmt.datalake.analytics.account.models.UpdateComputePolicyParameters
+ uid: azure.mgmt.datalake.analytics.account.models.UpdateComputePolicyParameters
+ - name: azure.mgmt.datalake.analytics.account.models.UpdateComputePolicyWithAccountParameters
+ uid: azure.mgmt.datalake.analytics.account.models.UpdateComputePolicyWithAccountParameters
+ - name: azure.mgmt.datalake.analytics.account.models.UpdateDataLakeAnalyticsAccountParameters
+ uid: azure.mgmt.datalake.analytics.account.models.UpdateDataLakeAnalyticsAccountParameters
+ - name: azure.mgmt.datalake.analytics.account.models.UpdateDataLakeStoreWithAccountParameters
+ uid: azure.mgmt.datalake.analytics.account.models.UpdateDataLakeStoreWithAccountParameters
+ - name: azure.mgmt.datalake.analytics.account.models.UpdateFirewallRuleParameters
+ uid: azure.mgmt.datalake.analytics.account.models.UpdateFirewallRuleParameters
+ - name: azure.mgmt.datalake.analytics.account.models.UpdateFirewallRuleWithAccountParameters
+ uid: azure.mgmt.datalake.analytics.account.models.UpdateFirewallRuleWithAccountParameters
+ - name: azure.mgmt.datalake.analytics.account.models.UpdateStorageAccountParameters
+ uid: azure.mgmt.datalake.analytics.account.models.UpdateStorageAccountParameters
+ - name: azure.mgmt.datalake.analytics.account.models.UpdateStorageAccountWithAccountParameters
+ uid: azure.mgmt.datalake.analytics.account.models.UpdateStorageAccountWithAccountParameters
+ - name: azure.mgmt.datalake.analytics.account.models.VirtualNetworkRule
+ uid: azure.mgmt.datalake.analytics.account.models.VirtualNetworkRule
+ - name: azure.mgmt.datalake.analytics.account.models.VirtualNetworkRuleListResult
+ uid: azure.mgmt.datalake.analytics.account.models.VirtualNetworkRuleListResult
+ - name: azure.mgmt.datalake.analytics.account.models.VirtualNetworkRuleState
+ uid: azure.mgmt.datalake.analytics.account.models.VirtualNetworkRuleState
+ name: azure.mgmt.datalake.analytics.account.models
+ - items:
+ - name: Overview
+ uid: azure.mgmt.datalake.analytics.account.operations
+ - name: azure.mgmt.datalake.analytics.account.operations.AccountsOperations
+ uid: azure.mgmt.datalake.analytics.account.operations.AccountsOperations
+ - name: azure.mgmt.datalake.analytics.account.operations.ComputePoliciesOperations
+ uid: azure.mgmt.datalake.analytics.account.operations.ComputePoliciesOperations
+ - name: azure.mgmt.datalake.analytics.account.operations.DataLakeStoreAccountsOperations
+ uid: azure.mgmt.datalake.analytics.account.operations.DataLakeStoreAccountsOperations
+ - name: azure.mgmt.datalake.analytics.account.operations.FirewallRulesOperations
+ uid: azure.mgmt.datalake.analytics.account.operations.FirewallRulesOperations
+ - name: azure.mgmt.datalake.analytics.account.operations.LocationsOperations
+ uid: azure.mgmt.datalake.analytics.account.operations.LocationsOperations
+ - name: azure.mgmt.datalake.analytics.account.operations.Operations
+ uid: azure.mgmt.datalake.analytics.account.operations.Operations
+ - name: azure.mgmt.datalake.analytics.account.operations.StorageAccountsOperations
+ uid: azure.mgmt.datalake.analytics.account.operations.StorageAccountsOperations
+ name: azure.mgmt.datalake.analytics.account.operations
+ - name: azure.mgmt.datalake.analytics.account.DataLakeAnalyticsAccountManagementClient
+ uid: azure.mgmt.datalake.analytics.account.DataLakeAnalyticsAccountManagementClient
+ name: azure.mgmt.datalake.analytics.account
+ name: azure.mgmt.datalake.analytics
name: azure-mgmt-datalake-analytics
-
- items:
- name: Overview
uid: project-azure-mgmt-datalake-store
@@ -32799,7 +32716,6 @@
uid: azure.mgmt.datalake.store.DataLakeStoreAccountManagementClient
name: azure.mgmt.datalake.store
name: azure-mgmt-datalake-store
-
- items:
- name: Overview
uid: project-azure-mgmt-datamigration
@@ -33618,7 +33534,6 @@
uid: azure.mgmt.datamigration.DataMigrationManagementClient
name: azure.mgmt.datamigration
name: azure-mgmt-datamigration
-
- items:
- name: Overview
uid: project-azure-mgmt-dataprotection
@@ -34061,7 +33976,6 @@
uid: azure.mgmt.dataprotection.DataProtectionClient
name: azure.mgmt.dataprotection
name: azure-mgmt-dataprotection
-
- items:
- name: Overview
uid: project-azure-mgmt-datashare
@@ -34330,7 +34244,6 @@
uid: azure.mgmt.datashare.DataShareManagementClient
name: azure.mgmt.datashare
name: azure-mgmt-datashare
-
- items:
- name: Overview
uid: project-azure-mgmt-defendereasm
@@ -34415,7 +34328,6 @@
uid: azure.mgmt.defendereasm.EasmMgmtClient
name: azure.mgmt.defendereasm
name: azure-mgmt-defendereasm
-
- items:
- name: Overview
uid: project-azure-mgmt-deploymentmanager
@@ -34584,7 +34496,6 @@
uid: azure.mgmt.deploymentmanager.AzureDeploymentManager
name: azure.mgmt.deploymentmanager
name: azure-mgmt-deploymentmanager
-
- items:
- name: Overview
uid: project-azure-mgmt-desktopvirtualization
@@ -34839,7 +34750,6 @@
uid: azure.mgmt.desktopvirtualization.DesktopVirtualizationMgmtClient
name: azure.mgmt.desktopvirtualization
name: azure-mgmt-desktopvirtualization
-
- items:
- name: Overview
uid: project-azure-mgmt-devcenter
@@ -35154,7 +35064,6 @@
uid: azure.mgmt.devcenter.DevCenterMgmtClient
name: azure.mgmt.devcenter
name: azure-mgmt-devcenter
-
- items:
- name: Overview
uid: project-azure-mgmt-devhub
@@ -35263,7 +35172,6 @@
uid: azure.mgmt.devhub.DevHubMgmtClient
name: azure.mgmt.devhub
name: azure-mgmt-devhub
-
- items:
- name: Overview
uid: project-azure-mgmt-deviceupdate
@@ -35432,7 +35340,6 @@
uid: azure.mgmt.deviceupdate.DeviceUpdateMgmtClient
name: azure.mgmt.deviceupdate
name: azure-mgmt-deviceupdate
-
- items:
- name: Overview
uid: project-azure-mgmt-devspaces
@@ -35513,7 +35420,6 @@
uid: azure.mgmt.devspaces.DevSpacesManagementClient
name: azure.mgmt.devspaces
name: azure-mgmt-devspaces
-
- items:
- name: Overview
uid: project-azure-mgmt-devtestlabs
@@ -35948,7 +35854,6 @@
uid: azure.mgmt.devtestlabs.DevTestLabsClient
name: azure.mgmt.devtestlabs
name: azure-mgmt-devtestlabs
-
- items:
- name: Overview
uid: project-azure-mgmt-digitaltwins
@@ -36683,7 +36588,6 @@
uid: azure.mgmt.digitaltwins.AzureDigitalTwinsManagementClient
name: azure.mgmt.digitaltwins
name: azure-mgmt-digitaltwins
-
- items:
- name: Overview
uid: project-azure-mgmt-dns
@@ -36940,7 +36844,6 @@
uid: azure.mgmt.dns.DnsManagementClient
name: azure.mgmt.dns
name: azure-mgmt-dns
-
- items:
- name: Overview
uid: project-azure-mgmt-dnsresolver
@@ -37061,7 +36964,6 @@
uid: azure.mgmt.dnsresolver.DnsResolverManagementClient
name: azure.mgmt.dnsresolver
name: azure-mgmt-dnsresolver
-
- items:
- name: Overview
uid: project-azure-mgmt-dynatrace
@@ -37232,7 +37134,6 @@
uid: azure.mgmt.dynatrace.DynatraceObservabilityMgmtClient
name: azure.mgmt.dynatrace
name: azure-mgmt-dynatrace
-
- items:
- name: Overview
uid: project-azure-mgmt-edgeorder
@@ -37943,7 +37844,6 @@
uid: azure.mgmt.edgeorder.EdgeOrderManagementClient
name: azure.mgmt.edgeorder
name: azure-mgmt-edgeorder
-
- items:
- name: Overview
uid: project-azure-mgmt-education
@@ -38058,7 +37958,6 @@
uid: azure.mgmt.education.EducationManagementClient
name: azure.mgmt.education
name: azure-mgmt-education
-
- items:
- name: Overview
uid: project-azure-mgmt-elastic
@@ -38279,7 +38178,6 @@
uid: azure.mgmt.elastic.MicrosoftElastic
name: azure.mgmt.elastic
name: azure-mgmt-elastic
-
- items:
- name: Overview
uid: project-azure-mgmt-elasticsan
@@ -38426,7 +38324,6 @@
uid: azure.mgmt.elasticsan.ElasticSanMgmtClient
name: azure.mgmt.elasticsan
name: azure-mgmt-elasticsan
-
- items:
- name: Overview
uid: project-azure-mgmt-eventgrid
@@ -39061,7 +38958,6 @@
uid: azure.mgmt.eventgrid.EventGridManagementClient
name: azure.mgmt.eventgrid
name: azure-mgmt-eventgrid
-
- items:
- name: Overview
uid: project-azure-mgmt-eventhub
@@ -40594,7 +40490,6 @@
uid: azure.mgmt.eventhub.EventHubManagementClient
name: azure.mgmt.eventhub
name: azure-mgmt-eventhub
-
- items:
- name: Overview
uid: project-azure-mgmt-extendedlocation
@@ -40831,7 +40726,6 @@
uid: azure.mgmt.extendedlocation.CustomLocations
name: azure.mgmt.extendedlocation
name: azure-mgmt-extendedlocation
-
- items:
- name: Overview
uid: project-azure-mgmt-fluidrelay
@@ -40930,7 +40824,6 @@
uid: azure.mgmt.fluidrelay.FluidRelayManagementClient
name: azure.mgmt.fluidrelay
name: azure-mgmt-fluidrelay
-
- items:
- name: Overview
uid: project-azure-mgmt-frontdoor
@@ -41281,7 +41174,6 @@
uid: azure.mgmt.frontdoor.FrontDoorManagementClient
name: azure.mgmt.frontdoor
name: azure-mgmt-frontdoor
-
- items:
- name: Overview
uid: project-azure-mgmt-graphservices
@@ -41356,7 +41248,6 @@
uid: azure.mgmt.graphservices.GraphServicesMgmtClient
name: azure.mgmt.graphservices
name: azure-mgmt-graphservices
-
- items:
- name: Overview
uid: project-azure-mgmt-guestconfig
@@ -41479,7 +41370,6 @@
uid: azure.mgmt.guestconfig.GuestConfigurationClient
name: azure.mgmt.guestconfig
name: azure-mgmt-guestconfig
-
- items:
- name: Overview
uid: project-azure-mgmt-hanaonazure
@@ -41548,7 +41438,6 @@
uid: azure.mgmt.hanaonazure.HanaManagementClient
name: azure.mgmt.hanaonazure
name: azure-mgmt-hanaonazure
-
- items:
- name: Overview
uid: project-azure-mgmt-hdinsight
@@ -41873,7 +41762,6 @@
uid: azure.mgmt.hdinsight.HDInsightManagementClient
name: azure.mgmt.hdinsight
name: azure-mgmt-hdinsight
-
- items:
- name: Overview
uid: project-azure-mgmt-hdinsightcontainers
@@ -42144,7 +42032,6 @@
uid: azure.mgmt.hdinsightcontainers.HDInsightContainersMgmtClient
name: azure.mgmt.hdinsightcontainers
name: azure-mgmt-hdinsightcontainers
-
- items:
- name: Overview
uid: project-azure-mgmt-healthbot
@@ -42227,7 +42114,6 @@
uid: azure.mgmt.healthbot.HealthBotMgmtClient
name: azure.mgmt.healthbot
name: azure-mgmt-healthbot
-
- items:
- name: Overview
uid: project-azure-mgmt-healthcareapis
@@ -42486,7 +42372,6 @@
uid: azure.mgmt.healthcareapis.HealthcareApisManagementClient
name: azure.mgmt.healthcareapis
name: azure-mgmt-healthcareapis
-
- items:
- name: Overview
uid: project-azure-mgmt-hybridcompute
@@ -42665,7 +42550,6 @@
uid: azure.mgmt.hybridcompute.HybridComputeManagementClient
name: azure.mgmt.hybridcompute
name: azure-mgmt-hybridcompute
-
- items:
- name: Overview
uid: project-azure-mgmt-hybridcontainerservice
@@ -42936,7 +42820,6 @@
uid: azure.mgmt.hybridcontainerservice.HybridContainerServiceMgmtClient
name: azure.mgmt.hybridcontainerservice
name: azure-mgmt-hybridcontainerservice
-
- items:
- name: Overview
uid: project-azure-mgmt-hybridkubernetes
@@ -43019,7 +42902,6 @@
uid: azure.mgmt.hybridkubernetes.ConnectedKubernetesClient
name: azure.mgmt.hybridkubernetes
name: azure-mgmt-hybridkubernetes
-
- items:
- name: Overview
uid: project-azure-mgmt-hybridnetwork
@@ -43236,7 +43118,6 @@
uid: azure.mgmt.hybridnetwork.HybridNetworkManagementClient
name: azure.mgmt.hybridnetwork
name: azure-mgmt-hybridnetwork
-
- items:
- name: Overview
uid: project-azure-mgmt-imagebuilder
@@ -43363,7 +43244,6 @@
uid: azure.mgmt.imagebuilder.ImageBuilderClient
name: azure.mgmt.imagebuilder
name: azure-mgmt-imagebuilder
-
- items:
- name: Overview
uid: project-azure-mgmt-iotcentral
@@ -43436,7 +43316,6 @@
uid: azure.mgmt.iotcentral.IotCentralClient
name: azure.mgmt.iotcentral
name: azure-mgmt-iotcentral
-
- items:
- name: Overview
uid: project-azure-mgmt-iotfirmwaredefense
@@ -43585,7 +43464,6 @@
uid: azure.mgmt.iotfirmwaredefense.IoTFirmwareDefenseMgmtClient
name: azure.mgmt.iotfirmwaredefense
name: azure-mgmt-iotfirmwaredefense
-
- items:
- name: Overview
uid: project-azure-mgmt-iothub
@@ -46500,7 +46378,6 @@
uid: azure.mgmt.iothub.IotHubClient
name: azure.mgmt.iothub
name: azure-mgmt-iothub
-
- items:
- name: Overview
uid: project-azure-mgmt-iothubprovisioningservices
@@ -46639,7 +46516,6 @@
uid: azure.mgmt.iothubprovisioningservices.IotDpsClient
name: azure.mgmt.iothubprovisioningservices
name: azure-mgmt-iothubprovisioningservices
-
- items:
- name: Overview
uid: project-azure-mgmt-keyvault
@@ -48264,7 +48140,6 @@
uid: azure.mgmt.keyvault.KeyVaultManagementClient
name: azure.mgmt.keyvault
name: azure-mgmt-keyvault
-
- items:
- name: Overview
uid: project-azure-mgmt-kubernetesconfiguration
@@ -49883,7 +49758,6 @@
uid: azure.mgmt.kubernetesconfiguration.SourceControlConfigurationClient
name: azure.mgmt.kubernetesconfiguration
name: azure-mgmt-kubernetesconfiguration
-
- items:
- name: Overview
uid: project-azure-mgmt-kusto
@@ -50192,7 +50066,6 @@
uid: azure.mgmt.kusto.KustoManagementClient
name: azure.mgmt.kusto
name: azure-mgmt-kusto
-
- items:
- name: Overview
uid: project-azure-mgmt-labservices
@@ -50441,7 +50314,6 @@
uid: azure.mgmt.labservices.ManagedLabsClient
name: azure.mgmt.labservices
name: azure-mgmt-labservices
-
- items:
- name: Overview
uid: project-azure-mgmt-loadtesting
@@ -50544,7 +50416,6 @@
uid: azure.mgmt.loadtesting.LoadTestMgmtClient
name: azure.mgmt.loadtesting
name: azure-mgmt-loadtesting
-
- items:
- name: Overview
uid: project-azure-mgmt-loganalytics
@@ -50873,7 +50744,6 @@
uid: azure.mgmt.loganalytics.LogAnalyticsManagementClient
name: azure.mgmt.loganalytics
name: azure-mgmt-loganalytics
-
- items:
- name: Overview
uid: project-azure-mgmt-logic
@@ -51512,7 +51382,6 @@
uid: azure.mgmt.logic.LogicManagementClient
name: azure.mgmt.logic
name: azure-mgmt-logic
-
- items:
- name: Overview
uid: project-azure-mgmt-logz
@@ -51655,7 +51524,6 @@
uid: azure.mgmt.logz.MicrosoftLogz
name: azure.mgmt.logz
name: azure-mgmt-logz
-
- items:
- name: Overview
uid: project-azure-mgmt-machinelearningcompute
@@ -51762,7 +51630,6 @@
uid: azure.mgmt.machinelearningcompute.MachineLearningComputeManagementClient
name: azure.mgmt.machinelearningcompute
name: azure-mgmt-machinelearningcompute
-
- items:
- name: Overview
uid: project-azure-mgmt-machinelearningservices
@@ -52983,7 +52850,6 @@
uid: azure.mgmt.machinelearningservices.MachineLearningServicesMgmtClient
name: azure.mgmt.machinelearningservices
name: azure-mgmt-machinelearningservices
-
- items:
- name: Overview
uid: project-azure-mgmt-maintenance
@@ -53100,7 +52966,6 @@
uid: azure.mgmt.maintenance.MaintenanceManagementClient
name: azure.mgmt.maintenance
name: azure-mgmt-maintenance
-
- items:
- name: Overview
uid: project-azure-mgmt-managednetworkfabric
@@ -53569,7 +53434,6 @@
uid: azure.mgmt.managednetworkfabric.ManagedNetworkFabricMgmtClient
name: azure.mgmt.managednetworkfabric
name: azure-mgmt-managednetworkfabric
-
- items:
- name: Overview
uid: project-azure-mgmt-managedservices
@@ -53672,7 +53536,6 @@
uid: azure.mgmt.managedservices.ManagedServicesClient
name: azure.mgmt.managedservices
name: azure-mgmt-managedservices
-
- items:
- name: Overview
uid: project-azure-mgmt-managementgroups
@@ -53811,7 +53674,6 @@
uid: azure.mgmt.managementgroups.ManagementGroupsAPI
name: azure.mgmt.managementgroups
name: azure-mgmt-managementgroups
-
- items:
- name: Overview
uid: project-azure-mgmt-managementpartner
@@ -53866,7 +53728,6 @@
uid: azure.mgmt.managementpartner.ACEProvisioningManagementPartnerAPI
name: azure.mgmt.managementpartner
name: azure-mgmt-managementpartner
-
- items:
- name: Overview
uid: project-azure-mgmt-maps
@@ -53979,7 +53840,6 @@
uid: azure.mgmt.maps.AzureMapsManagementClient
name: azure.mgmt.maps
name: azure-mgmt-maps
-
- items:
- name: Overview
uid: project-azure-mgmt-marketplaceordering
@@ -54036,7 +53896,6 @@
uid: azure.mgmt.marketplaceordering.MarketplaceOrderingAgreements
name: azure.mgmt.marketplaceordering
name: azure-mgmt-marketplaceordering
-
- items:
- name: Overview
uid: project-azure-mgmt-media
@@ -54703,7 +54562,6 @@
uid: azure.mgmt.media.AzureMediaServices
name: azure.mgmt.media
name: azure-mgmt-media
-
- items:
- name: Overview
uid: project-azure-mgmt-mixedreality
@@ -54810,7 +54668,6 @@
uid: azure.mgmt.mixedreality.MixedRealityClient
name: azure.mgmt.mixedreality
name: azure-mgmt-mixedreality
-
- items:
- name: Overview
uid: project-azure-mgmt-mobilenetwork
@@ -55061,7 +54918,6 @@
uid: azure.mgmt.mobilenetwork.MobileNetworkManagementClient
name: azure.mgmt.mobilenetwork
name: azure-mgmt-mobilenetwork
-
- items:
- name: Overview
uid: project-azure-mgmt-msi
@@ -55340,7 +55196,6 @@
uid: azure.mgmt.msi.ManagedServiceIdentityClient
name: azure.mgmt.msi
name: azure-mgmt-msi
-
- items:
- name: Overview
uid: project-azure-mgmt-netapp
@@ -55677,7 +55532,6 @@
uid: azure.mgmt.netapp.NetAppManagementClient
name: azure.mgmt.netapp
name: azure-mgmt-netapp
-
- items:
- name: Overview
uid: project-azure-mgmt-network
@@ -58254,7 +58108,6 @@
uid: azure.mgmt.network.NetworkManagementClient
name: azure.mgmt.network
name: azure-mgmt-network
-
- items:
- name: Overview
uid: project-azure-mgmt-networkcloud
@@ -58805,7 +58658,6 @@
uid: azure.mgmt.networkcloud.NetworkCloudMgmtClient
name: azure.mgmt.networkcloud
name: azure-mgmt-networkcloud
-
- items:
- name: Overview
uid: project-azure-mgmt-networkfunction
@@ -58904,7 +58756,6 @@
uid: azure.mgmt.networkfunction.TrafficCollectorMgmtClient
name: azure.mgmt.networkfunction
name: azure-mgmt-networkfunction
-
- items:
- name: Overview
uid: project-azure-mgmt-newrelicobservability
@@ -59101,7 +58952,6 @@
uid: azure.mgmt.newrelicobservability.NewRelicObservabilityMgmtClient
name: azure.mgmt.newrelicobservability
name: azure-mgmt-newrelicobservability
-
- items:
- name: Overview
uid: project-azure-mgmt-nginx
@@ -59212,7 +59062,6 @@
uid: azure.mgmt.nginx.NginxManagementClient
name: azure.mgmt.nginx
name: azure-mgmt-nginx
-
- items:
- name: Overview
uid: project-azure-mgmt-notificationhubs
@@ -59321,7 +59170,6 @@
uid: azure.mgmt.notificationhubs.NotificationHubsManagementClient
name: azure.mgmt.notificationhubs
name: azure-mgmt-notificationhubs
-
- items:
- name: Overview
uid: project-azure-mgmt-oep
@@ -59410,7 +59258,6 @@
uid: azure.mgmt.oep.OpenEnergyPlatformManagementServiceAPIs
name: azure.mgmt.oep
name: azure-mgmt-oep
-
- items:
- name: Overview
uid: project-azure-mgmt-operationsmanagement
@@ -59489,7 +59336,6 @@
uid: azure.mgmt.operationsmanagement.OperationsManagementClient
name: azure.mgmt.operationsmanagement
name: azure-mgmt-operationsmanagement
-
- items:
- name: Overview
uid: project-azure-mgmt-orbital
@@ -59658,7 +59504,6 @@
uid: azure.mgmt.orbital.AzureOrbital
name: azure.mgmt.orbital
name: azure-mgmt-orbital
-
- items:
- name: Overview
uid: project-azure-mgmt-paloaltonetworksngfw
@@ -59967,7 +59812,6 @@
uid: azure.mgmt.paloaltonetworksngfw.PaloAltoNetworksNgfwMgmtClient
name: azure.mgmt.paloaltonetworksngfw
name: azure-mgmt-paloaltonetworksngfw
-
- items:
- name: Overview
uid: project-azure-mgmt-peering
@@ -60222,7 +60066,6 @@
uid: azure.mgmt.peering.PeeringManagementClient
name: azure.mgmt.peering
name: azure-mgmt-peering
-
- items:
- name: Overview
uid: project-azure-mgmt-policyinsights
@@ -60433,7 +60276,6 @@
uid: azure.mgmt.policyinsights.PolicyInsightsClient
name: azure.mgmt.policyinsights
name: azure-mgmt-policyinsights
-
- items:
- name: Overview
uid: project-azure-mgmt-portal
@@ -60524,7 +60366,6 @@
uid: azure.mgmt.portal.Portal
name: azure.mgmt.portal
name: azure-mgmt-portal
-
- items:
- name: Overview
uid: project-azure-mgmt-powerbidedicated
@@ -60639,7 +60480,6 @@
uid: azure.mgmt.powerbidedicated.PowerBIDedicated
name: azure.mgmt.powerbidedicated
name: azure-mgmt-powerbidedicated
-
- items:
- name: Overview
uid: project-azure-mgmt-privatedns
@@ -60724,7 +60564,6 @@
uid: azure.mgmt.privatedns.PrivateDnsManagementClient
name: azure.mgmt.privatedns
name: azure-mgmt-privatedns
-
- items:
- name: Overview
uid: project-azure-mgmt-purview
@@ -60869,7 +60708,6 @@
uid: azure.mgmt.purview.PurviewManagementClient
name: azure.mgmt.purview
name: azure-mgmt-purview
-
- items:
- name: Overview
uid: project-azure-mgmt-quantum
@@ -60976,7 +60814,6 @@
uid: azure.mgmt.quantum.AzureQuantumManagementClient
name: azure.mgmt.quantum
name: azure-mgmt-quantum
-
- items:
- name: Overview
uid: project-azure-mgmt-qumulo
@@ -61061,2733 +60898,2738 @@
uid: azure.mgmt.qumulo.QumuloMgmtClient
name: azure.mgmt.qumulo
name: azure-mgmt-qumulo
-
- items:
- name: Overview
uid: project-azure-mgmt-rdbms
- items:
- name: Overview
- uid: azure.mgmt.rdbms.mariadb
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.mariadb.aio
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.mariadb.aio.operations
- - name: azure.mgmt.rdbms.mariadb.aio.operations.AdvisorsOperations
- uid: azure.mgmt.rdbms.mariadb.aio.operations.AdvisorsOperations
- - name: azure.mgmt.rdbms.mariadb.aio.operations.CheckNameAvailabilityOperations
- uid: azure.mgmt.rdbms.mariadb.aio.operations.CheckNameAvailabilityOperations
- - name: azure.mgmt.rdbms.mariadb.aio.operations.ConfigurationsOperations
- uid: azure.mgmt.rdbms.mariadb.aio.operations.ConfigurationsOperations
- - name: azure.mgmt.rdbms.mariadb.aio.operations.DatabasesOperations
- uid: azure.mgmt.rdbms.mariadb.aio.operations.DatabasesOperations
- - name: azure.mgmt.rdbms.mariadb.aio.operations.FirewallRulesOperations
- uid: azure.mgmt.rdbms.mariadb.aio.operations.FirewallRulesOperations
- - name: azure.mgmt.rdbms.mariadb.aio.operations.LocationBasedPerformanceTierOperations
- uid: azure.mgmt.rdbms.mariadb.aio.operations.LocationBasedPerformanceTierOperations
- - name: azure.mgmt.rdbms.mariadb.aio.operations.LocationBasedRecommendedActionSessionsOperationStatusOperations
- uid: azure.mgmt.rdbms.mariadb.aio.operations.LocationBasedRecommendedActionSessionsOperationStatusOperations
- - name: azure.mgmt.rdbms.mariadb.aio.operations.LocationBasedRecommendedActionSessionsResultOperations
- uid: azure.mgmt.rdbms.mariadb.aio.operations.LocationBasedRecommendedActionSessionsResultOperations
- - name: azure.mgmt.rdbms.mariadb.aio.operations.LogFilesOperations
- uid: azure.mgmt.rdbms.mariadb.aio.operations.LogFilesOperations
- - name: azure.mgmt.rdbms.mariadb.aio.operations.MariaDBManagementClientOperationsMixin
- uid: azure.mgmt.rdbms.mariadb.aio.operations.MariaDBManagementClientOperationsMixin
- - name: azure.mgmt.rdbms.mariadb.aio.operations.Operations
- uid: azure.mgmt.rdbms.mariadb.aio.operations.Operations
- - name: azure.mgmt.rdbms.mariadb.aio.operations.PrivateEndpointConnectionsOperations
- uid: azure.mgmt.rdbms.mariadb.aio.operations.PrivateEndpointConnectionsOperations
- - name: azure.mgmt.rdbms.mariadb.aio.operations.PrivateLinkResourcesOperations
- uid: azure.mgmt.rdbms.mariadb.aio.operations.PrivateLinkResourcesOperations
- - name: azure.mgmt.rdbms.mariadb.aio.operations.QueryTextsOperations
- uid: azure.mgmt.rdbms.mariadb.aio.operations.QueryTextsOperations
- - name: azure.mgmt.rdbms.mariadb.aio.operations.RecommendedActionsOperations
- uid: azure.mgmt.rdbms.mariadb.aio.operations.RecommendedActionsOperations
- - name: azure.mgmt.rdbms.mariadb.aio.operations.RecoverableServersOperations
- uid: azure.mgmt.rdbms.mariadb.aio.operations.RecoverableServersOperations
- - name: azure.mgmt.rdbms.mariadb.aio.operations.ReplicasOperations
- uid: azure.mgmt.rdbms.mariadb.aio.operations.ReplicasOperations
- - name: azure.mgmt.rdbms.mariadb.aio.operations.ServerBasedPerformanceTierOperations
- uid: azure.mgmt.rdbms.mariadb.aio.operations.ServerBasedPerformanceTierOperations
- - name: azure.mgmt.rdbms.mariadb.aio.operations.ServerParametersOperations
- uid: azure.mgmt.rdbms.mariadb.aio.operations.ServerParametersOperations
- - name: azure.mgmt.rdbms.mariadb.aio.operations.ServerSecurityAlertPoliciesOperations
- uid: azure.mgmt.rdbms.mariadb.aio.operations.ServerSecurityAlertPoliciesOperations
- - name: azure.mgmt.rdbms.mariadb.aio.operations.ServersOperations
- uid: azure.mgmt.rdbms.mariadb.aio.operations.ServersOperations
- - name: azure.mgmt.rdbms.mariadb.aio.operations.TopQueryStatisticsOperations
- uid: azure.mgmt.rdbms.mariadb.aio.operations.TopQueryStatisticsOperations
- - name: azure.mgmt.rdbms.mariadb.aio.operations.VirtualNetworkRulesOperations
- uid: azure.mgmt.rdbms.mariadb.aio.operations.VirtualNetworkRulesOperations
- - name: azure.mgmt.rdbms.mariadb.aio.operations.WaitStatisticsOperations
- uid: azure.mgmt.rdbms.mariadb.aio.operations.WaitStatisticsOperations
- name: azure.mgmt.rdbms.mariadb.aio.operations
- - name: azure.mgmt.rdbms.mariadb.aio.MariaDBManagementClient
- uid: azure.mgmt.rdbms.mariadb.aio.MariaDBManagementClient
- name: azure.mgmt.rdbms.mariadb.aio
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.mariadb.models
- - name: azure.mgmt.rdbms.mariadb.models.Advisor
- uid: azure.mgmt.rdbms.mariadb.models.Advisor
- - name: azure.mgmt.rdbms.mariadb.models.AdvisorsResultList
- uid: azure.mgmt.rdbms.mariadb.models.AdvisorsResultList
- - name: azure.mgmt.rdbms.mariadb.models.CloudErrorAutoGenerated
- uid: azure.mgmt.rdbms.mariadb.models.CloudErrorAutoGenerated
- - name: azure.mgmt.rdbms.mariadb.models.Configuration
- uid: azure.mgmt.rdbms.mariadb.models.Configuration
- - name: azure.mgmt.rdbms.mariadb.models.ConfigurationListResult
- uid: azure.mgmt.rdbms.mariadb.models.ConfigurationListResult
- - name: azure.mgmt.rdbms.mariadb.models.CreateMode
- uid: azure.mgmt.rdbms.mariadb.models.CreateMode
- - name: azure.mgmt.rdbms.mariadb.models.Database
- uid: azure.mgmt.rdbms.mariadb.models.Database
- - name: azure.mgmt.rdbms.mariadb.models.DatabaseListResult
- uid: azure.mgmt.rdbms.mariadb.models.DatabaseListResult
- - name: azure.mgmt.rdbms.mariadb.models.ErrorAdditionalInfo
- uid: azure.mgmt.rdbms.mariadb.models.ErrorAdditionalInfo
- - name: azure.mgmt.rdbms.mariadb.models.ErrorResponse
- uid: azure.mgmt.rdbms.mariadb.models.ErrorResponse
- - name: azure.mgmt.rdbms.mariadb.models.FirewallRule
- uid: azure.mgmt.rdbms.mariadb.models.FirewallRule
- - name: azure.mgmt.rdbms.mariadb.models.FirewallRuleListResult
- uid: azure.mgmt.rdbms.mariadb.models.FirewallRuleListResult
- - name: azure.mgmt.rdbms.mariadb.models.GeoRedundantBackup
- uid: azure.mgmt.rdbms.mariadb.models.GeoRedundantBackup
- - name: azure.mgmt.rdbms.mariadb.models.LogFile
- uid: azure.mgmt.rdbms.mariadb.models.LogFile
- - name: azure.mgmt.rdbms.mariadb.models.LogFileListResult
- uid: azure.mgmt.rdbms.mariadb.models.LogFileListResult
- - name: azure.mgmt.rdbms.mariadb.models.MinimalTlsVersionEnum
- uid: azure.mgmt.rdbms.mariadb.models.MinimalTlsVersionEnum
- - name: azure.mgmt.rdbms.mariadb.models.NameAvailability
- uid: azure.mgmt.rdbms.mariadb.models.NameAvailability
- - name: azure.mgmt.rdbms.mariadb.models.NameAvailabilityRequest
- uid: azure.mgmt.rdbms.mariadb.models.NameAvailabilityRequest
- - name: azure.mgmt.rdbms.mariadb.models.Operation
- uid: azure.mgmt.rdbms.mariadb.models.Operation
- - name: azure.mgmt.rdbms.mariadb.models.OperationDisplay
- uid: azure.mgmt.rdbms.mariadb.models.OperationDisplay
- - name: azure.mgmt.rdbms.mariadb.models.OperationListResult
- uid: azure.mgmt.rdbms.mariadb.models.OperationListResult
- - name: azure.mgmt.rdbms.mariadb.models.OperationOrigin
- uid: azure.mgmt.rdbms.mariadb.models.OperationOrigin
- - name: azure.mgmt.rdbms.mariadb.models.PerformanceTierListResult
- uid: azure.mgmt.rdbms.mariadb.models.PerformanceTierListResult
- - name: azure.mgmt.rdbms.mariadb.models.PerformanceTierProperties
- uid: azure.mgmt.rdbms.mariadb.models.PerformanceTierProperties
- - name: azure.mgmt.rdbms.mariadb.models.PerformanceTierServiceLevelObjectives
- uid: azure.mgmt.rdbms.mariadb.models.PerformanceTierServiceLevelObjectives
- - name: azure.mgmt.rdbms.mariadb.models.PrivateEndpointConnection
- uid: azure.mgmt.rdbms.mariadb.models.PrivateEndpointConnection
- - name: azure.mgmt.rdbms.mariadb.models.PrivateEndpointConnectionListResult
- uid: azure.mgmt.rdbms.mariadb.models.PrivateEndpointConnectionListResult
- - name: azure.mgmt.rdbms.mariadb.models.PrivateEndpointProperty
- uid: azure.mgmt.rdbms.mariadb.models.PrivateEndpointProperty
- - name: azure.mgmt.rdbms.mariadb.models.PrivateEndpointProvisioningState
- uid: azure.mgmt.rdbms.mariadb.models.PrivateEndpointProvisioningState
- - name: azure.mgmt.rdbms.mariadb.models.PrivateLinkResource
- uid: azure.mgmt.rdbms.mariadb.models.PrivateLinkResource
- - name: azure.mgmt.rdbms.mariadb.models.PrivateLinkResourceListResult
- uid: azure.mgmt.rdbms.mariadb.models.PrivateLinkResourceListResult
- - name: azure.mgmt.rdbms.mariadb.models.PrivateLinkResourceProperties
- uid: azure.mgmt.rdbms.mariadb.models.PrivateLinkResourceProperties
- - name: azure.mgmt.rdbms.mariadb.models.PrivateLinkServiceConnectionStateActionsRequire
- uid: azure.mgmt.rdbms.mariadb.models.PrivateLinkServiceConnectionStateActionsRequire
- - name: azure.mgmt.rdbms.mariadb.models.PrivateLinkServiceConnectionStateProperty
- uid: azure.mgmt.rdbms.mariadb.models.PrivateLinkServiceConnectionStateProperty
- - name: azure.mgmt.rdbms.mariadb.models.PrivateLinkServiceConnectionStateStatus
- uid: azure.mgmt.rdbms.mariadb.models.PrivateLinkServiceConnectionStateStatus
- - name: azure.mgmt.rdbms.mariadb.models.ProxyResource
- uid: azure.mgmt.rdbms.mariadb.models.ProxyResource
- - name: azure.mgmt.rdbms.mariadb.models.PublicNetworkAccessEnum
- uid: azure.mgmt.rdbms.mariadb.models.PublicNetworkAccessEnum
- - name: azure.mgmt.rdbms.mariadb.models.QueryPerformanceInsightResetDataResult
- uid: azure.mgmt.rdbms.mariadb.models.QueryPerformanceInsightResetDataResult
- - name: azure.mgmt.rdbms.mariadb.models.QueryPerformanceInsightResetDataResultState
- uid: azure.mgmt.rdbms.mariadb.models.QueryPerformanceInsightResetDataResultState
- - name: azure.mgmt.rdbms.mariadb.models.QueryStatistic
- uid: azure.mgmt.rdbms.mariadb.models.QueryStatistic
- - name: azure.mgmt.rdbms.mariadb.models.QueryText
- uid: azure.mgmt.rdbms.mariadb.models.QueryText
- - name: azure.mgmt.rdbms.mariadb.models.QueryTextsResultList
- uid: azure.mgmt.rdbms.mariadb.models.QueryTextsResultList
- - name: azure.mgmt.rdbms.mariadb.models.RecommendationAction
- uid: azure.mgmt.rdbms.mariadb.models.RecommendationAction
- - name: azure.mgmt.rdbms.mariadb.models.RecommendationActionsResultList
- uid: azure.mgmt.rdbms.mariadb.models.RecommendationActionsResultList
- - name: azure.mgmt.rdbms.mariadb.models.RecommendedActionSessionsOperationStatus
- uid: azure.mgmt.rdbms.mariadb.models.RecommendedActionSessionsOperationStatus
- - name: azure.mgmt.rdbms.mariadb.models.RecoverableServerResource
- uid: azure.mgmt.rdbms.mariadb.models.RecoverableServerResource
- - name: azure.mgmt.rdbms.mariadb.models.Resource
- uid: azure.mgmt.rdbms.mariadb.models.Resource
- - name: azure.mgmt.rdbms.mariadb.models.SecurityAlertPolicyName
- uid: azure.mgmt.rdbms.mariadb.models.SecurityAlertPolicyName
- - name: azure.mgmt.rdbms.mariadb.models.Server
- uid: azure.mgmt.rdbms.mariadb.models.Server
- - name: azure.mgmt.rdbms.mariadb.models.ServerForCreate
- uid: azure.mgmt.rdbms.mariadb.models.ServerForCreate
- - name: azure.mgmt.rdbms.mariadb.models.ServerListResult
- uid: azure.mgmt.rdbms.mariadb.models.ServerListResult
- - name: azure.mgmt.rdbms.mariadb.models.ServerPrivateEndpointConnection
- uid: azure.mgmt.rdbms.mariadb.models.ServerPrivateEndpointConnection
- - name: azure.mgmt.rdbms.mariadb.models.ServerPrivateEndpointConnectionProperties
- uid: azure.mgmt.rdbms.mariadb.models.ServerPrivateEndpointConnectionProperties
- - name: azure.mgmt.rdbms.mariadb.models.ServerPrivateLinkServiceConnectionStateProperty
- uid: azure.mgmt.rdbms.mariadb.models.ServerPrivateLinkServiceConnectionStateProperty
- - name: azure.mgmt.rdbms.mariadb.models.ServerPropertiesForCreate
- uid: azure.mgmt.rdbms.mariadb.models.ServerPropertiesForCreate
- - name: azure.mgmt.rdbms.mariadb.models.ServerPropertiesForDefaultCreate
- uid: azure.mgmt.rdbms.mariadb.models.ServerPropertiesForDefaultCreate
- - name: azure.mgmt.rdbms.mariadb.models.ServerPropertiesForGeoRestore
- uid: azure.mgmt.rdbms.mariadb.models.ServerPropertiesForGeoRestore
- - name: azure.mgmt.rdbms.mariadb.models.ServerPropertiesForReplica
- uid: azure.mgmt.rdbms.mariadb.models.ServerPropertiesForReplica
- - name: azure.mgmt.rdbms.mariadb.models.ServerPropertiesForRestore
- uid: azure.mgmt.rdbms.mariadb.models.ServerPropertiesForRestore
- - name: azure.mgmt.rdbms.mariadb.models.ServerSecurityAlertPolicy
- uid: azure.mgmt.rdbms.mariadb.models.ServerSecurityAlertPolicy
- - name: azure.mgmt.rdbms.mariadb.models.ServerSecurityAlertPolicyListResult
- uid: azure.mgmt.rdbms.mariadb.models.ServerSecurityAlertPolicyListResult
- - name: azure.mgmt.rdbms.mariadb.models.ServerSecurityAlertPolicyState
- uid: azure.mgmt.rdbms.mariadb.models.ServerSecurityAlertPolicyState
- - name: azure.mgmt.rdbms.mariadb.models.ServerState
- uid: azure.mgmt.rdbms.mariadb.models.ServerState
- - name: azure.mgmt.rdbms.mariadb.models.ServerUpdateParameters
- uid: azure.mgmt.rdbms.mariadb.models.ServerUpdateParameters
- - name: azure.mgmt.rdbms.mariadb.models.ServerVersion
- uid: azure.mgmt.rdbms.mariadb.models.ServerVersion
- - name: azure.mgmt.rdbms.mariadb.models.Sku
- uid: azure.mgmt.rdbms.mariadb.models.Sku
- - name: azure.mgmt.rdbms.mariadb.models.SkuTier
- uid: azure.mgmt.rdbms.mariadb.models.SkuTier
- - name: azure.mgmt.rdbms.mariadb.models.SslEnforcementEnum
- uid: azure.mgmt.rdbms.mariadb.models.SslEnforcementEnum
- - name: azure.mgmt.rdbms.mariadb.models.StorageAutogrow
- uid: azure.mgmt.rdbms.mariadb.models.StorageAutogrow
- - name: azure.mgmt.rdbms.mariadb.models.StorageProfile
- uid: azure.mgmt.rdbms.mariadb.models.StorageProfile
- - name: azure.mgmt.rdbms.mariadb.models.TagsObject
- uid: azure.mgmt.rdbms.mariadb.models.TagsObject
- - name: azure.mgmt.rdbms.mariadb.models.TopQueryStatisticsInput
- uid: azure.mgmt.rdbms.mariadb.models.TopQueryStatisticsInput
- - name: azure.mgmt.rdbms.mariadb.models.TopQueryStatisticsResultList
- uid: azure.mgmt.rdbms.mariadb.models.TopQueryStatisticsResultList
- - name: azure.mgmt.rdbms.mariadb.models.TrackedResource
- uid: azure.mgmt.rdbms.mariadb.models.TrackedResource
- - name: azure.mgmt.rdbms.mariadb.models.VirtualNetworkRule
- uid: azure.mgmt.rdbms.mariadb.models.VirtualNetworkRule
- - name: azure.mgmt.rdbms.mariadb.models.VirtualNetworkRuleListResult
- uid: azure.mgmt.rdbms.mariadb.models.VirtualNetworkRuleListResult
- - name: azure.mgmt.rdbms.mariadb.models.VirtualNetworkRuleState
- uid: azure.mgmt.rdbms.mariadb.models.VirtualNetworkRuleState
- - name: azure.mgmt.rdbms.mariadb.models.WaitStatistic
- uid: azure.mgmt.rdbms.mariadb.models.WaitStatistic
- - name: azure.mgmt.rdbms.mariadb.models.WaitStatisticsInput
- uid: azure.mgmt.rdbms.mariadb.models.WaitStatisticsInput
- - name: azure.mgmt.rdbms.mariadb.models.WaitStatisticsResultList
- uid: azure.mgmt.rdbms.mariadb.models.WaitStatisticsResultList
- name: azure.mgmt.rdbms.mariadb.models
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.mariadb.operations
- - name: azure.mgmt.rdbms.mariadb.operations.AdvisorsOperations
- uid: azure.mgmt.rdbms.mariadb.operations.AdvisorsOperations
- - name: azure.mgmt.rdbms.mariadb.operations.CheckNameAvailabilityOperations
- uid: azure.mgmt.rdbms.mariadb.operations.CheckNameAvailabilityOperations
- - name: azure.mgmt.rdbms.mariadb.operations.ConfigurationsOperations
- uid: azure.mgmt.rdbms.mariadb.operations.ConfigurationsOperations
- - name: azure.mgmt.rdbms.mariadb.operations.DatabasesOperations
- uid: azure.mgmt.rdbms.mariadb.operations.DatabasesOperations
- - name: azure.mgmt.rdbms.mariadb.operations.FirewallRulesOperations
- uid: azure.mgmt.rdbms.mariadb.operations.FirewallRulesOperations
- - name: azure.mgmt.rdbms.mariadb.operations.LocationBasedPerformanceTierOperations
- uid: azure.mgmt.rdbms.mariadb.operations.LocationBasedPerformanceTierOperations
- - name: azure.mgmt.rdbms.mariadb.operations.LocationBasedRecommendedActionSessionsOperationStatusOperations
- uid: azure.mgmt.rdbms.mariadb.operations.LocationBasedRecommendedActionSessionsOperationStatusOperations
- - name: azure.mgmt.rdbms.mariadb.operations.LocationBasedRecommendedActionSessionsResultOperations
- uid: azure.mgmt.rdbms.mariadb.operations.LocationBasedRecommendedActionSessionsResultOperations
- - name: azure.mgmt.rdbms.mariadb.operations.LogFilesOperations
- uid: azure.mgmt.rdbms.mariadb.operations.LogFilesOperations
- - name: azure.mgmt.rdbms.mariadb.operations.MariaDBManagementClientOperationsMixin
- uid: azure.mgmt.rdbms.mariadb.operations.MariaDBManagementClientOperationsMixin
- - name: azure.mgmt.rdbms.mariadb.operations.Operations
- uid: azure.mgmt.rdbms.mariadb.operations.Operations
- - name: azure.mgmt.rdbms.mariadb.operations.PrivateEndpointConnectionsOperations
- uid: azure.mgmt.rdbms.mariadb.operations.PrivateEndpointConnectionsOperations
- - name: azure.mgmt.rdbms.mariadb.operations.PrivateLinkResourcesOperations
- uid: azure.mgmt.rdbms.mariadb.operations.PrivateLinkResourcesOperations
- - name: azure.mgmt.rdbms.mariadb.operations.QueryTextsOperations
- uid: azure.mgmt.rdbms.mariadb.operations.QueryTextsOperations
- - name: azure.mgmt.rdbms.mariadb.operations.RecommendedActionsOperations
- uid: azure.mgmt.rdbms.mariadb.operations.RecommendedActionsOperations
- - name: azure.mgmt.rdbms.mariadb.operations.RecoverableServersOperations
- uid: azure.mgmt.rdbms.mariadb.operations.RecoverableServersOperations
- - name: azure.mgmt.rdbms.mariadb.operations.ReplicasOperations
- uid: azure.mgmt.rdbms.mariadb.operations.ReplicasOperations
- - name: azure.mgmt.rdbms.mariadb.operations.ServerBasedPerformanceTierOperations
- uid: azure.mgmt.rdbms.mariadb.operations.ServerBasedPerformanceTierOperations
- - name: azure.mgmt.rdbms.mariadb.operations.ServerParametersOperations
- uid: azure.mgmt.rdbms.mariadb.operations.ServerParametersOperations
- - name: azure.mgmt.rdbms.mariadb.operations.ServerSecurityAlertPoliciesOperations
- uid: azure.mgmt.rdbms.mariadb.operations.ServerSecurityAlertPoliciesOperations
- - name: azure.mgmt.rdbms.mariadb.operations.ServersOperations
- uid: azure.mgmt.rdbms.mariadb.operations.ServersOperations
- - name: azure.mgmt.rdbms.mariadb.operations.TopQueryStatisticsOperations
- uid: azure.mgmt.rdbms.mariadb.operations.TopQueryStatisticsOperations
- - name: azure.mgmt.rdbms.mariadb.operations.VirtualNetworkRulesOperations
- uid: azure.mgmt.rdbms.mariadb.operations.VirtualNetworkRulesOperations
- - name: azure.mgmt.rdbms.mariadb.operations.WaitStatisticsOperations
- uid: azure.mgmt.rdbms.mariadb.operations.WaitStatisticsOperations
- name: azure.mgmt.rdbms.mariadb.operations
- - name: azure.mgmt.rdbms.mariadb.MariaDBManagementClient
- uid: azure.mgmt.rdbms.mariadb.MariaDBManagementClient
- name: azure.mgmt.rdbms.mariadb
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.mysql
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.mysql.aio
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.mysql.aio.operations
- - name: azure.mgmt.rdbms.mysql.aio.operations.AdvisorsOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.AdvisorsOperations
- - name: azure.mgmt.rdbms.mysql.aio.operations.CheckNameAvailabilityOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.CheckNameAvailabilityOperations
- - name: azure.mgmt.rdbms.mysql.aio.operations.ConfigurationsOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.ConfigurationsOperations
- - name: azure.mgmt.rdbms.mysql.aio.operations.DatabasesOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.DatabasesOperations
- - name: azure.mgmt.rdbms.mysql.aio.operations.FirewallRulesOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.FirewallRulesOperations
- - name: azure.mgmt.rdbms.mysql.aio.operations.LocationBasedPerformanceTierOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.LocationBasedPerformanceTierOperations
- - name: azure.mgmt.rdbms.mysql.aio.operations.LocationBasedRecommendedActionSessionsOperationStatusOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.LocationBasedRecommendedActionSessionsOperationStatusOperations
- - name: azure.mgmt.rdbms.mysql.aio.operations.LocationBasedRecommendedActionSessionsResultOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.LocationBasedRecommendedActionSessionsResultOperations
- - name: azure.mgmt.rdbms.mysql.aio.operations.LogFilesOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.LogFilesOperations
- - name: azure.mgmt.rdbms.mysql.aio.operations.MySQLManagementClientOperationsMixin
- uid: azure.mgmt.rdbms.mysql.aio.operations.MySQLManagementClientOperationsMixin
- - name: azure.mgmt.rdbms.mysql.aio.operations.Operations
- uid: azure.mgmt.rdbms.mysql.aio.operations.Operations
- - name: azure.mgmt.rdbms.mysql.aio.operations.PrivateEndpointConnectionsOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.PrivateEndpointConnectionsOperations
- - name: azure.mgmt.rdbms.mysql.aio.operations.PrivateLinkResourcesOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.PrivateLinkResourcesOperations
- - name: azure.mgmt.rdbms.mysql.aio.operations.QueryTextsOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.QueryTextsOperations
- - name: azure.mgmt.rdbms.mysql.aio.operations.RecommendedActionsOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.RecommendedActionsOperations
- - name: azure.mgmt.rdbms.mysql.aio.operations.RecoverableServersOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.RecoverableServersOperations
- - name: azure.mgmt.rdbms.mysql.aio.operations.ReplicasOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.ReplicasOperations
- - name: azure.mgmt.rdbms.mysql.aio.operations.ServerAdministratorsOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.ServerAdministratorsOperations
- - name: azure.mgmt.rdbms.mysql.aio.operations.ServerBasedPerformanceTierOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.ServerBasedPerformanceTierOperations
- - name: azure.mgmt.rdbms.mysql.aio.operations.ServerKeysOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.ServerKeysOperations
- - name: azure.mgmt.rdbms.mysql.aio.operations.ServerParametersOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.ServerParametersOperations
- - name: azure.mgmt.rdbms.mysql.aio.operations.ServerSecurityAlertPoliciesOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.ServerSecurityAlertPoliciesOperations
- - name: azure.mgmt.rdbms.mysql.aio.operations.ServersOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.ServersOperations
- - name: azure.mgmt.rdbms.mysql.aio.operations.TopQueryStatisticsOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.TopQueryStatisticsOperations
- - name: azure.mgmt.rdbms.mysql.aio.operations.VirtualNetworkRulesOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.VirtualNetworkRulesOperations
- - name: azure.mgmt.rdbms.mysql.aio.operations.WaitStatisticsOperations
- uid: azure.mgmt.rdbms.mysql.aio.operations.WaitStatisticsOperations
- name: azure.mgmt.rdbms.mysql.aio.operations
- - name: azure.mgmt.rdbms.mysql.aio.MySQLManagementClient
- uid: azure.mgmt.rdbms.mysql.aio.MySQLManagementClient
- name: azure.mgmt.rdbms.mysql.aio
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.mysql.models
- - name: azure.mgmt.rdbms.mysql.models.Advisor
- uid: azure.mgmt.rdbms.mysql.models.Advisor
- - name: azure.mgmt.rdbms.mysql.models.AdvisorsResultList
- uid: azure.mgmt.rdbms.mysql.models.AdvisorsResultList
- - name: azure.mgmt.rdbms.mysql.models.CloudErrorAutoGenerated
- uid: azure.mgmt.rdbms.mysql.models.CloudErrorAutoGenerated
- - name: azure.mgmt.rdbms.mysql.models.Configuration
- uid: azure.mgmt.rdbms.mysql.models.Configuration
- - name: azure.mgmt.rdbms.mysql.models.ConfigurationListResult
- uid: azure.mgmt.rdbms.mysql.models.ConfigurationListResult
- - name: azure.mgmt.rdbms.mysql.models.CreateMode
- uid: azure.mgmt.rdbms.mysql.models.CreateMode
- - name: azure.mgmt.rdbms.mysql.models.Database
- uid: azure.mgmt.rdbms.mysql.models.Database
- - name: azure.mgmt.rdbms.mysql.models.DatabaseListResult
- uid: azure.mgmt.rdbms.mysql.models.DatabaseListResult
- - name: azure.mgmt.rdbms.mysql.models.ErrorAdditionalInfo
- uid: azure.mgmt.rdbms.mysql.models.ErrorAdditionalInfo
- - name: azure.mgmt.rdbms.mysql.models.ErrorResponse
- uid: azure.mgmt.rdbms.mysql.models.ErrorResponse
- - name: azure.mgmt.rdbms.mysql.models.FirewallRule
- uid: azure.mgmt.rdbms.mysql.models.FirewallRule
- - name: azure.mgmt.rdbms.mysql.models.FirewallRuleListResult
- uid: azure.mgmt.rdbms.mysql.models.FirewallRuleListResult
- - name: azure.mgmt.rdbms.mysql.models.GeoRedundantBackup
- uid: azure.mgmt.rdbms.mysql.models.GeoRedundantBackup
- - name: azure.mgmt.rdbms.mysql.models.IdentityType
- uid: azure.mgmt.rdbms.mysql.models.IdentityType
- - name: azure.mgmt.rdbms.mysql.models.InfrastructureEncryption
- uid: azure.mgmt.rdbms.mysql.models.InfrastructureEncryption
- - name: azure.mgmt.rdbms.mysql.models.LogFile
- uid: azure.mgmt.rdbms.mysql.models.LogFile
- - name: azure.mgmt.rdbms.mysql.models.LogFileListResult
- uid: azure.mgmt.rdbms.mysql.models.LogFileListResult
- - name: azure.mgmt.rdbms.mysql.models.MinimalTlsVersionEnum
- uid: azure.mgmt.rdbms.mysql.models.MinimalTlsVersionEnum
- - name: azure.mgmt.rdbms.mysql.models.NameAvailability
- uid: azure.mgmt.rdbms.mysql.models.NameAvailability
- - name: azure.mgmt.rdbms.mysql.models.NameAvailabilityRequest
- uid: azure.mgmt.rdbms.mysql.models.NameAvailabilityRequest
- - name: azure.mgmt.rdbms.mysql.models.Operation
- uid: azure.mgmt.rdbms.mysql.models.Operation
- - name: azure.mgmt.rdbms.mysql.models.OperationDisplay
- uid: azure.mgmt.rdbms.mysql.models.OperationDisplay
- - name: azure.mgmt.rdbms.mysql.models.OperationListResult
- uid: azure.mgmt.rdbms.mysql.models.OperationListResult
- - name: azure.mgmt.rdbms.mysql.models.OperationOrigin
- uid: azure.mgmt.rdbms.mysql.models.OperationOrigin
- - name: azure.mgmt.rdbms.mysql.models.PerformanceTierListResult
- uid: azure.mgmt.rdbms.mysql.models.PerformanceTierListResult
- - name: azure.mgmt.rdbms.mysql.models.PerformanceTierProperties
- uid: azure.mgmt.rdbms.mysql.models.PerformanceTierProperties
- - name: azure.mgmt.rdbms.mysql.models.PerformanceTierServiceLevelObjectives
- uid: azure.mgmt.rdbms.mysql.models.PerformanceTierServiceLevelObjectives
- - name: azure.mgmt.rdbms.mysql.models.PrivateEndpointConnection
- uid: azure.mgmt.rdbms.mysql.models.PrivateEndpointConnection
- - name: azure.mgmt.rdbms.mysql.models.PrivateEndpointConnectionListResult
- uid: azure.mgmt.rdbms.mysql.models.PrivateEndpointConnectionListResult
- - name: azure.mgmt.rdbms.mysql.models.PrivateEndpointProperty
- uid: azure.mgmt.rdbms.mysql.models.PrivateEndpointProperty
- - name: azure.mgmt.rdbms.mysql.models.PrivateEndpointProvisioningState
- uid: azure.mgmt.rdbms.mysql.models.PrivateEndpointProvisioningState
- - name: azure.mgmt.rdbms.mysql.models.PrivateLinkResource
- uid: azure.mgmt.rdbms.mysql.models.PrivateLinkResource
- - name: azure.mgmt.rdbms.mysql.models.PrivateLinkResourceListResult
- uid: azure.mgmt.rdbms.mysql.models.PrivateLinkResourceListResult
- - name: azure.mgmt.rdbms.mysql.models.PrivateLinkResourceProperties
- uid: azure.mgmt.rdbms.mysql.models.PrivateLinkResourceProperties
- - name: azure.mgmt.rdbms.mysql.models.PrivateLinkServiceConnectionStateActionsRequire
- uid: azure.mgmt.rdbms.mysql.models.PrivateLinkServiceConnectionStateActionsRequire
- - name: azure.mgmt.rdbms.mysql.models.PrivateLinkServiceConnectionStateProperty
- uid: azure.mgmt.rdbms.mysql.models.PrivateLinkServiceConnectionStateProperty
- - name: azure.mgmt.rdbms.mysql.models.PrivateLinkServiceConnectionStateStatus
- uid: azure.mgmt.rdbms.mysql.models.PrivateLinkServiceConnectionStateStatus
- - name: azure.mgmt.rdbms.mysql.models.ProxyResource
- uid: azure.mgmt.rdbms.mysql.models.ProxyResource
- - name: azure.mgmt.rdbms.mysql.models.PublicNetworkAccessEnum
- uid: azure.mgmt.rdbms.mysql.models.PublicNetworkAccessEnum
- - name: azure.mgmt.rdbms.mysql.models.QueryPerformanceInsightResetDataResult
- uid: azure.mgmt.rdbms.mysql.models.QueryPerformanceInsightResetDataResult
- - name: azure.mgmt.rdbms.mysql.models.QueryPerformanceInsightResetDataResultState
- uid: azure.mgmt.rdbms.mysql.models.QueryPerformanceInsightResetDataResultState
- - name: azure.mgmt.rdbms.mysql.models.QueryStatistic
- uid: azure.mgmt.rdbms.mysql.models.QueryStatistic
- - name: azure.mgmt.rdbms.mysql.models.QueryText
- uid: azure.mgmt.rdbms.mysql.models.QueryText
- - name: azure.mgmt.rdbms.mysql.models.QueryTextsResultList
- uid: azure.mgmt.rdbms.mysql.models.QueryTextsResultList
- - name: azure.mgmt.rdbms.mysql.models.RecommendationAction
- uid: azure.mgmt.rdbms.mysql.models.RecommendationAction
- - name: azure.mgmt.rdbms.mysql.models.RecommendationActionsResultList
- uid: azure.mgmt.rdbms.mysql.models.RecommendationActionsResultList
- - name: azure.mgmt.rdbms.mysql.models.RecommendedActionSessionsOperationStatus
- uid: azure.mgmt.rdbms.mysql.models.RecommendedActionSessionsOperationStatus
- - name: azure.mgmt.rdbms.mysql.models.RecoverableServerResource
- uid: azure.mgmt.rdbms.mysql.models.RecoverableServerResource
- - name: azure.mgmt.rdbms.mysql.models.Resource
- uid: azure.mgmt.rdbms.mysql.models.Resource
- - name: azure.mgmt.rdbms.mysql.models.ResourceIdentity
- uid: azure.mgmt.rdbms.mysql.models.ResourceIdentity
- - name: azure.mgmt.rdbms.mysql.models.SecurityAlertPolicyName
- uid: azure.mgmt.rdbms.mysql.models.SecurityAlertPolicyName
- - name: azure.mgmt.rdbms.mysql.models.Server
- uid: azure.mgmt.rdbms.mysql.models.Server
- - name: azure.mgmt.rdbms.mysql.models.ServerAdministratorResource
- uid: azure.mgmt.rdbms.mysql.models.ServerAdministratorResource
- - name: azure.mgmt.rdbms.mysql.models.ServerAdministratorResourceListResult
- uid: azure.mgmt.rdbms.mysql.models.ServerAdministratorResourceListResult
- - name: azure.mgmt.rdbms.mysql.models.ServerForCreate
- uid: azure.mgmt.rdbms.mysql.models.ServerForCreate
- - name: azure.mgmt.rdbms.mysql.models.ServerKey
- uid: azure.mgmt.rdbms.mysql.models.ServerKey
- - name: azure.mgmt.rdbms.mysql.models.ServerKeyListResult
- uid: azure.mgmt.rdbms.mysql.models.ServerKeyListResult
- - name: azure.mgmt.rdbms.mysql.models.ServerKeyType
- uid: azure.mgmt.rdbms.mysql.models.ServerKeyType
- - name: azure.mgmt.rdbms.mysql.models.ServerListResult
- uid: azure.mgmt.rdbms.mysql.models.ServerListResult
- - name: azure.mgmt.rdbms.mysql.models.ServerPrivateEndpointConnection
- uid: azure.mgmt.rdbms.mysql.models.ServerPrivateEndpointConnection
- - name: azure.mgmt.rdbms.mysql.models.ServerPrivateEndpointConnectionProperties
- uid: azure.mgmt.rdbms.mysql.models.ServerPrivateEndpointConnectionProperties
- - name: azure.mgmt.rdbms.mysql.models.ServerPrivateLinkServiceConnectionStateProperty
- uid: azure.mgmt.rdbms.mysql.models.ServerPrivateLinkServiceConnectionStateProperty
- - name: azure.mgmt.rdbms.mysql.models.ServerPropertiesForCreate
- uid: azure.mgmt.rdbms.mysql.models.ServerPropertiesForCreate
- - name: azure.mgmt.rdbms.mysql.models.ServerPropertiesForDefaultCreate
- uid: azure.mgmt.rdbms.mysql.models.ServerPropertiesForDefaultCreate
- - name: azure.mgmt.rdbms.mysql.models.ServerPropertiesForGeoRestore
- uid: azure.mgmt.rdbms.mysql.models.ServerPropertiesForGeoRestore
- - name: azure.mgmt.rdbms.mysql.models.ServerPropertiesForReplica
- uid: azure.mgmt.rdbms.mysql.models.ServerPropertiesForReplica
- - name: azure.mgmt.rdbms.mysql.models.ServerPropertiesForRestore
- uid: azure.mgmt.rdbms.mysql.models.ServerPropertiesForRestore
- - name: azure.mgmt.rdbms.mysql.models.ServerSecurityAlertPolicy
- uid: azure.mgmt.rdbms.mysql.models.ServerSecurityAlertPolicy
- - name: azure.mgmt.rdbms.mysql.models.ServerSecurityAlertPolicyListResult
- uid: azure.mgmt.rdbms.mysql.models.ServerSecurityAlertPolicyListResult
- - name: azure.mgmt.rdbms.mysql.models.ServerSecurityAlertPolicyState
- uid: azure.mgmt.rdbms.mysql.models.ServerSecurityAlertPolicyState
- - name: azure.mgmt.rdbms.mysql.models.ServerState
- uid: azure.mgmt.rdbms.mysql.models.ServerState
- - name: azure.mgmt.rdbms.mysql.models.ServerUpdateParameters
- uid: azure.mgmt.rdbms.mysql.models.ServerUpdateParameters
- - name: azure.mgmt.rdbms.mysql.models.ServerUpgradeParameters
- uid: azure.mgmt.rdbms.mysql.models.ServerUpgradeParameters
- - name: azure.mgmt.rdbms.mysql.models.ServerVersion
- uid: azure.mgmt.rdbms.mysql.models.ServerVersion
- - name: azure.mgmt.rdbms.mysql.models.Sku
- uid: azure.mgmt.rdbms.mysql.models.Sku
- - name: azure.mgmt.rdbms.mysql.models.SkuTier
- uid: azure.mgmt.rdbms.mysql.models.SkuTier
- - name: azure.mgmt.rdbms.mysql.models.SslEnforcementEnum
- uid: azure.mgmt.rdbms.mysql.models.SslEnforcementEnum
- - name: azure.mgmt.rdbms.mysql.models.StorageAutogrow
- uid: azure.mgmt.rdbms.mysql.models.StorageAutogrow
- - name: azure.mgmt.rdbms.mysql.models.StorageProfile
- uid: azure.mgmt.rdbms.mysql.models.StorageProfile
- - name: azure.mgmt.rdbms.mysql.models.TagsObject
- uid: azure.mgmt.rdbms.mysql.models.TagsObject
- - name: azure.mgmt.rdbms.mysql.models.TopQueryStatisticsInput
- uid: azure.mgmt.rdbms.mysql.models.TopQueryStatisticsInput
- - name: azure.mgmt.rdbms.mysql.models.TopQueryStatisticsResultList
- uid: azure.mgmt.rdbms.mysql.models.TopQueryStatisticsResultList
- - name: azure.mgmt.rdbms.mysql.models.TrackedResource
- uid: azure.mgmt.rdbms.mysql.models.TrackedResource
- - name: azure.mgmt.rdbms.mysql.models.VirtualNetworkRule
- uid: azure.mgmt.rdbms.mysql.models.VirtualNetworkRule
- - name: azure.mgmt.rdbms.mysql.models.VirtualNetworkRuleListResult
- uid: azure.mgmt.rdbms.mysql.models.VirtualNetworkRuleListResult
- - name: azure.mgmt.rdbms.mysql.models.VirtualNetworkRuleState
- uid: azure.mgmt.rdbms.mysql.models.VirtualNetworkRuleState
- - name: azure.mgmt.rdbms.mysql.models.WaitStatistic
- uid: azure.mgmt.rdbms.mysql.models.WaitStatistic
- - name: azure.mgmt.rdbms.mysql.models.WaitStatisticsInput
- uid: azure.mgmt.rdbms.mysql.models.WaitStatisticsInput
- - name: azure.mgmt.rdbms.mysql.models.WaitStatisticsResultList
- uid: azure.mgmt.rdbms.mysql.models.WaitStatisticsResultList
- name: azure.mgmt.rdbms.mysql.models
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.mysql.operations
- - name: azure.mgmt.rdbms.mysql.operations.AdvisorsOperations
- uid: azure.mgmt.rdbms.mysql.operations.AdvisorsOperations
- - name: azure.mgmt.rdbms.mysql.operations.CheckNameAvailabilityOperations
- uid: azure.mgmt.rdbms.mysql.operations.CheckNameAvailabilityOperations
- - name: azure.mgmt.rdbms.mysql.operations.ConfigurationsOperations
- uid: azure.mgmt.rdbms.mysql.operations.ConfigurationsOperations
- - name: azure.mgmt.rdbms.mysql.operations.DatabasesOperations
- uid: azure.mgmt.rdbms.mysql.operations.DatabasesOperations
- - name: azure.mgmt.rdbms.mysql.operations.FirewallRulesOperations
- uid: azure.mgmt.rdbms.mysql.operations.FirewallRulesOperations
- - name: azure.mgmt.rdbms.mysql.operations.LocationBasedPerformanceTierOperations
- uid: azure.mgmt.rdbms.mysql.operations.LocationBasedPerformanceTierOperations
- - name: azure.mgmt.rdbms.mysql.operations.LocationBasedRecommendedActionSessionsOperationStatusOperations
- uid: azure.mgmt.rdbms.mysql.operations.LocationBasedRecommendedActionSessionsOperationStatusOperations
- - name: azure.mgmt.rdbms.mysql.operations.LocationBasedRecommendedActionSessionsResultOperations
- uid: azure.mgmt.rdbms.mysql.operations.LocationBasedRecommendedActionSessionsResultOperations
- - name: azure.mgmt.rdbms.mysql.operations.LogFilesOperations
- uid: azure.mgmt.rdbms.mysql.operations.LogFilesOperations
- - name: azure.mgmt.rdbms.mysql.operations.MySQLManagementClientOperationsMixin
- uid: azure.mgmt.rdbms.mysql.operations.MySQLManagementClientOperationsMixin
- - name: azure.mgmt.rdbms.mysql.operations.Operations
- uid: azure.mgmt.rdbms.mysql.operations.Operations
- - name: azure.mgmt.rdbms.mysql.operations.PrivateEndpointConnectionsOperations
- uid: azure.mgmt.rdbms.mysql.operations.PrivateEndpointConnectionsOperations
- - name: azure.mgmt.rdbms.mysql.operations.PrivateLinkResourcesOperations
- uid: azure.mgmt.rdbms.mysql.operations.PrivateLinkResourcesOperations
- - name: azure.mgmt.rdbms.mysql.operations.QueryTextsOperations
- uid: azure.mgmt.rdbms.mysql.operations.QueryTextsOperations
- - name: azure.mgmt.rdbms.mysql.operations.RecommendedActionsOperations
- uid: azure.mgmt.rdbms.mysql.operations.RecommendedActionsOperations
- - name: azure.mgmt.rdbms.mysql.operations.RecoverableServersOperations
- uid: azure.mgmt.rdbms.mysql.operations.RecoverableServersOperations
- - name: azure.mgmt.rdbms.mysql.operations.ReplicasOperations
- uid: azure.mgmt.rdbms.mysql.operations.ReplicasOperations
- - name: azure.mgmt.rdbms.mysql.operations.ServerAdministratorsOperations
- uid: azure.mgmt.rdbms.mysql.operations.ServerAdministratorsOperations
- - name: azure.mgmt.rdbms.mysql.operations.ServerBasedPerformanceTierOperations
- uid: azure.mgmt.rdbms.mysql.operations.ServerBasedPerformanceTierOperations
- - name: azure.mgmt.rdbms.mysql.operations.ServerKeysOperations
- uid: azure.mgmt.rdbms.mysql.operations.ServerKeysOperations
- - name: azure.mgmt.rdbms.mysql.operations.ServerParametersOperations
- uid: azure.mgmt.rdbms.mysql.operations.ServerParametersOperations
- - name: azure.mgmt.rdbms.mysql.operations.ServerSecurityAlertPoliciesOperations
- uid: azure.mgmt.rdbms.mysql.operations.ServerSecurityAlertPoliciesOperations
- - name: azure.mgmt.rdbms.mysql.operations.ServersOperations
- uid: azure.mgmt.rdbms.mysql.operations.ServersOperations
- - name: azure.mgmt.rdbms.mysql.operations.TopQueryStatisticsOperations
- uid: azure.mgmt.rdbms.mysql.operations.TopQueryStatisticsOperations
- - name: azure.mgmt.rdbms.mysql.operations.VirtualNetworkRulesOperations
- uid: azure.mgmt.rdbms.mysql.operations.VirtualNetworkRulesOperations
- - name: azure.mgmt.rdbms.mysql.operations.WaitStatisticsOperations
- uid: azure.mgmt.rdbms.mysql.operations.WaitStatisticsOperations
- name: azure.mgmt.rdbms.mysql.operations
- - name: azure.mgmt.rdbms.mysql.MySQLManagementClient
- uid: azure.mgmt.rdbms.mysql.MySQLManagementClient
- name: azure.mgmt.rdbms.mysql
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.mysql_flexibleservers
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.mysql_flexibleservers.aio
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.AzureADAdministratorsOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.AzureADAdministratorsOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.BackupAndExportOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.BackupAndExportOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.BackupsOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.BackupsOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.CheckNameAvailabilityOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.CheckNameAvailabilityOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.CheckNameAvailabilityWithoutLocationOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.CheckNameAvailabilityWithoutLocationOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.CheckVirtualNetworkSubnetUsageOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.CheckVirtualNetworkSubnetUsageOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.ConfigurationsOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.ConfigurationsOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.DatabasesOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.DatabasesOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.FirewallRulesOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.FirewallRulesOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.GetPrivateDnsZoneSuffixOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.GetPrivateDnsZoneSuffixOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.LocationBasedCapabilitiesOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.LocationBasedCapabilitiesOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.LogFilesOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.LogFilesOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.Operations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.Operations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.ReplicasOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.ReplicasOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.ServersOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.ServersOperations
- name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.MySQLManagementClient
- uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.MySQLManagementClient
- name: azure.mgmt.rdbms.mysql_flexibleservers.aio
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.AdministratorListResult
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.AdministratorListResult
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.AdministratorName
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.AdministratorName
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.AdministratorType
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.AdministratorType
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.AzureADAdministrator
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.AzureADAdministrator
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.Backup
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.Backup
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupAndExportRequest
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupAndExportRequest
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupAndExportResponse
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupAndExportResponse
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupFormat
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupFormat
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupRequestBase
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupRequestBase
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupSettings
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupSettings
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupStoreDetails
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupStoreDetails
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.CapabilitiesListResult
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.CapabilitiesListResult
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.CapabilityProperties
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.CapabilityProperties
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.Configuration
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.Configuration
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ConfigurationForBatchUpdate
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ConfigurationForBatchUpdate
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ConfigurationListForBatchUpdate
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ConfigurationListForBatchUpdate
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ConfigurationListResult
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ConfigurationListResult
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ConfigurationSource
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ConfigurationSource
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.CreateMode
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.CreateMode
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.CreatedByType
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.CreatedByType
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.DataEncryption
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.DataEncryption
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.DataEncryptionType
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.DataEncryptionType
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.Database
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.Database
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.DatabaseListResult
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.DatabaseListResult
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.DelegatedSubnetUsage
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.DelegatedSubnetUsage
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.EnableStatusEnum
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.EnableStatusEnum
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ErrorAdditionalInfo
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ErrorAdditionalInfo
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ErrorResponse
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ErrorResponse
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.FirewallRule
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.FirewallRule
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.FirewallRuleListResult
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.FirewallRuleListResult
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.FullBackupStoreDetails
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.FullBackupStoreDetails
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.GetPrivateDnsZoneSuffixResponse
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.GetPrivateDnsZoneSuffixResponse
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.HighAvailability
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.HighAvailability
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.HighAvailabilityMode
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.HighAvailabilityMode
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.HighAvailabilityState
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.HighAvailabilityState
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.Identity
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.Identity
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.IsConfigPendingRestart
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.IsConfigPendingRestart
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.IsDynamicConfig
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.IsDynamicConfig
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.IsReadOnly
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.IsReadOnly
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.LogFile
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.LogFile
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.LogFileListResult
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.LogFileListResult
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.MaintenanceWindow
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.MaintenanceWindow
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ManagedServiceIdentityType
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ManagedServiceIdentityType
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.NameAvailability
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.NameAvailability
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.NameAvailabilityRequest
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.NameAvailabilityRequest
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.Network
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.Network
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.Operation
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.Operation
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.OperationDisplay
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.OperationDisplay
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.OperationListResult
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.OperationListResult
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.OperationStatus
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.OperationStatus
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ProxyResource
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ProxyResource
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ReplicationRole
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ReplicationRole
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ResetAllToDefault
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ResetAllToDefault
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.Resource
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.Resource
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.Server
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.Server
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerBackup
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerBackup
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerBackupListResult
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerBackupListResult
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerEditionCapability
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerEditionCapability
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerForUpdate
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerForUpdate
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerGtidSetParameter
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerGtidSetParameter
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerListResult
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerListResult
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerRestartParameter
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerRestartParameter
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerState
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerState
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerVersion
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerVersion
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerVersionCapability
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerVersionCapability
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.Sku
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.Sku
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.SkuCapability
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.SkuCapability
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.SkuTier
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.SkuTier
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.Storage
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.Storage
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.StorageEditionCapability
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.StorageEditionCapability
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.SystemData
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.SystemData
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.TrackedResource
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.TrackedResource
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.UserAssignedIdentity
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.UserAssignedIdentity
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ValidateBackupResponse
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ValidateBackupResponse
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.VirtualNetworkSubnetUsageParameter
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.VirtualNetworkSubnetUsageParameter
- - name: azure.mgmt.rdbms.mysql_flexibleservers.models.VirtualNetworkSubnetUsageResult
- uid: azure.mgmt.rdbms.mysql_flexibleservers.models.VirtualNetworkSubnetUsageResult
- name: azure.mgmt.rdbms.mysql_flexibleservers.models
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.mysql_flexibleservers.operations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.AzureADAdministratorsOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.AzureADAdministratorsOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.BackupAndExportOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.BackupAndExportOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.BackupsOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.BackupsOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.CheckNameAvailabilityOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.CheckNameAvailabilityOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.CheckNameAvailabilityWithoutLocationOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.CheckNameAvailabilityWithoutLocationOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.CheckVirtualNetworkSubnetUsageOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.CheckVirtualNetworkSubnetUsageOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.ConfigurationsOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.ConfigurationsOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.DatabasesOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.DatabasesOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.FirewallRulesOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.FirewallRulesOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.GetPrivateDnsZoneSuffixOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.GetPrivateDnsZoneSuffixOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.LocationBasedCapabilitiesOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.LocationBasedCapabilitiesOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.LogFilesOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.LogFilesOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.Operations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.Operations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.ReplicasOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.ReplicasOperations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.ServersOperations
- uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.ServersOperations
- name: azure.mgmt.rdbms.mysql_flexibleservers.operations
- - name: azure.mgmt.rdbms.mysql_flexibleservers.MySQLManagementClient
- uid: azure.mgmt.rdbms.mysql_flexibleservers.MySQLManagementClient
- name: azure.mgmt.rdbms.mysql_flexibleservers
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.postgresql
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.postgresql.aio
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.postgresql.aio.operations
- - name: azure.mgmt.rdbms.postgresql.aio.operations.CheckNameAvailabilityOperations
- uid: azure.mgmt.rdbms.postgresql.aio.operations.CheckNameAvailabilityOperations
- - name: azure.mgmt.rdbms.postgresql.aio.operations.ConfigurationsOperations
- uid: azure.mgmt.rdbms.postgresql.aio.operations.ConfigurationsOperations
- - name: azure.mgmt.rdbms.postgresql.aio.operations.DatabasesOperations
- uid: azure.mgmt.rdbms.postgresql.aio.operations.DatabasesOperations
- - name: azure.mgmt.rdbms.postgresql.aio.operations.FirewallRulesOperations
- uid: azure.mgmt.rdbms.postgresql.aio.operations.FirewallRulesOperations
- - name: azure.mgmt.rdbms.postgresql.aio.operations.LocationBasedPerformanceTierOperations
- uid: azure.mgmt.rdbms.postgresql.aio.operations.LocationBasedPerformanceTierOperations
- - name: azure.mgmt.rdbms.postgresql.aio.operations.LogFilesOperations
- uid: azure.mgmt.rdbms.postgresql.aio.operations.LogFilesOperations
- - name: azure.mgmt.rdbms.postgresql.aio.operations.Operations
- uid: azure.mgmt.rdbms.postgresql.aio.operations.Operations
- - name: azure.mgmt.rdbms.postgresql.aio.operations.PrivateEndpointConnectionsOperations
- uid: azure.mgmt.rdbms.postgresql.aio.operations.PrivateEndpointConnectionsOperations
- - name: azure.mgmt.rdbms.postgresql.aio.operations.PrivateLinkResourcesOperations
- uid: azure.mgmt.rdbms.postgresql.aio.operations.PrivateLinkResourcesOperations
- - name: azure.mgmt.rdbms.postgresql.aio.operations.RecoverableServersOperations
- uid: azure.mgmt.rdbms.postgresql.aio.operations.RecoverableServersOperations
- - name: azure.mgmt.rdbms.postgresql.aio.operations.ReplicasOperations
- uid: azure.mgmt.rdbms.postgresql.aio.operations.ReplicasOperations
- - name: azure.mgmt.rdbms.postgresql.aio.operations.ServerAdministratorsOperations
- uid: azure.mgmt.rdbms.postgresql.aio.operations.ServerAdministratorsOperations
- - name: azure.mgmt.rdbms.postgresql.aio.operations.ServerBasedPerformanceTierOperations
- uid: azure.mgmt.rdbms.postgresql.aio.operations.ServerBasedPerformanceTierOperations
- - name: azure.mgmt.rdbms.postgresql.aio.operations.ServerKeysOperations
- uid: azure.mgmt.rdbms.postgresql.aio.operations.ServerKeysOperations
- - name: azure.mgmt.rdbms.postgresql.aio.operations.ServerParametersOperations
- uid: azure.mgmt.rdbms.postgresql.aio.operations.ServerParametersOperations
- - name: azure.mgmt.rdbms.postgresql.aio.operations.ServerSecurityAlertPoliciesOperations
- uid: azure.mgmt.rdbms.postgresql.aio.operations.ServerSecurityAlertPoliciesOperations
- - name: azure.mgmt.rdbms.postgresql.aio.operations.ServersOperations
- uid: azure.mgmt.rdbms.postgresql.aio.operations.ServersOperations
- - name: azure.mgmt.rdbms.postgresql.aio.operations.VirtualNetworkRulesOperations
- uid: azure.mgmt.rdbms.postgresql.aio.operations.VirtualNetworkRulesOperations
- name: azure.mgmt.rdbms.postgresql.aio.operations
- - name: azure.mgmt.rdbms.postgresql.aio.PostgreSQLManagementClient
- uid: azure.mgmt.rdbms.postgresql.aio.PostgreSQLManagementClient
- name: azure.mgmt.rdbms.postgresql.aio
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.postgresql.models
- - name: azure.mgmt.rdbms.postgresql.models.Configuration
- uid: azure.mgmt.rdbms.postgresql.models.Configuration
- - name: azure.mgmt.rdbms.postgresql.models.ConfigurationListResult
- uid: azure.mgmt.rdbms.postgresql.models.ConfigurationListResult
- - name: azure.mgmt.rdbms.postgresql.models.CreateMode
- uid: azure.mgmt.rdbms.postgresql.models.CreateMode
- - name: azure.mgmt.rdbms.postgresql.models.Database
- uid: azure.mgmt.rdbms.postgresql.models.Database
- - name: azure.mgmt.rdbms.postgresql.models.DatabaseListResult
- uid: azure.mgmt.rdbms.postgresql.models.DatabaseListResult
- - name: azure.mgmt.rdbms.postgresql.models.ErrorAdditionalInfo
- uid: azure.mgmt.rdbms.postgresql.models.ErrorAdditionalInfo
- - name: azure.mgmt.rdbms.postgresql.models.ErrorResponse
- uid: azure.mgmt.rdbms.postgresql.models.ErrorResponse
- - name: azure.mgmt.rdbms.postgresql.models.FirewallRule
- uid: azure.mgmt.rdbms.postgresql.models.FirewallRule
- - name: azure.mgmt.rdbms.postgresql.models.FirewallRuleListResult
- uid: azure.mgmt.rdbms.postgresql.models.FirewallRuleListResult
- - name: azure.mgmt.rdbms.postgresql.models.GeoRedundantBackup
- uid: azure.mgmt.rdbms.postgresql.models.GeoRedundantBackup
- - name: azure.mgmt.rdbms.postgresql.models.IdentityType
- uid: azure.mgmt.rdbms.postgresql.models.IdentityType
- - name: azure.mgmt.rdbms.postgresql.models.InfrastructureEncryption
- uid: azure.mgmt.rdbms.postgresql.models.InfrastructureEncryption
- - name: azure.mgmt.rdbms.postgresql.models.LogFile
- uid: azure.mgmt.rdbms.postgresql.models.LogFile
- - name: azure.mgmt.rdbms.postgresql.models.LogFileListResult
- uid: azure.mgmt.rdbms.postgresql.models.LogFileListResult
- - name: azure.mgmt.rdbms.postgresql.models.MinimalTlsVersionEnum
- uid: azure.mgmt.rdbms.postgresql.models.MinimalTlsVersionEnum
- - name: azure.mgmt.rdbms.postgresql.models.NameAvailability
- uid: azure.mgmt.rdbms.postgresql.models.NameAvailability
- - name: azure.mgmt.rdbms.postgresql.models.NameAvailabilityRequest
- uid: azure.mgmt.rdbms.postgresql.models.NameAvailabilityRequest
- - name: azure.mgmt.rdbms.postgresql.models.Operation
- uid: azure.mgmt.rdbms.postgresql.models.Operation
- - name: azure.mgmt.rdbms.postgresql.models.OperationDisplay
- uid: azure.mgmt.rdbms.postgresql.models.OperationDisplay
- - name: azure.mgmt.rdbms.postgresql.models.OperationListResult
- uid: azure.mgmt.rdbms.postgresql.models.OperationListResult
- - name: azure.mgmt.rdbms.postgresql.models.OperationOrigin
- uid: azure.mgmt.rdbms.postgresql.models.OperationOrigin
- - name: azure.mgmt.rdbms.postgresql.models.PerformanceTierListResult
- uid: azure.mgmt.rdbms.postgresql.models.PerformanceTierListResult
- - name: azure.mgmt.rdbms.postgresql.models.PerformanceTierProperties
- uid: azure.mgmt.rdbms.postgresql.models.PerformanceTierProperties
- - name: azure.mgmt.rdbms.postgresql.models.PerformanceTierServiceLevelObjectives
- uid: azure.mgmt.rdbms.postgresql.models.PerformanceTierServiceLevelObjectives
- - name: azure.mgmt.rdbms.postgresql.models.PrivateEndpointConnection
- uid: azure.mgmt.rdbms.postgresql.models.PrivateEndpointConnection
- - name: azure.mgmt.rdbms.postgresql.models.PrivateEndpointConnectionListResult
- uid: azure.mgmt.rdbms.postgresql.models.PrivateEndpointConnectionListResult
- - name: azure.mgmt.rdbms.postgresql.models.PrivateEndpointProperty
- uid: azure.mgmt.rdbms.postgresql.models.PrivateEndpointProperty
- - name: azure.mgmt.rdbms.postgresql.models.PrivateEndpointProvisioningState
- uid: azure.mgmt.rdbms.postgresql.models.PrivateEndpointProvisioningState
- - name: azure.mgmt.rdbms.postgresql.models.PrivateLinkResource
- uid: azure.mgmt.rdbms.postgresql.models.PrivateLinkResource
- - name: azure.mgmt.rdbms.postgresql.models.PrivateLinkResourceListResult
- uid: azure.mgmt.rdbms.postgresql.models.PrivateLinkResourceListResult
- - name: azure.mgmt.rdbms.postgresql.models.PrivateLinkResourceProperties
- uid: azure.mgmt.rdbms.postgresql.models.PrivateLinkResourceProperties
- - name: azure.mgmt.rdbms.postgresql.models.PrivateLinkServiceConnectionStateActionsRequire
- uid: azure.mgmt.rdbms.postgresql.models.PrivateLinkServiceConnectionStateActionsRequire
- - name: azure.mgmt.rdbms.postgresql.models.PrivateLinkServiceConnectionStateProperty
- uid: azure.mgmt.rdbms.postgresql.models.PrivateLinkServiceConnectionStateProperty
- - name: azure.mgmt.rdbms.postgresql.models.PrivateLinkServiceConnectionStateStatus
- uid: azure.mgmt.rdbms.postgresql.models.PrivateLinkServiceConnectionStateStatus
- - name: azure.mgmt.rdbms.postgresql.models.ProxyResource
- uid: azure.mgmt.rdbms.postgresql.models.ProxyResource
- - name: azure.mgmt.rdbms.postgresql.models.PublicNetworkAccessEnum
- uid: azure.mgmt.rdbms.postgresql.models.PublicNetworkAccessEnum
- - name: azure.mgmt.rdbms.postgresql.models.RecoverableServerResource
- uid: azure.mgmt.rdbms.postgresql.models.RecoverableServerResource
- - name: azure.mgmt.rdbms.postgresql.models.Resource
- uid: azure.mgmt.rdbms.postgresql.models.Resource
- - name: azure.mgmt.rdbms.postgresql.models.ResourceIdentity
- uid: azure.mgmt.rdbms.postgresql.models.ResourceIdentity
- - name: azure.mgmt.rdbms.postgresql.models.SecurityAlertPolicyName
- uid: azure.mgmt.rdbms.postgresql.models.SecurityAlertPolicyName
- - name: azure.mgmt.rdbms.postgresql.models.Server
- uid: azure.mgmt.rdbms.postgresql.models.Server
- - name: azure.mgmt.rdbms.postgresql.models.ServerAdministratorResource
- uid: azure.mgmt.rdbms.postgresql.models.ServerAdministratorResource
- - name: azure.mgmt.rdbms.postgresql.models.ServerAdministratorResourceListResult
- uid: azure.mgmt.rdbms.postgresql.models.ServerAdministratorResourceListResult
- - name: azure.mgmt.rdbms.postgresql.models.ServerForCreate
- uid: azure.mgmt.rdbms.postgresql.models.ServerForCreate
- - name: azure.mgmt.rdbms.postgresql.models.ServerKey
- uid: azure.mgmt.rdbms.postgresql.models.ServerKey
- - name: azure.mgmt.rdbms.postgresql.models.ServerKeyListResult
- uid: azure.mgmt.rdbms.postgresql.models.ServerKeyListResult
- - name: azure.mgmt.rdbms.postgresql.models.ServerKeyType
- uid: azure.mgmt.rdbms.postgresql.models.ServerKeyType
- - name: azure.mgmt.rdbms.postgresql.models.ServerListResult
- uid: azure.mgmt.rdbms.postgresql.models.ServerListResult
- - name: azure.mgmt.rdbms.postgresql.models.ServerPrivateEndpointConnection
- uid: azure.mgmt.rdbms.postgresql.models.ServerPrivateEndpointConnection
- - name: azure.mgmt.rdbms.postgresql.models.ServerPrivateEndpointConnectionProperties
- uid: azure.mgmt.rdbms.postgresql.models.ServerPrivateEndpointConnectionProperties
- - name: azure.mgmt.rdbms.postgresql.models.ServerPrivateLinkServiceConnectionStateProperty
- uid: azure.mgmt.rdbms.postgresql.models.ServerPrivateLinkServiceConnectionStateProperty
- - name: azure.mgmt.rdbms.postgresql.models.ServerPropertiesForCreate
- uid: azure.mgmt.rdbms.postgresql.models.ServerPropertiesForCreate
- - name: azure.mgmt.rdbms.postgresql.models.ServerPropertiesForDefaultCreate
- uid: azure.mgmt.rdbms.postgresql.models.ServerPropertiesForDefaultCreate
- - name: azure.mgmt.rdbms.postgresql.models.ServerPropertiesForGeoRestore
- uid: azure.mgmt.rdbms.postgresql.models.ServerPropertiesForGeoRestore
- - name: azure.mgmt.rdbms.postgresql.models.ServerPropertiesForReplica
- uid: azure.mgmt.rdbms.postgresql.models.ServerPropertiesForReplica
- - name: azure.mgmt.rdbms.postgresql.models.ServerPropertiesForRestore
- uid: azure.mgmt.rdbms.postgresql.models.ServerPropertiesForRestore
- - name: azure.mgmt.rdbms.postgresql.models.ServerSecurityAlertPolicy
- uid: azure.mgmt.rdbms.postgresql.models.ServerSecurityAlertPolicy
- - name: azure.mgmt.rdbms.postgresql.models.ServerSecurityAlertPolicyListResult
- uid: azure.mgmt.rdbms.postgresql.models.ServerSecurityAlertPolicyListResult
- - name: azure.mgmt.rdbms.postgresql.models.ServerSecurityAlertPolicyState
- uid: azure.mgmt.rdbms.postgresql.models.ServerSecurityAlertPolicyState
- - name: azure.mgmt.rdbms.postgresql.models.ServerState
- uid: azure.mgmt.rdbms.postgresql.models.ServerState
- - name: azure.mgmt.rdbms.postgresql.models.ServerUpdateParameters
- uid: azure.mgmt.rdbms.postgresql.models.ServerUpdateParameters
- - name: azure.mgmt.rdbms.postgresql.models.ServerVersion
- uid: azure.mgmt.rdbms.postgresql.models.ServerVersion
- - name: azure.mgmt.rdbms.postgresql.models.Sku
- uid: azure.mgmt.rdbms.postgresql.models.Sku
- - name: azure.mgmt.rdbms.postgresql.models.SkuTier
- uid: azure.mgmt.rdbms.postgresql.models.SkuTier
- - name: azure.mgmt.rdbms.postgresql.models.SslEnforcementEnum
- uid: azure.mgmt.rdbms.postgresql.models.SslEnforcementEnum
- - name: azure.mgmt.rdbms.postgresql.models.StorageAutogrow
- uid: azure.mgmt.rdbms.postgresql.models.StorageAutogrow
- - name: azure.mgmt.rdbms.postgresql.models.StorageProfile
- uid: azure.mgmt.rdbms.postgresql.models.StorageProfile
- - name: azure.mgmt.rdbms.postgresql.models.TagsObject
- uid: azure.mgmt.rdbms.postgresql.models.TagsObject
- - name: azure.mgmt.rdbms.postgresql.models.TrackedResource
- uid: azure.mgmt.rdbms.postgresql.models.TrackedResource
- - name: azure.mgmt.rdbms.postgresql.models.VirtualNetworkRule
- uid: azure.mgmt.rdbms.postgresql.models.VirtualNetworkRule
- - name: azure.mgmt.rdbms.postgresql.models.VirtualNetworkRuleListResult
- uid: azure.mgmt.rdbms.postgresql.models.VirtualNetworkRuleListResult
- - name: azure.mgmt.rdbms.postgresql.models.VirtualNetworkRuleState
- uid: azure.mgmt.rdbms.postgresql.models.VirtualNetworkRuleState
- name: azure.mgmt.rdbms.postgresql.models
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.postgresql.operations
- - name: azure.mgmt.rdbms.postgresql.operations.CheckNameAvailabilityOperations
- uid: azure.mgmt.rdbms.postgresql.operations.CheckNameAvailabilityOperations
- - name: azure.mgmt.rdbms.postgresql.operations.ConfigurationsOperations
- uid: azure.mgmt.rdbms.postgresql.operations.ConfigurationsOperations
- - name: azure.mgmt.rdbms.postgresql.operations.DatabasesOperations
- uid: azure.mgmt.rdbms.postgresql.operations.DatabasesOperations
- - name: azure.mgmt.rdbms.postgresql.operations.FirewallRulesOperations
- uid: azure.mgmt.rdbms.postgresql.operations.FirewallRulesOperations
- - name: azure.mgmt.rdbms.postgresql.operations.LocationBasedPerformanceTierOperations
- uid: azure.mgmt.rdbms.postgresql.operations.LocationBasedPerformanceTierOperations
- - name: azure.mgmt.rdbms.postgresql.operations.LogFilesOperations
- uid: azure.mgmt.rdbms.postgresql.operations.LogFilesOperations
- - name: azure.mgmt.rdbms.postgresql.operations.Operations
- uid: azure.mgmt.rdbms.postgresql.operations.Operations
- - name: azure.mgmt.rdbms.postgresql.operations.PrivateEndpointConnectionsOperations
- uid: azure.mgmt.rdbms.postgresql.operations.PrivateEndpointConnectionsOperations
- - name: azure.mgmt.rdbms.postgresql.operations.PrivateLinkResourcesOperations
- uid: azure.mgmt.rdbms.postgresql.operations.PrivateLinkResourcesOperations
- - name: azure.mgmt.rdbms.postgresql.operations.RecoverableServersOperations
- uid: azure.mgmt.rdbms.postgresql.operations.RecoverableServersOperations
- - name: azure.mgmt.rdbms.postgresql.operations.ReplicasOperations
- uid: azure.mgmt.rdbms.postgresql.operations.ReplicasOperations
- - name: azure.mgmt.rdbms.postgresql.operations.ServerAdministratorsOperations
- uid: azure.mgmt.rdbms.postgresql.operations.ServerAdministratorsOperations
- - name: azure.mgmt.rdbms.postgresql.operations.ServerBasedPerformanceTierOperations
- uid: azure.mgmt.rdbms.postgresql.operations.ServerBasedPerformanceTierOperations
- - name: azure.mgmt.rdbms.postgresql.operations.ServerKeysOperations
- uid: azure.mgmt.rdbms.postgresql.operations.ServerKeysOperations
- - name: azure.mgmt.rdbms.postgresql.operations.ServerParametersOperations
- uid: azure.mgmt.rdbms.postgresql.operations.ServerParametersOperations
- - name: azure.mgmt.rdbms.postgresql.operations.ServerSecurityAlertPoliciesOperations
- uid: azure.mgmt.rdbms.postgresql.operations.ServerSecurityAlertPoliciesOperations
- - name: azure.mgmt.rdbms.postgresql.operations.ServersOperations
- uid: azure.mgmt.rdbms.postgresql.operations.ServersOperations
- - name: azure.mgmt.rdbms.postgresql.operations.VirtualNetworkRulesOperations
- uid: azure.mgmt.rdbms.postgresql.operations.VirtualNetworkRulesOperations
- name: azure.mgmt.rdbms.postgresql.operations
- - name: azure.mgmt.rdbms.postgresql.PostgreSQLManagementClient
- uid: azure.mgmt.rdbms.postgresql.PostgreSQLManagementClient
- name: azure.mgmt.rdbms.postgresql
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.postgresql_flexibleservers
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.AdministratorsOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.AdministratorsOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.BackupsOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.BackupsOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.CheckNameAvailabilityOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.CheckNameAvailabilityOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.CheckNameAvailabilityWithLocationOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.CheckNameAvailabilityWithLocationOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.ConfigurationsOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.ConfigurationsOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.DatabasesOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.DatabasesOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.FirewallRulesOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.FirewallRulesOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.FlexibleServerOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.FlexibleServerOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.GetPrivateDnsZoneSuffixOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.GetPrivateDnsZoneSuffixOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.LocationBasedCapabilitiesOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.LocationBasedCapabilitiesOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.LogFilesOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.LogFilesOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.LtrBackupOperationsOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.LtrBackupOperationsOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.MigrationsOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.MigrationsOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.Operations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.Operations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.PostgreSQLManagementClientOperationsMixin
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.PostgreSQLManagementClientOperationsMixin
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.ReplicasOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.ReplicasOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.ServerCapabilitiesOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.ServerCapabilitiesOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.ServersOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.ServersOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.VirtualNetworkSubnetUsageOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.VirtualNetworkSubnetUsageOperations
- name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.PostgreSQLManagementClient
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.PostgreSQLManagementClient
- name: azure.mgmt.rdbms.postgresql_flexibleservers.aio
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ActiveDirectoryAdministrator
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ActiveDirectoryAdministrator
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ActiveDirectoryAdministratorAdd
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ActiveDirectoryAdministratorAdd
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ActiveDirectoryAuthEnum
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ActiveDirectoryAuthEnum
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.AdminCredentials
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.AdminCredentials
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.AdministratorListResult
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.AdministratorListResult
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ArmServerKeyType
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ArmServerKeyType
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.AuthConfig
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.AuthConfig
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.AzureManagedDiskPerformanceTiers
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.AzureManagedDiskPerformanceTiers
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.Backup
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.Backup
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.BackupRequestBase
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.BackupRequestBase
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.BackupSettings
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.BackupSettings
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.BackupStoreDetails
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.BackupStoreDetails
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.CancelEnum
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.CancelEnum
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.CapabilitiesListResult
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.CapabilitiesListResult
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.CapabilityBase
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.CapabilityBase
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.CapabilityStatus
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.CapabilityStatus
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.CheckNameAvailabilityReason
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.CheckNameAvailabilityReason
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.CheckNameAvailabilityRequest
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.CheckNameAvailabilityRequest
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.CheckNameAvailabilityResponse
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.CheckNameAvailabilityResponse
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.Configuration
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.Configuration
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ConfigurationDataType
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ConfigurationDataType
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ConfigurationForUpdate
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ConfigurationForUpdate
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ConfigurationListResult
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ConfigurationListResult
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.CreateMode
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.CreateMode
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.CreateModeForUpdate
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.CreateModeForUpdate
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.CreatedByType
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.CreatedByType
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.DataEncryption
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.DataEncryption
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.Database
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.Database
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.DatabaseListResult
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.DatabaseListResult
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.DbServerMetadata
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.DbServerMetadata
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.DelegatedSubnetUsage
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.DelegatedSubnetUsage
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ErrorAdditionalInfo
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ErrorAdditionalInfo
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ErrorDetail
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ErrorDetail
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ErrorResponse
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ErrorResponse
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ExecutionStatus
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ExecutionStatus
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.FailoverMode
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.FailoverMode
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.FastProvisioningEditionCapability
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.FastProvisioningEditionCapability
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.FastProvisioningSupportedEnum
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.FastProvisioningSupportedEnum
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.FirewallRule
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.FirewallRule
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.FirewallRuleListResult
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.FirewallRuleListResult
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.FlexibleServerCapability
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.FlexibleServerCapability
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.FlexibleServerEditionCapability
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.FlexibleServerEditionCapability
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.GeoBackupSupportedEnum
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.GeoBackupSupportedEnum
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.GeoRedundantBackupEnum
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.GeoRedundantBackupEnum
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.HaMode
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.HaMode
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.HighAvailability
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.HighAvailability
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.HighAvailabilityMode
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.HighAvailabilityMode
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.IdentityType
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.IdentityType
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.KeyStatusEnum
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.KeyStatusEnum
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.LogFile
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.LogFile
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.LogFileListResult
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.LogFileListResult
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.LogicalReplicationOnSourceDbEnum
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.LogicalReplicationOnSourceDbEnum
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrBackupRequest
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrBackupRequest
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrBackupResponse
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrBackupResponse
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrPreBackupRequest
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrPreBackupRequest
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrPreBackupResponse
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrPreBackupResponse
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrServerBackupOperation
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrServerBackupOperation
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrServerBackupOperationList
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrServerBackupOperationList
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MaintenanceWindow
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MaintenanceWindow
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationDetailsLevel
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationDetailsLevel
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationListFilter
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationListFilter
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationMode
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationMode
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationNameAvailabilityReason
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationNameAvailabilityReason
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationNameAvailabilityResource
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationNameAvailabilityResource
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationResource
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationResource
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationResourceForPatch
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationResourceForPatch
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationResourceListResult
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationResourceListResult
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationSecretParameters
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationSecretParameters
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationState
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationState
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationStatus
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationStatus
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationSubState
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationSubState
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationSubStateDetails
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationSubStateDetails
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.NameAvailability
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.NameAvailability
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.Network
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.Network
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.OnlineResizeSupportedEnum
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.OnlineResizeSupportedEnum
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.Operation
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.Operation
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.OperationDisplay
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.OperationDisplay
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.OperationListResult
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.OperationListResult
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.OperationOrigin
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.OperationOrigin
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.Origin
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.Origin
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.OverwriteDbsInTargetEnum
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.OverwriteDbsInTargetEnum
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.PasswordAuthEnum
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.PasswordAuthEnum
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.PrincipalType
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.PrincipalType
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ProxyResource
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ProxyResource
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ReplicationRole
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ReplicationRole
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.Resource
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.Resource
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.RestartParameter
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.RestartParameter
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.RestrictedEnum
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.RestrictedEnum
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.Server
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.Server
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerBackup
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerBackup
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerBackupListResult
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerBackupListResult
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerForUpdate
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerForUpdate
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerHAState
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerHAState
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerListResult
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerListResult
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerPublicNetworkAccessState
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerPublicNetworkAccessState
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerSku
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerSku
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerSkuCapability
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerSkuCapability
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerState
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerState
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerVersion
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerVersion
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerVersionCapability
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerVersionCapability
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.Sku
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.Sku
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.SkuTier
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.SkuTier
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.StartDataMigrationEnum
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.StartDataMigrationEnum
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.Storage
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.Storage
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.StorageAutoGrow
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.StorageAutoGrow
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.StorageAutoGrowthSupportedEnum
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.StorageAutoGrowthSupportedEnum
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.StorageEditionCapability
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.StorageEditionCapability
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.StorageMbCapability
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.StorageMbCapability
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.StorageTierCapability
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.StorageTierCapability
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.SystemData
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.SystemData
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.TrackedResource
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.TrackedResource
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.TriggerCutoverEnum
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.TriggerCutoverEnum
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.UserAssignedIdentity
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.UserAssignedIdentity
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.UserIdentity
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.UserIdentity
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.VirtualNetworkSubnetUsageParameter
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.VirtualNetworkSubnetUsageParameter
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.VirtualNetworkSubnetUsageResult
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.VirtualNetworkSubnetUsageResult
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ZoneRedundantHaAndGeoBackupSupportedEnum
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ZoneRedundantHaAndGeoBackupSupportedEnum
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ZoneRedundantHaSupportedEnum
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ZoneRedundantHaSupportedEnum
- name: azure.mgmt.rdbms.postgresql_flexibleservers.models
- - items:
- - name: Overview
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.AdministratorsOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.AdministratorsOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.BackupsOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.BackupsOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.CheckNameAvailabilityOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.CheckNameAvailabilityOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.CheckNameAvailabilityWithLocationOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.CheckNameAvailabilityWithLocationOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.ConfigurationsOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.ConfigurationsOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.DatabasesOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.DatabasesOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.FirewallRulesOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.FirewallRulesOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.FlexibleServerOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.FlexibleServerOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.GetPrivateDnsZoneSuffixOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.GetPrivateDnsZoneSuffixOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.LocationBasedCapabilitiesOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.LocationBasedCapabilitiesOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.LogFilesOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.LogFilesOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.LtrBackupOperationsOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.LtrBackupOperationsOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.MigrationsOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.MigrationsOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.Operations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.Operations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.PostgreSQLManagementClientOperationsMixin
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.PostgreSQLManagementClientOperationsMixin
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.ReplicasOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.ReplicasOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.ServerCapabilitiesOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.ServerCapabilitiesOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.ServersOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.ServersOperations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.VirtualNetworkSubnetUsageOperations
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.VirtualNetworkSubnetUsageOperations
- name: azure.mgmt.rdbms.postgresql_flexibleservers.operations
- - name: azure.mgmt.rdbms.postgresql_flexibleservers.PostgreSQLManagementClient
- uid: azure.mgmt.rdbms.postgresql_flexibleservers.PostgreSQLManagementClient
- name: azure.mgmt.rdbms.postgresql_flexibleservers
+ uid: azure.mgmt.rdbms
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.mariadb
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.mariadb.aio
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.mariadb.aio.operations
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.AdvisorsOperations
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.AdvisorsOperations
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.CheckNameAvailabilityOperations
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.CheckNameAvailabilityOperations
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.ConfigurationsOperations
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.ConfigurationsOperations
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.DatabasesOperations
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.DatabasesOperations
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.FirewallRulesOperations
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.FirewallRulesOperations
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.LocationBasedPerformanceTierOperations
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.LocationBasedPerformanceTierOperations
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.LocationBasedRecommendedActionSessionsOperationStatusOperations
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.LocationBasedRecommendedActionSessionsOperationStatusOperations
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.LocationBasedRecommendedActionSessionsResultOperations
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.LocationBasedRecommendedActionSessionsResultOperations
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.LogFilesOperations
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.LogFilesOperations
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.MariaDBManagementClientOperationsMixin
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.MariaDBManagementClientOperationsMixin
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.Operations
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.Operations
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.PrivateEndpointConnectionsOperations
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.PrivateEndpointConnectionsOperations
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.PrivateLinkResourcesOperations
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.PrivateLinkResourcesOperations
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.QueryTextsOperations
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.QueryTextsOperations
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.RecommendedActionsOperations
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.RecommendedActionsOperations
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.RecoverableServersOperations
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.RecoverableServersOperations
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.ReplicasOperations
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.ReplicasOperations
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.ServerBasedPerformanceTierOperations
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.ServerBasedPerformanceTierOperations
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.ServerParametersOperations
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.ServerParametersOperations
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.ServerSecurityAlertPoliciesOperations
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.ServerSecurityAlertPoliciesOperations
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.ServersOperations
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.ServersOperations
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.TopQueryStatisticsOperations
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.TopQueryStatisticsOperations
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.VirtualNetworkRulesOperations
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.VirtualNetworkRulesOperations
+ - name: azure.mgmt.rdbms.mariadb.aio.operations.WaitStatisticsOperations
+ uid: azure.mgmt.rdbms.mariadb.aio.operations.WaitStatisticsOperations
+ name: azure.mgmt.rdbms.mariadb.aio.operations
+ - name: azure.mgmt.rdbms.mariadb.aio.MariaDBManagementClient
+ uid: azure.mgmt.rdbms.mariadb.aio.MariaDBManagementClient
+ name: azure.mgmt.rdbms.mariadb.aio
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.mariadb.models
+ - name: azure.mgmt.rdbms.mariadb.models.Advisor
+ uid: azure.mgmt.rdbms.mariadb.models.Advisor
+ - name: azure.mgmt.rdbms.mariadb.models.AdvisorsResultList
+ uid: azure.mgmt.rdbms.mariadb.models.AdvisorsResultList
+ - name: azure.mgmt.rdbms.mariadb.models.CloudErrorAutoGenerated
+ uid: azure.mgmt.rdbms.mariadb.models.CloudErrorAutoGenerated
+ - name: azure.mgmt.rdbms.mariadb.models.Configuration
+ uid: azure.mgmt.rdbms.mariadb.models.Configuration
+ - name: azure.mgmt.rdbms.mariadb.models.ConfigurationListResult
+ uid: azure.mgmt.rdbms.mariadb.models.ConfigurationListResult
+ - name: azure.mgmt.rdbms.mariadb.models.CreateMode
+ uid: azure.mgmt.rdbms.mariadb.models.CreateMode
+ - name: azure.mgmt.rdbms.mariadb.models.Database
+ uid: azure.mgmt.rdbms.mariadb.models.Database
+ - name: azure.mgmt.rdbms.mariadb.models.DatabaseListResult
+ uid: azure.mgmt.rdbms.mariadb.models.DatabaseListResult
+ - name: azure.mgmt.rdbms.mariadb.models.ErrorAdditionalInfo
+ uid: azure.mgmt.rdbms.mariadb.models.ErrorAdditionalInfo
+ - name: azure.mgmt.rdbms.mariadb.models.ErrorResponse
+ uid: azure.mgmt.rdbms.mariadb.models.ErrorResponse
+ - name: azure.mgmt.rdbms.mariadb.models.FirewallRule
+ uid: azure.mgmt.rdbms.mariadb.models.FirewallRule
+ - name: azure.mgmt.rdbms.mariadb.models.FirewallRuleListResult
+ uid: azure.mgmt.rdbms.mariadb.models.FirewallRuleListResult
+ - name: azure.mgmt.rdbms.mariadb.models.GeoRedundantBackup
+ uid: azure.mgmt.rdbms.mariadb.models.GeoRedundantBackup
+ - name: azure.mgmt.rdbms.mariadb.models.LogFile
+ uid: azure.mgmt.rdbms.mariadb.models.LogFile
+ - name: azure.mgmt.rdbms.mariadb.models.LogFileListResult
+ uid: azure.mgmt.rdbms.mariadb.models.LogFileListResult
+ - name: azure.mgmt.rdbms.mariadb.models.MinimalTlsVersionEnum
+ uid: azure.mgmt.rdbms.mariadb.models.MinimalTlsVersionEnum
+ - name: azure.mgmt.rdbms.mariadb.models.NameAvailability
+ uid: azure.mgmt.rdbms.mariadb.models.NameAvailability
+ - name: azure.mgmt.rdbms.mariadb.models.NameAvailabilityRequest
+ uid: azure.mgmt.rdbms.mariadb.models.NameAvailabilityRequest
+ - name: azure.mgmt.rdbms.mariadb.models.Operation
+ uid: azure.mgmt.rdbms.mariadb.models.Operation
+ - name: azure.mgmt.rdbms.mariadb.models.OperationDisplay
+ uid: azure.mgmt.rdbms.mariadb.models.OperationDisplay
+ - name: azure.mgmt.rdbms.mariadb.models.OperationListResult
+ uid: azure.mgmt.rdbms.mariadb.models.OperationListResult
+ - name: azure.mgmt.rdbms.mariadb.models.OperationOrigin
+ uid: azure.mgmt.rdbms.mariadb.models.OperationOrigin
+ - name: azure.mgmt.rdbms.mariadb.models.PerformanceTierListResult
+ uid: azure.mgmt.rdbms.mariadb.models.PerformanceTierListResult
+ - name: azure.mgmt.rdbms.mariadb.models.PerformanceTierProperties
+ uid: azure.mgmt.rdbms.mariadb.models.PerformanceTierProperties
+ - name: azure.mgmt.rdbms.mariadb.models.PerformanceTierServiceLevelObjectives
+ uid: azure.mgmt.rdbms.mariadb.models.PerformanceTierServiceLevelObjectives
+ - name: azure.mgmt.rdbms.mariadb.models.PrivateEndpointConnection
+ uid: azure.mgmt.rdbms.mariadb.models.PrivateEndpointConnection
+ - name: azure.mgmt.rdbms.mariadb.models.PrivateEndpointConnectionListResult
+ uid: azure.mgmt.rdbms.mariadb.models.PrivateEndpointConnectionListResult
+ - name: azure.mgmt.rdbms.mariadb.models.PrivateEndpointProperty
+ uid: azure.mgmt.rdbms.mariadb.models.PrivateEndpointProperty
+ - name: azure.mgmt.rdbms.mariadb.models.PrivateEndpointProvisioningState
+ uid: azure.mgmt.rdbms.mariadb.models.PrivateEndpointProvisioningState
+ - name: azure.mgmt.rdbms.mariadb.models.PrivateLinkResource
+ uid: azure.mgmt.rdbms.mariadb.models.PrivateLinkResource
+ - name: azure.mgmt.rdbms.mariadb.models.PrivateLinkResourceListResult
+ uid: azure.mgmt.rdbms.mariadb.models.PrivateLinkResourceListResult
+ - name: azure.mgmt.rdbms.mariadb.models.PrivateLinkResourceProperties
+ uid: azure.mgmt.rdbms.mariadb.models.PrivateLinkResourceProperties
+ - name: azure.mgmt.rdbms.mariadb.models.PrivateLinkServiceConnectionStateActionsRequire
+ uid: azure.mgmt.rdbms.mariadb.models.PrivateLinkServiceConnectionStateActionsRequire
+ - name: azure.mgmt.rdbms.mariadb.models.PrivateLinkServiceConnectionStateProperty
+ uid: azure.mgmt.rdbms.mariadb.models.PrivateLinkServiceConnectionStateProperty
+ - name: azure.mgmt.rdbms.mariadb.models.PrivateLinkServiceConnectionStateStatus
+ uid: azure.mgmt.rdbms.mariadb.models.PrivateLinkServiceConnectionStateStatus
+ - name: azure.mgmt.rdbms.mariadb.models.ProxyResource
+ uid: azure.mgmt.rdbms.mariadb.models.ProxyResource
+ - name: azure.mgmt.rdbms.mariadb.models.PublicNetworkAccessEnum
+ uid: azure.mgmt.rdbms.mariadb.models.PublicNetworkAccessEnum
+ - name: azure.mgmt.rdbms.mariadb.models.QueryPerformanceInsightResetDataResult
+ uid: azure.mgmt.rdbms.mariadb.models.QueryPerformanceInsightResetDataResult
+ - name: azure.mgmt.rdbms.mariadb.models.QueryPerformanceInsightResetDataResultState
+ uid: azure.mgmt.rdbms.mariadb.models.QueryPerformanceInsightResetDataResultState
+ - name: azure.mgmt.rdbms.mariadb.models.QueryStatistic
+ uid: azure.mgmt.rdbms.mariadb.models.QueryStatistic
+ - name: azure.mgmt.rdbms.mariadb.models.QueryText
+ uid: azure.mgmt.rdbms.mariadb.models.QueryText
+ - name: azure.mgmt.rdbms.mariadb.models.QueryTextsResultList
+ uid: azure.mgmt.rdbms.mariadb.models.QueryTextsResultList
+ - name: azure.mgmt.rdbms.mariadb.models.RecommendationAction
+ uid: azure.mgmt.rdbms.mariadb.models.RecommendationAction
+ - name: azure.mgmt.rdbms.mariadb.models.RecommendationActionsResultList
+ uid: azure.mgmt.rdbms.mariadb.models.RecommendationActionsResultList
+ - name: azure.mgmt.rdbms.mariadb.models.RecommendedActionSessionsOperationStatus
+ uid: azure.mgmt.rdbms.mariadb.models.RecommendedActionSessionsOperationStatus
+ - name: azure.mgmt.rdbms.mariadb.models.RecoverableServerResource
+ uid: azure.mgmt.rdbms.mariadb.models.RecoverableServerResource
+ - name: azure.mgmt.rdbms.mariadb.models.Resource
+ uid: azure.mgmt.rdbms.mariadb.models.Resource
+ - name: azure.mgmt.rdbms.mariadb.models.SecurityAlertPolicyName
+ uid: azure.mgmt.rdbms.mariadb.models.SecurityAlertPolicyName
+ - name: azure.mgmt.rdbms.mariadb.models.Server
+ uid: azure.mgmt.rdbms.mariadb.models.Server
+ - name: azure.mgmt.rdbms.mariadb.models.ServerForCreate
+ uid: azure.mgmt.rdbms.mariadb.models.ServerForCreate
+ - name: azure.mgmt.rdbms.mariadb.models.ServerListResult
+ uid: azure.mgmt.rdbms.mariadb.models.ServerListResult
+ - name: azure.mgmt.rdbms.mariadb.models.ServerPrivateEndpointConnection
+ uid: azure.mgmt.rdbms.mariadb.models.ServerPrivateEndpointConnection
+ - name: azure.mgmt.rdbms.mariadb.models.ServerPrivateEndpointConnectionProperties
+ uid: azure.mgmt.rdbms.mariadb.models.ServerPrivateEndpointConnectionProperties
+ - name: azure.mgmt.rdbms.mariadb.models.ServerPrivateLinkServiceConnectionStateProperty
+ uid: azure.mgmt.rdbms.mariadb.models.ServerPrivateLinkServiceConnectionStateProperty
+ - name: azure.mgmt.rdbms.mariadb.models.ServerPropertiesForCreate
+ uid: azure.mgmt.rdbms.mariadb.models.ServerPropertiesForCreate
+ - name: azure.mgmt.rdbms.mariadb.models.ServerPropertiesForDefaultCreate
+ uid: azure.mgmt.rdbms.mariadb.models.ServerPropertiesForDefaultCreate
+ - name: azure.mgmt.rdbms.mariadb.models.ServerPropertiesForGeoRestore
+ uid: azure.mgmt.rdbms.mariadb.models.ServerPropertiesForGeoRestore
+ - name: azure.mgmt.rdbms.mariadb.models.ServerPropertiesForReplica
+ uid: azure.mgmt.rdbms.mariadb.models.ServerPropertiesForReplica
+ - name: azure.mgmt.rdbms.mariadb.models.ServerPropertiesForRestore
+ uid: azure.mgmt.rdbms.mariadb.models.ServerPropertiesForRestore
+ - name: azure.mgmt.rdbms.mariadb.models.ServerSecurityAlertPolicy
+ uid: azure.mgmt.rdbms.mariadb.models.ServerSecurityAlertPolicy
+ - name: azure.mgmt.rdbms.mariadb.models.ServerSecurityAlertPolicyListResult
+ uid: azure.mgmt.rdbms.mariadb.models.ServerSecurityAlertPolicyListResult
+ - name: azure.mgmt.rdbms.mariadb.models.ServerSecurityAlertPolicyState
+ uid: azure.mgmt.rdbms.mariadb.models.ServerSecurityAlertPolicyState
+ - name: azure.mgmt.rdbms.mariadb.models.ServerState
+ uid: azure.mgmt.rdbms.mariadb.models.ServerState
+ - name: azure.mgmt.rdbms.mariadb.models.ServerUpdateParameters
+ uid: azure.mgmt.rdbms.mariadb.models.ServerUpdateParameters
+ - name: azure.mgmt.rdbms.mariadb.models.ServerVersion
+ uid: azure.mgmt.rdbms.mariadb.models.ServerVersion
+ - name: azure.mgmt.rdbms.mariadb.models.Sku
+ uid: azure.mgmt.rdbms.mariadb.models.Sku
+ - name: azure.mgmt.rdbms.mariadb.models.SkuTier
+ uid: azure.mgmt.rdbms.mariadb.models.SkuTier
+ - name: azure.mgmt.rdbms.mariadb.models.SslEnforcementEnum
+ uid: azure.mgmt.rdbms.mariadb.models.SslEnforcementEnum
+ - name: azure.mgmt.rdbms.mariadb.models.StorageAutogrow
+ uid: azure.mgmt.rdbms.mariadb.models.StorageAutogrow
+ - name: azure.mgmt.rdbms.mariadb.models.StorageProfile
+ uid: azure.mgmt.rdbms.mariadb.models.StorageProfile
+ - name: azure.mgmt.rdbms.mariadb.models.TagsObject
+ uid: azure.mgmt.rdbms.mariadb.models.TagsObject
+ - name: azure.mgmt.rdbms.mariadb.models.TopQueryStatisticsInput
+ uid: azure.mgmt.rdbms.mariadb.models.TopQueryStatisticsInput
+ - name: azure.mgmt.rdbms.mariadb.models.TopQueryStatisticsResultList
+ uid: azure.mgmt.rdbms.mariadb.models.TopQueryStatisticsResultList
+ - name: azure.mgmt.rdbms.mariadb.models.TrackedResource
+ uid: azure.mgmt.rdbms.mariadb.models.TrackedResource
+ - name: azure.mgmt.rdbms.mariadb.models.VirtualNetworkRule
+ uid: azure.mgmt.rdbms.mariadb.models.VirtualNetworkRule
+ - name: azure.mgmt.rdbms.mariadb.models.VirtualNetworkRuleListResult
+ uid: azure.mgmt.rdbms.mariadb.models.VirtualNetworkRuleListResult
+ - name: azure.mgmt.rdbms.mariadb.models.VirtualNetworkRuleState
+ uid: azure.mgmt.rdbms.mariadb.models.VirtualNetworkRuleState
+ - name: azure.mgmt.rdbms.mariadb.models.WaitStatistic
+ uid: azure.mgmt.rdbms.mariadb.models.WaitStatistic
+ - name: azure.mgmt.rdbms.mariadb.models.WaitStatisticsInput
+ uid: azure.mgmt.rdbms.mariadb.models.WaitStatisticsInput
+ - name: azure.mgmt.rdbms.mariadb.models.WaitStatisticsResultList
+ uid: azure.mgmt.rdbms.mariadb.models.WaitStatisticsResultList
+ name: azure.mgmt.rdbms.mariadb.models
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.mariadb.operations
+ - name: azure.mgmt.rdbms.mariadb.operations.AdvisorsOperations
+ uid: azure.mgmt.rdbms.mariadb.operations.AdvisorsOperations
+ - name: azure.mgmt.rdbms.mariadb.operations.CheckNameAvailabilityOperations
+ uid: azure.mgmt.rdbms.mariadb.operations.CheckNameAvailabilityOperations
+ - name: azure.mgmt.rdbms.mariadb.operations.ConfigurationsOperations
+ uid: azure.mgmt.rdbms.mariadb.operations.ConfigurationsOperations
+ - name: azure.mgmt.rdbms.mariadb.operations.DatabasesOperations
+ uid: azure.mgmt.rdbms.mariadb.operations.DatabasesOperations
+ - name: azure.mgmt.rdbms.mariadb.operations.FirewallRulesOperations
+ uid: azure.mgmt.rdbms.mariadb.operations.FirewallRulesOperations
+ - name: azure.mgmt.rdbms.mariadb.operations.LocationBasedPerformanceTierOperations
+ uid: azure.mgmt.rdbms.mariadb.operations.LocationBasedPerformanceTierOperations
+ - name: azure.mgmt.rdbms.mariadb.operations.LocationBasedRecommendedActionSessionsOperationStatusOperations
+ uid: azure.mgmt.rdbms.mariadb.operations.LocationBasedRecommendedActionSessionsOperationStatusOperations
+ - name: azure.mgmt.rdbms.mariadb.operations.LocationBasedRecommendedActionSessionsResultOperations
+ uid: azure.mgmt.rdbms.mariadb.operations.LocationBasedRecommendedActionSessionsResultOperations
+ - name: azure.mgmt.rdbms.mariadb.operations.LogFilesOperations
+ uid: azure.mgmt.rdbms.mariadb.operations.LogFilesOperations
+ - name: azure.mgmt.rdbms.mariadb.operations.MariaDBManagementClientOperationsMixin
+ uid: azure.mgmt.rdbms.mariadb.operations.MariaDBManagementClientOperationsMixin
+ - name: azure.mgmt.rdbms.mariadb.operations.Operations
+ uid: azure.mgmt.rdbms.mariadb.operations.Operations
+ - name: azure.mgmt.rdbms.mariadb.operations.PrivateEndpointConnectionsOperations
+ uid: azure.mgmt.rdbms.mariadb.operations.PrivateEndpointConnectionsOperations
+ - name: azure.mgmt.rdbms.mariadb.operations.PrivateLinkResourcesOperations
+ uid: azure.mgmt.rdbms.mariadb.operations.PrivateLinkResourcesOperations
+ - name: azure.mgmt.rdbms.mariadb.operations.QueryTextsOperations
+ uid: azure.mgmt.rdbms.mariadb.operations.QueryTextsOperations
+ - name: azure.mgmt.rdbms.mariadb.operations.RecommendedActionsOperations
+ uid: azure.mgmt.rdbms.mariadb.operations.RecommendedActionsOperations
+ - name: azure.mgmt.rdbms.mariadb.operations.RecoverableServersOperations
+ uid: azure.mgmt.rdbms.mariadb.operations.RecoverableServersOperations
+ - name: azure.mgmt.rdbms.mariadb.operations.ReplicasOperations
+ uid: azure.mgmt.rdbms.mariadb.operations.ReplicasOperations
+ - name: azure.mgmt.rdbms.mariadb.operations.ServerBasedPerformanceTierOperations
+ uid: azure.mgmt.rdbms.mariadb.operations.ServerBasedPerformanceTierOperations
+ - name: azure.mgmt.rdbms.mariadb.operations.ServerParametersOperations
+ uid: azure.mgmt.rdbms.mariadb.operations.ServerParametersOperations
+ - name: azure.mgmt.rdbms.mariadb.operations.ServerSecurityAlertPoliciesOperations
+ uid: azure.mgmt.rdbms.mariadb.operations.ServerSecurityAlertPoliciesOperations
+ - name: azure.mgmt.rdbms.mariadb.operations.ServersOperations
+ uid: azure.mgmt.rdbms.mariadb.operations.ServersOperations
+ - name: azure.mgmt.rdbms.mariadb.operations.TopQueryStatisticsOperations
+ uid: azure.mgmt.rdbms.mariadb.operations.TopQueryStatisticsOperations
+ - name: azure.mgmt.rdbms.mariadb.operations.VirtualNetworkRulesOperations
+ uid: azure.mgmt.rdbms.mariadb.operations.VirtualNetworkRulesOperations
+ - name: azure.mgmt.rdbms.mariadb.operations.WaitStatisticsOperations
+ uid: azure.mgmt.rdbms.mariadb.operations.WaitStatisticsOperations
+ name: azure.mgmt.rdbms.mariadb.operations
+ - name: azure.mgmt.rdbms.mariadb.MariaDBManagementClient
+ uid: azure.mgmt.rdbms.mariadb.MariaDBManagementClient
+ name: azure.mgmt.rdbms.mariadb
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.mysql
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.mysql.aio
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.mysql.aio.operations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.AdvisorsOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.AdvisorsOperations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.CheckNameAvailabilityOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.CheckNameAvailabilityOperations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.ConfigurationsOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.ConfigurationsOperations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.DatabasesOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.DatabasesOperations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.FirewallRulesOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.FirewallRulesOperations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.LocationBasedPerformanceTierOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.LocationBasedPerformanceTierOperations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.LocationBasedRecommendedActionSessionsOperationStatusOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.LocationBasedRecommendedActionSessionsOperationStatusOperations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.LocationBasedRecommendedActionSessionsResultOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.LocationBasedRecommendedActionSessionsResultOperations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.LogFilesOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.LogFilesOperations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.MySQLManagementClientOperationsMixin
+ uid: azure.mgmt.rdbms.mysql.aio.operations.MySQLManagementClientOperationsMixin
+ - name: azure.mgmt.rdbms.mysql.aio.operations.Operations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.Operations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.PrivateEndpointConnectionsOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.PrivateEndpointConnectionsOperations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.PrivateLinkResourcesOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.PrivateLinkResourcesOperations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.QueryTextsOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.QueryTextsOperations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.RecommendedActionsOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.RecommendedActionsOperations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.RecoverableServersOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.RecoverableServersOperations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.ReplicasOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.ReplicasOperations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.ServerAdministratorsOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.ServerAdministratorsOperations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.ServerBasedPerformanceTierOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.ServerBasedPerformanceTierOperations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.ServerKeysOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.ServerKeysOperations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.ServerParametersOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.ServerParametersOperations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.ServerSecurityAlertPoliciesOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.ServerSecurityAlertPoliciesOperations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.ServersOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.ServersOperations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.TopQueryStatisticsOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.TopQueryStatisticsOperations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.VirtualNetworkRulesOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.VirtualNetworkRulesOperations
+ - name: azure.mgmt.rdbms.mysql.aio.operations.WaitStatisticsOperations
+ uid: azure.mgmt.rdbms.mysql.aio.operations.WaitStatisticsOperations
+ name: azure.mgmt.rdbms.mysql.aio.operations
+ - name: azure.mgmt.rdbms.mysql.aio.MySQLManagementClient
+ uid: azure.mgmt.rdbms.mysql.aio.MySQLManagementClient
+ name: azure.mgmt.rdbms.mysql.aio
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.mysql.models
+ - name: azure.mgmt.rdbms.mysql.models.Advisor
+ uid: azure.mgmt.rdbms.mysql.models.Advisor
+ - name: azure.mgmt.rdbms.mysql.models.AdvisorsResultList
+ uid: azure.mgmt.rdbms.mysql.models.AdvisorsResultList
+ - name: azure.mgmt.rdbms.mysql.models.CloudErrorAutoGenerated
+ uid: azure.mgmt.rdbms.mysql.models.CloudErrorAutoGenerated
+ - name: azure.mgmt.rdbms.mysql.models.Configuration
+ uid: azure.mgmt.rdbms.mysql.models.Configuration
+ - name: azure.mgmt.rdbms.mysql.models.ConfigurationListResult
+ uid: azure.mgmt.rdbms.mysql.models.ConfigurationListResult
+ - name: azure.mgmt.rdbms.mysql.models.CreateMode
+ uid: azure.mgmt.rdbms.mysql.models.CreateMode
+ - name: azure.mgmt.rdbms.mysql.models.Database
+ uid: azure.mgmt.rdbms.mysql.models.Database
+ - name: azure.mgmt.rdbms.mysql.models.DatabaseListResult
+ uid: azure.mgmt.rdbms.mysql.models.DatabaseListResult
+ - name: azure.mgmt.rdbms.mysql.models.ErrorAdditionalInfo
+ uid: azure.mgmt.rdbms.mysql.models.ErrorAdditionalInfo
+ - name: azure.mgmt.rdbms.mysql.models.ErrorResponse
+ uid: azure.mgmt.rdbms.mysql.models.ErrorResponse
+ - name: azure.mgmt.rdbms.mysql.models.FirewallRule
+ uid: azure.mgmt.rdbms.mysql.models.FirewallRule
+ - name: azure.mgmt.rdbms.mysql.models.FirewallRuleListResult
+ uid: azure.mgmt.rdbms.mysql.models.FirewallRuleListResult
+ - name: azure.mgmt.rdbms.mysql.models.GeoRedundantBackup
+ uid: azure.mgmt.rdbms.mysql.models.GeoRedundantBackup
+ - name: azure.mgmt.rdbms.mysql.models.IdentityType
+ uid: azure.mgmt.rdbms.mysql.models.IdentityType
+ - name: azure.mgmt.rdbms.mysql.models.InfrastructureEncryption
+ uid: azure.mgmt.rdbms.mysql.models.InfrastructureEncryption
+ - name: azure.mgmt.rdbms.mysql.models.LogFile
+ uid: azure.mgmt.rdbms.mysql.models.LogFile
+ - name: azure.mgmt.rdbms.mysql.models.LogFileListResult
+ uid: azure.mgmt.rdbms.mysql.models.LogFileListResult
+ - name: azure.mgmt.rdbms.mysql.models.MinimalTlsVersionEnum
+ uid: azure.mgmt.rdbms.mysql.models.MinimalTlsVersionEnum
+ - name: azure.mgmt.rdbms.mysql.models.NameAvailability
+ uid: azure.mgmt.rdbms.mysql.models.NameAvailability
+ - name: azure.mgmt.rdbms.mysql.models.NameAvailabilityRequest
+ uid: azure.mgmt.rdbms.mysql.models.NameAvailabilityRequest
+ - name: azure.mgmt.rdbms.mysql.models.Operation
+ uid: azure.mgmt.rdbms.mysql.models.Operation
+ - name: azure.mgmt.rdbms.mysql.models.OperationDisplay
+ uid: azure.mgmt.rdbms.mysql.models.OperationDisplay
+ - name: azure.mgmt.rdbms.mysql.models.OperationListResult
+ uid: azure.mgmt.rdbms.mysql.models.OperationListResult
+ - name: azure.mgmt.rdbms.mysql.models.OperationOrigin
+ uid: azure.mgmt.rdbms.mysql.models.OperationOrigin
+ - name: azure.mgmt.rdbms.mysql.models.PerformanceTierListResult
+ uid: azure.mgmt.rdbms.mysql.models.PerformanceTierListResult
+ - name: azure.mgmt.rdbms.mysql.models.PerformanceTierProperties
+ uid: azure.mgmt.rdbms.mysql.models.PerformanceTierProperties
+ - name: azure.mgmt.rdbms.mysql.models.PerformanceTierServiceLevelObjectives
+ uid: azure.mgmt.rdbms.mysql.models.PerformanceTierServiceLevelObjectives
+ - name: azure.mgmt.rdbms.mysql.models.PrivateEndpointConnection
+ uid: azure.mgmt.rdbms.mysql.models.PrivateEndpointConnection
+ - name: azure.mgmt.rdbms.mysql.models.PrivateEndpointConnectionListResult
+ uid: azure.mgmt.rdbms.mysql.models.PrivateEndpointConnectionListResult
+ - name: azure.mgmt.rdbms.mysql.models.PrivateEndpointProperty
+ uid: azure.mgmt.rdbms.mysql.models.PrivateEndpointProperty
+ - name: azure.mgmt.rdbms.mysql.models.PrivateEndpointProvisioningState
+ uid: azure.mgmt.rdbms.mysql.models.PrivateEndpointProvisioningState
+ - name: azure.mgmt.rdbms.mysql.models.PrivateLinkResource
+ uid: azure.mgmt.rdbms.mysql.models.PrivateLinkResource
+ - name: azure.mgmt.rdbms.mysql.models.PrivateLinkResourceListResult
+ uid: azure.mgmt.rdbms.mysql.models.PrivateLinkResourceListResult
+ - name: azure.mgmt.rdbms.mysql.models.PrivateLinkResourceProperties
+ uid: azure.mgmt.rdbms.mysql.models.PrivateLinkResourceProperties
+ - name: azure.mgmt.rdbms.mysql.models.PrivateLinkServiceConnectionStateActionsRequire
+ uid: azure.mgmt.rdbms.mysql.models.PrivateLinkServiceConnectionStateActionsRequire
+ - name: azure.mgmt.rdbms.mysql.models.PrivateLinkServiceConnectionStateProperty
+ uid: azure.mgmt.rdbms.mysql.models.PrivateLinkServiceConnectionStateProperty
+ - name: azure.mgmt.rdbms.mysql.models.PrivateLinkServiceConnectionStateStatus
+ uid: azure.mgmt.rdbms.mysql.models.PrivateLinkServiceConnectionStateStatus
+ - name: azure.mgmt.rdbms.mysql.models.ProxyResource
+ uid: azure.mgmt.rdbms.mysql.models.ProxyResource
+ - name: azure.mgmt.rdbms.mysql.models.PublicNetworkAccessEnum
+ uid: azure.mgmt.rdbms.mysql.models.PublicNetworkAccessEnum
+ - name: azure.mgmt.rdbms.mysql.models.QueryPerformanceInsightResetDataResult
+ uid: azure.mgmt.rdbms.mysql.models.QueryPerformanceInsightResetDataResult
+ - name: azure.mgmt.rdbms.mysql.models.QueryPerformanceInsightResetDataResultState
+ uid: azure.mgmt.rdbms.mysql.models.QueryPerformanceInsightResetDataResultState
+ - name: azure.mgmt.rdbms.mysql.models.QueryStatistic
+ uid: azure.mgmt.rdbms.mysql.models.QueryStatistic
+ - name: azure.mgmt.rdbms.mysql.models.QueryText
+ uid: azure.mgmt.rdbms.mysql.models.QueryText
+ - name: azure.mgmt.rdbms.mysql.models.QueryTextsResultList
+ uid: azure.mgmt.rdbms.mysql.models.QueryTextsResultList
+ - name: azure.mgmt.rdbms.mysql.models.RecommendationAction
+ uid: azure.mgmt.rdbms.mysql.models.RecommendationAction
+ - name: azure.mgmt.rdbms.mysql.models.RecommendationActionsResultList
+ uid: azure.mgmt.rdbms.mysql.models.RecommendationActionsResultList
+ - name: azure.mgmt.rdbms.mysql.models.RecommendedActionSessionsOperationStatus
+ uid: azure.mgmt.rdbms.mysql.models.RecommendedActionSessionsOperationStatus
+ - name: azure.mgmt.rdbms.mysql.models.RecoverableServerResource
+ uid: azure.mgmt.rdbms.mysql.models.RecoverableServerResource
+ - name: azure.mgmt.rdbms.mysql.models.Resource
+ uid: azure.mgmt.rdbms.mysql.models.Resource
+ - name: azure.mgmt.rdbms.mysql.models.ResourceIdentity
+ uid: azure.mgmt.rdbms.mysql.models.ResourceIdentity
+ - name: azure.mgmt.rdbms.mysql.models.SecurityAlertPolicyName
+ uid: azure.mgmt.rdbms.mysql.models.SecurityAlertPolicyName
+ - name: azure.mgmt.rdbms.mysql.models.Server
+ uid: azure.mgmt.rdbms.mysql.models.Server
+ - name: azure.mgmt.rdbms.mysql.models.ServerAdministratorResource
+ uid: azure.mgmt.rdbms.mysql.models.ServerAdministratorResource
+ - name: azure.mgmt.rdbms.mysql.models.ServerAdministratorResourceListResult
+ uid: azure.mgmt.rdbms.mysql.models.ServerAdministratorResourceListResult
+ - name: azure.mgmt.rdbms.mysql.models.ServerForCreate
+ uid: azure.mgmt.rdbms.mysql.models.ServerForCreate
+ - name: azure.mgmt.rdbms.mysql.models.ServerKey
+ uid: azure.mgmt.rdbms.mysql.models.ServerKey
+ - name: azure.mgmt.rdbms.mysql.models.ServerKeyListResult
+ uid: azure.mgmt.rdbms.mysql.models.ServerKeyListResult
+ - name: azure.mgmt.rdbms.mysql.models.ServerKeyType
+ uid: azure.mgmt.rdbms.mysql.models.ServerKeyType
+ - name: azure.mgmt.rdbms.mysql.models.ServerListResult
+ uid: azure.mgmt.rdbms.mysql.models.ServerListResult
+ - name: azure.mgmt.rdbms.mysql.models.ServerPrivateEndpointConnection
+ uid: azure.mgmt.rdbms.mysql.models.ServerPrivateEndpointConnection
+ - name: azure.mgmt.rdbms.mysql.models.ServerPrivateEndpointConnectionProperties
+ uid: azure.mgmt.rdbms.mysql.models.ServerPrivateEndpointConnectionProperties
+ - name: azure.mgmt.rdbms.mysql.models.ServerPrivateLinkServiceConnectionStateProperty
+ uid: azure.mgmt.rdbms.mysql.models.ServerPrivateLinkServiceConnectionStateProperty
+ - name: azure.mgmt.rdbms.mysql.models.ServerPropertiesForCreate
+ uid: azure.mgmt.rdbms.mysql.models.ServerPropertiesForCreate
+ - name: azure.mgmt.rdbms.mysql.models.ServerPropertiesForDefaultCreate
+ uid: azure.mgmt.rdbms.mysql.models.ServerPropertiesForDefaultCreate
+ - name: azure.mgmt.rdbms.mysql.models.ServerPropertiesForGeoRestore
+ uid: azure.mgmt.rdbms.mysql.models.ServerPropertiesForGeoRestore
+ - name: azure.mgmt.rdbms.mysql.models.ServerPropertiesForReplica
+ uid: azure.mgmt.rdbms.mysql.models.ServerPropertiesForReplica
+ - name: azure.mgmt.rdbms.mysql.models.ServerPropertiesForRestore
+ uid: azure.mgmt.rdbms.mysql.models.ServerPropertiesForRestore
+ - name: azure.mgmt.rdbms.mysql.models.ServerSecurityAlertPolicy
+ uid: azure.mgmt.rdbms.mysql.models.ServerSecurityAlertPolicy
+ - name: azure.mgmt.rdbms.mysql.models.ServerSecurityAlertPolicyListResult
+ uid: azure.mgmt.rdbms.mysql.models.ServerSecurityAlertPolicyListResult
+ - name: azure.mgmt.rdbms.mysql.models.ServerSecurityAlertPolicyState
+ uid: azure.mgmt.rdbms.mysql.models.ServerSecurityAlertPolicyState
+ - name: azure.mgmt.rdbms.mysql.models.ServerState
+ uid: azure.mgmt.rdbms.mysql.models.ServerState
+ - name: azure.mgmt.rdbms.mysql.models.ServerUpdateParameters
+ uid: azure.mgmt.rdbms.mysql.models.ServerUpdateParameters
+ - name: azure.mgmt.rdbms.mysql.models.ServerUpgradeParameters
+ uid: azure.mgmt.rdbms.mysql.models.ServerUpgradeParameters
+ - name: azure.mgmt.rdbms.mysql.models.ServerVersion
+ uid: azure.mgmt.rdbms.mysql.models.ServerVersion
+ - name: azure.mgmt.rdbms.mysql.models.Sku
+ uid: azure.mgmt.rdbms.mysql.models.Sku
+ - name: azure.mgmt.rdbms.mysql.models.SkuTier
+ uid: azure.mgmt.rdbms.mysql.models.SkuTier
+ - name: azure.mgmt.rdbms.mysql.models.SslEnforcementEnum
+ uid: azure.mgmt.rdbms.mysql.models.SslEnforcementEnum
+ - name: azure.mgmt.rdbms.mysql.models.StorageAutogrow
+ uid: azure.mgmt.rdbms.mysql.models.StorageAutogrow
+ - name: azure.mgmt.rdbms.mysql.models.StorageProfile
+ uid: azure.mgmt.rdbms.mysql.models.StorageProfile
+ - name: azure.mgmt.rdbms.mysql.models.TagsObject
+ uid: azure.mgmt.rdbms.mysql.models.TagsObject
+ - name: azure.mgmt.rdbms.mysql.models.TopQueryStatisticsInput
+ uid: azure.mgmt.rdbms.mysql.models.TopQueryStatisticsInput
+ - name: azure.mgmt.rdbms.mysql.models.TopQueryStatisticsResultList
+ uid: azure.mgmt.rdbms.mysql.models.TopQueryStatisticsResultList
+ - name: azure.mgmt.rdbms.mysql.models.TrackedResource
+ uid: azure.mgmt.rdbms.mysql.models.TrackedResource
+ - name: azure.mgmt.rdbms.mysql.models.VirtualNetworkRule
+ uid: azure.mgmt.rdbms.mysql.models.VirtualNetworkRule
+ - name: azure.mgmt.rdbms.mysql.models.VirtualNetworkRuleListResult
+ uid: azure.mgmt.rdbms.mysql.models.VirtualNetworkRuleListResult
+ - name: azure.mgmt.rdbms.mysql.models.VirtualNetworkRuleState
+ uid: azure.mgmt.rdbms.mysql.models.VirtualNetworkRuleState
+ - name: azure.mgmt.rdbms.mysql.models.WaitStatistic
+ uid: azure.mgmt.rdbms.mysql.models.WaitStatistic
+ - name: azure.mgmt.rdbms.mysql.models.WaitStatisticsInput
+ uid: azure.mgmt.rdbms.mysql.models.WaitStatisticsInput
+ - name: azure.mgmt.rdbms.mysql.models.WaitStatisticsResultList
+ uid: azure.mgmt.rdbms.mysql.models.WaitStatisticsResultList
+ name: azure.mgmt.rdbms.mysql.models
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.mysql.operations
+ - name: azure.mgmt.rdbms.mysql.operations.AdvisorsOperations
+ uid: azure.mgmt.rdbms.mysql.operations.AdvisorsOperations
+ - name: azure.mgmt.rdbms.mysql.operations.CheckNameAvailabilityOperations
+ uid: azure.mgmt.rdbms.mysql.operations.CheckNameAvailabilityOperations
+ - name: azure.mgmt.rdbms.mysql.operations.ConfigurationsOperations
+ uid: azure.mgmt.rdbms.mysql.operations.ConfigurationsOperations
+ - name: azure.mgmt.rdbms.mysql.operations.DatabasesOperations
+ uid: azure.mgmt.rdbms.mysql.operations.DatabasesOperations
+ - name: azure.mgmt.rdbms.mysql.operations.FirewallRulesOperations
+ uid: azure.mgmt.rdbms.mysql.operations.FirewallRulesOperations
+ - name: azure.mgmt.rdbms.mysql.operations.LocationBasedPerformanceTierOperations
+ uid: azure.mgmt.rdbms.mysql.operations.LocationBasedPerformanceTierOperations
+ - name: azure.mgmt.rdbms.mysql.operations.LocationBasedRecommendedActionSessionsOperationStatusOperations
+ uid: azure.mgmt.rdbms.mysql.operations.LocationBasedRecommendedActionSessionsOperationStatusOperations
+ - name: azure.mgmt.rdbms.mysql.operations.LocationBasedRecommendedActionSessionsResultOperations
+ uid: azure.mgmt.rdbms.mysql.operations.LocationBasedRecommendedActionSessionsResultOperations
+ - name: azure.mgmt.rdbms.mysql.operations.LogFilesOperations
+ uid: azure.mgmt.rdbms.mysql.operations.LogFilesOperations
+ - name: azure.mgmt.rdbms.mysql.operations.MySQLManagementClientOperationsMixin
+ uid: azure.mgmt.rdbms.mysql.operations.MySQLManagementClientOperationsMixin
+ - name: azure.mgmt.rdbms.mysql.operations.Operations
+ uid: azure.mgmt.rdbms.mysql.operations.Operations
+ - name: azure.mgmt.rdbms.mysql.operations.PrivateEndpointConnectionsOperations
+ uid: azure.mgmt.rdbms.mysql.operations.PrivateEndpointConnectionsOperations
+ - name: azure.mgmt.rdbms.mysql.operations.PrivateLinkResourcesOperations
+ uid: azure.mgmt.rdbms.mysql.operations.PrivateLinkResourcesOperations
+ - name: azure.mgmt.rdbms.mysql.operations.QueryTextsOperations
+ uid: azure.mgmt.rdbms.mysql.operations.QueryTextsOperations
+ - name: azure.mgmt.rdbms.mysql.operations.RecommendedActionsOperations
+ uid: azure.mgmt.rdbms.mysql.operations.RecommendedActionsOperations
+ - name: azure.mgmt.rdbms.mysql.operations.RecoverableServersOperations
+ uid: azure.mgmt.rdbms.mysql.operations.RecoverableServersOperations
+ - name: azure.mgmt.rdbms.mysql.operations.ReplicasOperations
+ uid: azure.mgmt.rdbms.mysql.operations.ReplicasOperations
+ - name: azure.mgmt.rdbms.mysql.operations.ServerAdministratorsOperations
+ uid: azure.mgmt.rdbms.mysql.operations.ServerAdministratorsOperations
+ - name: azure.mgmt.rdbms.mysql.operations.ServerBasedPerformanceTierOperations
+ uid: azure.mgmt.rdbms.mysql.operations.ServerBasedPerformanceTierOperations
+ - name: azure.mgmt.rdbms.mysql.operations.ServerKeysOperations
+ uid: azure.mgmt.rdbms.mysql.operations.ServerKeysOperations
+ - name: azure.mgmt.rdbms.mysql.operations.ServerParametersOperations
+ uid: azure.mgmt.rdbms.mysql.operations.ServerParametersOperations
+ - name: azure.mgmt.rdbms.mysql.operations.ServerSecurityAlertPoliciesOperations
+ uid: azure.mgmt.rdbms.mysql.operations.ServerSecurityAlertPoliciesOperations
+ - name: azure.mgmt.rdbms.mysql.operations.ServersOperations
+ uid: azure.mgmt.rdbms.mysql.operations.ServersOperations
+ - name: azure.mgmt.rdbms.mysql.operations.TopQueryStatisticsOperations
+ uid: azure.mgmt.rdbms.mysql.operations.TopQueryStatisticsOperations
+ - name: azure.mgmt.rdbms.mysql.operations.VirtualNetworkRulesOperations
+ uid: azure.mgmt.rdbms.mysql.operations.VirtualNetworkRulesOperations
+ - name: azure.mgmt.rdbms.mysql.operations.WaitStatisticsOperations
+ uid: azure.mgmt.rdbms.mysql.operations.WaitStatisticsOperations
+ name: azure.mgmt.rdbms.mysql.operations
+ - name: azure.mgmt.rdbms.mysql.MySQLManagementClient
+ uid: azure.mgmt.rdbms.mysql.MySQLManagementClient
+ name: azure.mgmt.rdbms.mysql
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.mysql_flexibleservers
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.aio
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.AzureADAdministratorsOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.AzureADAdministratorsOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.BackupAndExportOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.BackupAndExportOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.BackupsOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.BackupsOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.CheckNameAvailabilityOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.CheckNameAvailabilityOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.CheckNameAvailabilityWithoutLocationOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.CheckNameAvailabilityWithoutLocationOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.CheckVirtualNetworkSubnetUsageOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.CheckVirtualNetworkSubnetUsageOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.ConfigurationsOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.ConfigurationsOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.DatabasesOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.DatabasesOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.FirewallRulesOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.FirewallRulesOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.GetPrivateDnsZoneSuffixOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.GetPrivateDnsZoneSuffixOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.LocationBasedCapabilitiesOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.LocationBasedCapabilitiesOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.LogFilesOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.LogFilesOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.Operations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.Operations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.ReplicasOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.ReplicasOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.ServersOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations.ServersOperations
+ name: azure.mgmt.rdbms.mysql_flexibleservers.aio.operations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.aio.MySQLManagementClient
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.aio.MySQLManagementClient
+ name: azure.mgmt.rdbms.mysql_flexibleservers.aio
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.AdministratorListResult
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.AdministratorListResult
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.AdministratorName
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.AdministratorName
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.AdministratorType
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.AdministratorType
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.AzureADAdministrator
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.AzureADAdministrator
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.Backup
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.Backup
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupAndExportRequest
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupAndExportRequest
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupAndExportResponse
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupAndExportResponse
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupFormat
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupFormat
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupRequestBase
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupRequestBase
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupSettings
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupSettings
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupStoreDetails
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.BackupStoreDetails
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.CapabilitiesListResult
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.CapabilitiesListResult
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.CapabilityProperties
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.CapabilityProperties
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.Configuration
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.Configuration
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ConfigurationForBatchUpdate
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ConfigurationForBatchUpdate
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ConfigurationListForBatchUpdate
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ConfigurationListForBatchUpdate
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ConfigurationListResult
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ConfigurationListResult
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ConfigurationSource
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ConfigurationSource
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.CreateMode
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.CreateMode
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.CreatedByType
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.CreatedByType
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.DataEncryption
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.DataEncryption
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.DataEncryptionType
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.DataEncryptionType
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.Database
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.Database
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.DatabaseListResult
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.DatabaseListResult
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.DelegatedSubnetUsage
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.DelegatedSubnetUsage
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.EnableStatusEnum
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.EnableStatusEnum
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ErrorAdditionalInfo
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ErrorAdditionalInfo
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ErrorResponse
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ErrorResponse
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.FirewallRule
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.FirewallRule
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.FirewallRuleListResult
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.FirewallRuleListResult
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.FullBackupStoreDetails
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.FullBackupStoreDetails
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.GetPrivateDnsZoneSuffixResponse
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.GetPrivateDnsZoneSuffixResponse
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.HighAvailability
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.HighAvailability
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.HighAvailabilityMode
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.HighAvailabilityMode
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.HighAvailabilityState
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.HighAvailabilityState
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.Identity
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.Identity
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.IsConfigPendingRestart
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.IsConfigPendingRestart
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.IsDynamicConfig
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.IsDynamicConfig
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.IsReadOnly
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.IsReadOnly
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.LogFile
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.LogFile
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.LogFileListResult
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.LogFileListResult
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.MaintenanceWindow
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.MaintenanceWindow
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ManagedServiceIdentityType
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ManagedServiceIdentityType
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.NameAvailability
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.NameAvailability
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.NameAvailabilityRequest
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.NameAvailabilityRequest
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.Network
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.Network
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.Operation
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.Operation
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.OperationDisplay
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.OperationDisplay
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.OperationListResult
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.OperationListResult
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.OperationStatus
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.OperationStatus
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ProxyResource
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ProxyResource
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ReplicationRole
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ReplicationRole
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ResetAllToDefault
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ResetAllToDefault
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.Resource
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.Resource
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.Server
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.Server
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerBackup
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerBackup
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerBackupListResult
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerBackupListResult
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerEditionCapability
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerEditionCapability
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerForUpdate
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerForUpdate
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerGtidSetParameter
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerGtidSetParameter
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerListResult
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerListResult
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerRestartParameter
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerRestartParameter
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerState
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerState
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerVersion
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerVersion
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerVersionCapability
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ServerVersionCapability
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.Sku
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.Sku
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.SkuCapability
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.SkuCapability
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.SkuTier
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.SkuTier
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.Storage
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.Storage
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.StorageEditionCapability
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.StorageEditionCapability
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.SystemData
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.SystemData
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.TrackedResource
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.TrackedResource
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.UserAssignedIdentity
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.UserAssignedIdentity
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.ValidateBackupResponse
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.ValidateBackupResponse
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.VirtualNetworkSubnetUsageParameter
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.VirtualNetworkSubnetUsageParameter
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.models.VirtualNetworkSubnetUsageResult
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.models.VirtualNetworkSubnetUsageResult
+ name: azure.mgmt.rdbms.mysql_flexibleservers.models
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.operations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.AzureADAdministratorsOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.AzureADAdministratorsOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.BackupAndExportOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.BackupAndExportOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.BackupsOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.BackupsOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.CheckNameAvailabilityOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.CheckNameAvailabilityOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.CheckNameAvailabilityWithoutLocationOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.CheckNameAvailabilityWithoutLocationOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.CheckVirtualNetworkSubnetUsageOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.CheckVirtualNetworkSubnetUsageOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.ConfigurationsOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.ConfigurationsOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.DatabasesOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.DatabasesOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.FirewallRulesOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.FirewallRulesOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.GetPrivateDnsZoneSuffixOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.GetPrivateDnsZoneSuffixOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.LocationBasedCapabilitiesOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.LocationBasedCapabilitiesOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.LogFilesOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.LogFilesOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.Operations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.Operations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.ReplicasOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.ReplicasOperations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.operations.ServersOperations
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.operations.ServersOperations
+ name: azure.mgmt.rdbms.mysql_flexibleservers.operations
+ - name: azure.mgmt.rdbms.mysql_flexibleservers.MySQLManagementClient
+ uid: azure.mgmt.rdbms.mysql_flexibleservers.MySQLManagementClient
+ name: azure.mgmt.rdbms.mysql_flexibleservers
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.postgresql
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.postgresql.aio
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.postgresql.aio.operations
+ - name: azure.mgmt.rdbms.postgresql.aio.operations.CheckNameAvailabilityOperations
+ uid: azure.mgmt.rdbms.postgresql.aio.operations.CheckNameAvailabilityOperations
+ - name: azure.mgmt.rdbms.postgresql.aio.operations.ConfigurationsOperations
+ uid: azure.mgmt.rdbms.postgresql.aio.operations.ConfigurationsOperations
+ - name: azure.mgmt.rdbms.postgresql.aio.operations.DatabasesOperations
+ uid: azure.mgmt.rdbms.postgresql.aio.operations.DatabasesOperations
+ - name: azure.mgmt.rdbms.postgresql.aio.operations.FirewallRulesOperations
+ uid: azure.mgmt.rdbms.postgresql.aio.operations.FirewallRulesOperations
+ - name: azure.mgmt.rdbms.postgresql.aio.operations.LocationBasedPerformanceTierOperations
+ uid: azure.mgmt.rdbms.postgresql.aio.operations.LocationBasedPerformanceTierOperations
+ - name: azure.mgmt.rdbms.postgresql.aio.operations.LogFilesOperations
+ uid: azure.mgmt.rdbms.postgresql.aio.operations.LogFilesOperations
+ - name: azure.mgmt.rdbms.postgresql.aio.operations.Operations
+ uid: azure.mgmt.rdbms.postgresql.aio.operations.Operations
+ - name: azure.mgmt.rdbms.postgresql.aio.operations.PrivateEndpointConnectionsOperations
+ uid: azure.mgmt.rdbms.postgresql.aio.operations.PrivateEndpointConnectionsOperations
+ - name: azure.mgmt.rdbms.postgresql.aio.operations.PrivateLinkResourcesOperations
+ uid: azure.mgmt.rdbms.postgresql.aio.operations.PrivateLinkResourcesOperations
+ - name: azure.mgmt.rdbms.postgresql.aio.operations.RecoverableServersOperations
+ uid: azure.mgmt.rdbms.postgresql.aio.operations.RecoverableServersOperations
+ - name: azure.mgmt.rdbms.postgresql.aio.operations.ReplicasOperations
+ uid: azure.mgmt.rdbms.postgresql.aio.operations.ReplicasOperations
+ - name: azure.mgmt.rdbms.postgresql.aio.operations.ServerAdministratorsOperations
+ uid: azure.mgmt.rdbms.postgresql.aio.operations.ServerAdministratorsOperations
+ - name: azure.mgmt.rdbms.postgresql.aio.operations.ServerBasedPerformanceTierOperations
+ uid: azure.mgmt.rdbms.postgresql.aio.operations.ServerBasedPerformanceTierOperations
+ - name: azure.mgmt.rdbms.postgresql.aio.operations.ServerKeysOperations
+ uid: azure.mgmt.rdbms.postgresql.aio.operations.ServerKeysOperations
+ - name: azure.mgmt.rdbms.postgresql.aio.operations.ServerParametersOperations
+ uid: azure.mgmt.rdbms.postgresql.aio.operations.ServerParametersOperations
+ - name: azure.mgmt.rdbms.postgresql.aio.operations.ServerSecurityAlertPoliciesOperations
+ uid: azure.mgmt.rdbms.postgresql.aio.operations.ServerSecurityAlertPoliciesOperations
+ - name: azure.mgmt.rdbms.postgresql.aio.operations.ServersOperations
+ uid: azure.mgmt.rdbms.postgresql.aio.operations.ServersOperations
+ - name: azure.mgmt.rdbms.postgresql.aio.operations.VirtualNetworkRulesOperations
+ uid: azure.mgmt.rdbms.postgresql.aio.operations.VirtualNetworkRulesOperations
+ name: azure.mgmt.rdbms.postgresql.aio.operations
+ - name: azure.mgmt.rdbms.postgresql.aio.PostgreSQLManagementClient
+ uid: azure.mgmt.rdbms.postgresql.aio.PostgreSQLManagementClient
+ name: azure.mgmt.rdbms.postgresql.aio
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.postgresql.models
+ - name: azure.mgmt.rdbms.postgresql.models.Configuration
+ uid: azure.mgmt.rdbms.postgresql.models.Configuration
+ - name: azure.mgmt.rdbms.postgresql.models.ConfigurationListResult
+ uid: azure.mgmt.rdbms.postgresql.models.ConfigurationListResult
+ - name: azure.mgmt.rdbms.postgresql.models.CreateMode
+ uid: azure.mgmt.rdbms.postgresql.models.CreateMode
+ - name: azure.mgmt.rdbms.postgresql.models.Database
+ uid: azure.mgmt.rdbms.postgresql.models.Database
+ - name: azure.mgmt.rdbms.postgresql.models.DatabaseListResult
+ uid: azure.mgmt.rdbms.postgresql.models.DatabaseListResult
+ - name: azure.mgmt.rdbms.postgresql.models.ErrorAdditionalInfo
+ uid: azure.mgmt.rdbms.postgresql.models.ErrorAdditionalInfo
+ - name: azure.mgmt.rdbms.postgresql.models.ErrorResponse
+ uid: azure.mgmt.rdbms.postgresql.models.ErrorResponse
+ - name: azure.mgmt.rdbms.postgresql.models.FirewallRule
+ uid: azure.mgmt.rdbms.postgresql.models.FirewallRule
+ - name: azure.mgmt.rdbms.postgresql.models.FirewallRuleListResult
+ uid: azure.mgmt.rdbms.postgresql.models.FirewallRuleListResult
+ - name: azure.mgmt.rdbms.postgresql.models.GeoRedundantBackup
+ uid: azure.mgmt.rdbms.postgresql.models.GeoRedundantBackup
+ - name: azure.mgmt.rdbms.postgresql.models.IdentityType
+ uid: azure.mgmt.rdbms.postgresql.models.IdentityType
+ - name: azure.mgmt.rdbms.postgresql.models.InfrastructureEncryption
+ uid: azure.mgmt.rdbms.postgresql.models.InfrastructureEncryption
+ - name: azure.mgmt.rdbms.postgresql.models.LogFile
+ uid: azure.mgmt.rdbms.postgresql.models.LogFile
+ - name: azure.mgmt.rdbms.postgresql.models.LogFileListResult
+ uid: azure.mgmt.rdbms.postgresql.models.LogFileListResult
+ - name: azure.mgmt.rdbms.postgresql.models.MinimalTlsVersionEnum
+ uid: azure.mgmt.rdbms.postgresql.models.MinimalTlsVersionEnum
+ - name: azure.mgmt.rdbms.postgresql.models.NameAvailability
+ uid: azure.mgmt.rdbms.postgresql.models.NameAvailability
+ - name: azure.mgmt.rdbms.postgresql.models.NameAvailabilityRequest
+ uid: azure.mgmt.rdbms.postgresql.models.NameAvailabilityRequest
+ - name: azure.mgmt.rdbms.postgresql.models.Operation
+ uid: azure.mgmt.rdbms.postgresql.models.Operation
+ - name: azure.mgmt.rdbms.postgresql.models.OperationDisplay
+ uid: azure.mgmt.rdbms.postgresql.models.OperationDisplay
+ - name: azure.mgmt.rdbms.postgresql.models.OperationListResult
+ uid: azure.mgmt.rdbms.postgresql.models.OperationListResult
+ - name: azure.mgmt.rdbms.postgresql.models.OperationOrigin
+ uid: azure.mgmt.rdbms.postgresql.models.OperationOrigin
+ - name: azure.mgmt.rdbms.postgresql.models.PerformanceTierListResult
+ uid: azure.mgmt.rdbms.postgresql.models.PerformanceTierListResult
+ - name: azure.mgmt.rdbms.postgresql.models.PerformanceTierProperties
+ uid: azure.mgmt.rdbms.postgresql.models.PerformanceTierProperties
+ - name: azure.mgmt.rdbms.postgresql.models.PerformanceTierServiceLevelObjectives
+ uid: azure.mgmt.rdbms.postgresql.models.PerformanceTierServiceLevelObjectives
+ - name: azure.mgmt.rdbms.postgresql.models.PrivateEndpointConnection
+ uid: azure.mgmt.rdbms.postgresql.models.PrivateEndpointConnection
+ - name: azure.mgmt.rdbms.postgresql.models.PrivateEndpointConnectionListResult
+ uid: azure.mgmt.rdbms.postgresql.models.PrivateEndpointConnectionListResult
+ - name: azure.mgmt.rdbms.postgresql.models.PrivateEndpointProperty
+ uid: azure.mgmt.rdbms.postgresql.models.PrivateEndpointProperty
+ - name: azure.mgmt.rdbms.postgresql.models.PrivateEndpointProvisioningState
+ uid: azure.mgmt.rdbms.postgresql.models.PrivateEndpointProvisioningState
+ - name: azure.mgmt.rdbms.postgresql.models.PrivateLinkResource
+ uid: azure.mgmt.rdbms.postgresql.models.PrivateLinkResource
+ - name: azure.mgmt.rdbms.postgresql.models.PrivateLinkResourceListResult
+ uid: azure.mgmt.rdbms.postgresql.models.PrivateLinkResourceListResult
+ - name: azure.mgmt.rdbms.postgresql.models.PrivateLinkResourceProperties
+ uid: azure.mgmt.rdbms.postgresql.models.PrivateLinkResourceProperties
+ - name: azure.mgmt.rdbms.postgresql.models.PrivateLinkServiceConnectionStateActionsRequire
+ uid: azure.mgmt.rdbms.postgresql.models.PrivateLinkServiceConnectionStateActionsRequire
+ - name: azure.mgmt.rdbms.postgresql.models.PrivateLinkServiceConnectionStateProperty
+ uid: azure.mgmt.rdbms.postgresql.models.PrivateLinkServiceConnectionStateProperty
+ - name: azure.mgmt.rdbms.postgresql.models.PrivateLinkServiceConnectionStateStatus
+ uid: azure.mgmt.rdbms.postgresql.models.PrivateLinkServiceConnectionStateStatus
+ - name: azure.mgmt.rdbms.postgresql.models.ProxyResource
+ uid: azure.mgmt.rdbms.postgresql.models.ProxyResource
+ - name: azure.mgmt.rdbms.postgresql.models.PublicNetworkAccessEnum
+ uid: azure.mgmt.rdbms.postgresql.models.PublicNetworkAccessEnum
+ - name: azure.mgmt.rdbms.postgresql.models.RecoverableServerResource
+ uid: azure.mgmt.rdbms.postgresql.models.RecoverableServerResource
+ - name: azure.mgmt.rdbms.postgresql.models.Resource
+ uid: azure.mgmt.rdbms.postgresql.models.Resource
+ - name: azure.mgmt.rdbms.postgresql.models.ResourceIdentity
+ uid: azure.mgmt.rdbms.postgresql.models.ResourceIdentity
+ - name: azure.mgmt.rdbms.postgresql.models.SecurityAlertPolicyName
+ uid: azure.mgmt.rdbms.postgresql.models.SecurityAlertPolicyName
+ - name: azure.mgmt.rdbms.postgresql.models.Server
+ uid: azure.mgmt.rdbms.postgresql.models.Server
+ - name: azure.mgmt.rdbms.postgresql.models.ServerAdministratorResource
+ uid: azure.mgmt.rdbms.postgresql.models.ServerAdministratorResource
+ - name: azure.mgmt.rdbms.postgresql.models.ServerAdministratorResourceListResult
+ uid: azure.mgmt.rdbms.postgresql.models.ServerAdministratorResourceListResult
+ - name: azure.mgmt.rdbms.postgresql.models.ServerForCreate
+ uid: azure.mgmt.rdbms.postgresql.models.ServerForCreate
+ - name: azure.mgmt.rdbms.postgresql.models.ServerKey
+ uid: azure.mgmt.rdbms.postgresql.models.ServerKey
+ - name: azure.mgmt.rdbms.postgresql.models.ServerKeyListResult
+ uid: azure.mgmt.rdbms.postgresql.models.ServerKeyListResult
+ - name: azure.mgmt.rdbms.postgresql.models.ServerKeyType
+ uid: azure.mgmt.rdbms.postgresql.models.ServerKeyType
+ - name: azure.mgmt.rdbms.postgresql.models.ServerListResult
+ uid: azure.mgmt.rdbms.postgresql.models.ServerListResult
+ - name: azure.mgmt.rdbms.postgresql.models.ServerPrivateEndpointConnection
+ uid: azure.mgmt.rdbms.postgresql.models.ServerPrivateEndpointConnection
+ - name: azure.mgmt.rdbms.postgresql.models.ServerPrivateEndpointConnectionProperties
+ uid: azure.mgmt.rdbms.postgresql.models.ServerPrivateEndpointConnectionProperties
+ - name: azure.mgmt.rdbms.postgresql.models.ServerPrivateLinkServiceConnectionStateProperty
+ uid: azure.mgmt.rdbms.postgresql.models.ServerPrivateLinkServiceConnectionStateProperty
+ - name: azure.mgmt.rdbms.postgresql.models.ServerPropertiesForCreate
+ uid: azure.mgmt.rdbms.postgresql.models.ServerPropertiesForCreate
+ - name: azure.mgmt.rdbms.postgresql.models.ServerPropertiesForDefaultCreate
+ uid: azure.mgmt.rdbms.postgresql.models.ServerPropertiesForDefaultCreate
+ - name: azure.mgmt.rdbms.postgresql.models.ServerPropertiesForGeoRestore
+ uid: azure.mgmt.rdbms.postgresql.models.ServerPropertiesForGeoRestore
+ - name: azure.mgmt.rdbms.postgresql.models.ServerPropertiesForReplica
+ uid: azure.mgmt.rdbms.postgresql.models.ServerPropertiesForReplica
+ - name: azure.mgmt.rdbms.postgresql.models.ServerPropertiesForRestore
+ uid: azure.mgmt.rdbms.postgresql.models.ServerPropertiesForRestore
+ - name: azure.mgmt.rdbms.postgresql.models.ServerSecurityAlertPolicy
+ uid: azure.mgmt.rdbms.postgresql.models.ServerSecurityAlertPolicy
+ - name: azure.mgmt.rdbms.postgresql.models.ServerSecurityAlertPolicyListResult
+ uid: azure.mgmt.rdbms.postgresql.models.ServerSecurityAlertPolicyListResult
+ - name: azure.mgmt.rdbms.postgresql.models.ServerSecurityAlertPolicyState
+ uid: azure.mgmt.rdbms.postgresql.models.ServerSecurityAlertPolicyState
+ - name: azure.mgmt.rdbms.postgresql.models.ServerState
+ uid: azure.mgmt.rdbms.postgresql.models.ServerState
+ - name: azure.mgmt.rdbms.postgresql.models.ServerUpdateParameters
+ uid: azure.mgmt.rdbms.postgresql.models.ServerUpdateParameters
+ - name: azure.mgmt.rdbms.postgresql.models.ServerVersion
+ uid: azure.mgmt.rdbms.postgresql.models.ServerVersion
+ - name: azure.mgmt.rdbms.postgresql.models.Sku
+ uid: azure.mgmt.rdbms.postgresql.models.Sku
+ - name: azure.mgmt.rdbms.postgresql.models.SkuTier
+ uid: azure.mgmt.rdbms.postgresql.models.SkuTier
+ - name: azure.mgmt.rdbms.postgresql.models.SslEnforcementEnum
+ uid: azure.mgmt.rdbms.postgresql.models.SslEnforcementEnum
+ - name: azure.mgmt.rdbms.postgresql.models.StorageAutogrow
+ uid: azure.mgmt.rdbms.postgresql.models.StorageAutogrow
+ - name: azure.mgmt.rdbms.postgresql.models.StorageProfile
+ uid: azure.mgmt.rdbms.postgresql.models.StorageProfile
+ - name: azure.mgmt.rdbms.postgresql.models.TagsObject
+ uid: azure.mgmt.rdbms.postgresql.models.TagsObject
+ - name: azure.mgmt.rdbms.postgresql.models.TrackedResource
+ uid: azure.mgmt.rdbms.postgresql.models.TrackedResource
+ - name: azure.mgmt.rdbms.postgresql.models.VirtualNetworkRule
+ uid: azure.mgmt.rdbms.postgresql.models.VirtualNetworkRule
+ - name: azure.mgmt.rdbms.postgresql.models.VirtualNetworkRuleListResult
+ uid: azure.mgmt.rdbms.postgresql.models.VirtualNetworkRuleListResult
+ - name: azure.mgmt.rdbms.postgresql.models.VirtualNetworkRuleState
+ uid: azure.mgmt.rdbms.postgresql.models.VirtualNetworkRuleState
+ name: azure.mgmt.rdbms.postgresql.models
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.postgresql.operations
+ - name: azure.mgmt.rdbms.postgresql.operations.CheckNameAvailabilityOperations
+ uid: azure.mgmt.rdbms.postgresql.operations.CheckNameAvailabilityOperations
+ - name: azure.mgmt.rdbms.postgresql.operations.ConfigurationsOperations
+ uid: azure.mgmt.rdbms.postgresql.operations.ConfigurationsOperations
+ - name: azure.mgmt.rdbms.postgresql.operations.DatabasesOperations
+ uid: azure.mgmt.rdbms.postgresql.operations.DatabasesOperations
+ - name: azure.mgmt.rdbms.postgresql.operations.FirewallRulesOperations
+ uid: azure.mgmt.rdbms.postgresql.operations.FirewallRulesOperations
+ - name: azure.mgmt.rdbms.postgresql.operations.LocationBasedPerformanceTierOperations
+ uid: azure.mgmt.rdbms.postgresql.operations.LocationBasedPerformanceTierOperations
+ - name: azure.mgmt.rdbms.postgresql.operations.LogFilesOperations
+ uid: azure.mgmt.rdbms.postgresql.operations.LogFilesOperations
+ - name: azure.mgmt.rdbms.postgresql.operations.Operations
+ uid: azure.mgmt.rdbms.postgresql.operations.Operations
+ - name: azure.mgmt.rdbms.postgresql.operations.PrivateEndpointConnectionsOperations
+ uid: azure.mgmt.rdbms.postgresql.operations.PrivateEndpointConnectionsOperations
+ - name: azure.mgmt.rdbms.postgresql.operations.PrivateLinkResourcesOperations
+ uid: azure.mgmt.rdbms.postgresql.operations.PrivateLinkResourcesOperations
+ - name: azure.mgmt.rdbms.postgresql.operations.RecoverableServersOperations
+ uid: azure.mgmt.rdbms.postgresql.operations.RecoverableServersOperations
+ - name: azure.mgmt.rdbms.postgresql.operations.ReplicasOperations
+ uid: azure.mgmt.rdbms.postgresql.operations.ReplicasOperations
+ - name: azure.mgmt.rdbms.postgresql.operations.ServerAdministratorsOperations
+ uid: azure.mgmt.rdbms.postgresql.operations.ServerAdministratorsOperations
+ - name: azure.mgmt.rdbms.postgresql.operations.ServerBasedPerformanceTierOperations
+ uid: azure.mgmt.rdbms.postgresql.operations.ServerBasedPerformanceTierOperations
+ - name: azure.mgmt.rdbms.postgresql.operations.ServerKeysOperations
+ uid: azure.mgmt.rdbms.postgresql.operations.ServerKeysOperations
+ - name: azure.mgmt.rdbms.postgresql.operations.ServerParametersOperations
+ uid: azure.mgmt.rdbms.postgresql.operations.ServerParametersOperations
+ - name: azure.mgmt.rdbms.postgresql.operations.ServerSecurityAlertPoliciesOperations
+ uid: azure.mgmt.rdbms.postgresql.operations.ServerSecurityAlertPoliciesOperations
+ - name: azure.mgmt.rdbms.postgresql.operations.ServersOperations
+ uid: azure.mgmt.rdbms.postgresql.operations.ServersOperations
+ - name: azure.mgmt.rdbms.postgresql.operations.VirtualNetworkRulesOperations
+ uid: azure.mgmt.rdbms.postgresql.operations.VirtualNetworkRulesOperations
+ name: azure.mgmt.rdbms.postgresql.operations
+ - name: azure.mgmt.rdbms.postgresql.PostgreSQLManagementClient
+ uid: azure.mgmt.rdbms.postgresql.PostgreSQLManagementClient
+ name: azure.mgmt.rdbms.postgresql
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.AdministratorsOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.AdministratorsOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.BackupsOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.BackupsOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.CheckNameAvailabilityOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.CheckNameAvailabilityOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.CheckNameAvailabilityWithLocationOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.CheckNameAvailabilityWithLocationOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.ConfigurationsOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.ConfigurationsOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.DatabasesOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.DatabasesOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.FirewallRulesOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.FirewallRulesOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.FlexibleServerOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.FlexibleServerOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.GetPrivateDnsZoneSuffixOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.GetPrivateDnsZoneSuffixOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.LocationBasedCapabilitiesOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.LocationBasedCapabilitiesOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.LogFilesOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.LogFilesOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.LtrBackupOperationsOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.LtrBackupOperationsOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.MigrationsOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.MigrationsOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.Operations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.Operations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.PostgreSQLManagementClientOperationsMixin
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.PostgreSQLManagementClientOperationsMixin
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.ReplicasOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.ReplicasOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.ServerCapabilitiesOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.ServerCapabilitiesOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.ServersOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.ServersOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.VirtualNetworkSubnetUsageOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations.VirtualNetworkSubnetUsageOperations
+ name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.operations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.aio.PostgreSQLManagementClient
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.aio.PostgreSQLManagementClient
+ name: azure.mgmt.rdbms.postgresql_flexibleservers.aio
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ActiveDirectoryAdministrator
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ActiveDirectoryAdministrator
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ActiveDirectoryAdministratorAdd
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ActiveDirectoryAdministratorAdd
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ActiveDirectoryAuthEnum
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ActiveDirectoryAuthEnum
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.AdminCredentials
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.AdminCredentials
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.AdministratorListResult
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.AdministratorListResult
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ArmServerKeyType
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ArmServerKeyType
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.AuthConfig
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.AuthConfig
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.AzureManagedDiskPerformanceTiers
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.AzureManagedDiskPerformanceTiers
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.Backup
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.Backup
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.BackupRequestBase
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.BackupRequestBase
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.BackupSettings
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.BackupSettings
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.BackupStoreDetails
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.BackupStoreDetails
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.CancelEnum
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.CancelEnum
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.CapabilitiesListResult
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.CapabilitiesListResult
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.CapabilityBase
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.CapabilityBase
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.CapabilityStatus
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.CapabilityStatus
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.CheckNameAvailabilityReason
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.CheckNameAvailabilityReason
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.CheckNameAvailabilityRequest
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.CheckNameAvailabilityRequest
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.CheckNameAvailabilityResponse
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.CheckNameAvailabilityResponse
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.Configuration
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.Configuration
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ConfigurationDataType
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ConfigurationDataType
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ConfigurationForUpdate
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ConfigurationForUpdate
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ConfigurationListResult
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ConfigurationListResult
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.CreateMode
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.CreateMode
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.CreateModeForUpdate
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.CreateModeForUpdate
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.CreatedByType
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.CreatedByType
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.DataEncryption
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.DataEncryption
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.Database
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.Database
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.DatabaseListResult
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.DatabaseListResult
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.DbServerMetadata
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.DbServerMetadata
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.DelegatedSubnetUsage
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.DelegatedSubnetUsage
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ErrorAdditionalInfo
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ErrorAdditionalInfo
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ErrorDetail
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ErrorDetail
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ErrorResponse
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ErrorResponse
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ExecutionStatus
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ExecutionStatus
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.FailoverMode
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.FailoverMode
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.FastProvisioningEditionCapability
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.FastProvisioningEditionCapability
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.FastProvisioningSupportedEnum
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.FastProvisioningSupportedEnum
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.FirewallRule
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.FirewallRule
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.FirewallRuleListResult
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.FirewallRuleListResult
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.FlexibleServerCapability
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.FlexibleServerCapability
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.FlexibleServerEditionCapability
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.FlexibleServerEditionCapability
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.GeoBackupSupportedEnum
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.GeoBackupSupportedEnum
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.GeoRedundantBackupEnum
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.GeoRedundantBackupEnum
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.HaMode
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.HaMode
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.HighAvailability
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.HighAvailability
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.HighAvailabilityMode
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.HighAvailabilityMode
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.IdentityType
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.IdentityType
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.KeyStatusEnum
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.KeyStatusEnum
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.LogFile
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.LogFile
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.LogFileListResult
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.LogFileListResult
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.LogicalReplicationOnSourceDbEnum
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.LogicalReplicationOnSourceDbEnum
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrBackupRequest
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrBackupRequest
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrBackupResponse
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrBackupResponse
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrPreBackupRequest
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrPreBackupRequest
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrPreBackupResponse
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrPreBackupResponse
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrServerBackupOperation
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrServerBackupOperation
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrServerBackupOperationList
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.LtrServerBackupOperationList
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MaintenanceWindow
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MaintenanceWindow
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationDetailsLevel
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationDetailsLevel
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationListFilter
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationListFilter
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationMode
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationMode
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationNameAvailabilityReason
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationNameAvailabilityReason
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationNameAvailabilityResource
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationNameAvailabilityResource
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationResource
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationResource
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationResourceForPatch
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationResourceForPatch
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationResourceListResult
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationResourceListResult
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationSecretParameters
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationSecretParameters
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationState
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationState
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationStatus
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationStatus
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationSubState
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationSubState
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationSubStateDetails
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.MigrationSubStateDetails
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.NameAvailability
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.NameAvailability
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.Network
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.Network
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.OnlineResizeSupportedEnum
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.OnlineResizeSupportedEnum
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.Operation
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.Operation
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.OperationDisplay
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.OperationDisplay
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.OperationListResult
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.OperationListResult
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.OperationOrigin
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.OperationOrigin
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.Origin
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.Origin
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.OverwriteDbsInTargetEnum
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.OverwriteDbsInTargetEnum
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.PasswordAuthEnum
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.PasswordAuthEnum
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.PrincipalType
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.PrincipalType
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ProxyResource
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ProxyResource
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ReplicationRole
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ReplicationRole
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.Resource
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.Resource
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.RestartParameter
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.RestartParameter
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.RestrictedEnum
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.RestrictedEnum
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.Server
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.Server
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerBackup
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerBackup
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerBackupListResult
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerBackupListResult
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerForUpdate
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerForUpdate
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerHAState
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerHAState
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerListResult
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerListResult
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerPublicNetworkAccessState
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerPublicNetworkAccessState
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerSku
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerSku
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerSkuCapability
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerSkuCapability
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerState
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerState
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerVersion
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerVersion
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerVersionCapability
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ServerVersionCapability
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.Sku
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.Sku
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.SkuTier
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.SkuTier
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.StartDataMigrationEnum
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.StartDataMigrationEnum
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.Storage
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.Storage
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.StorageAutoGrow
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.StorageAutoGrow
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.StorageAutoGrowthSupportedEnum
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.StorageAutoGrowthSupportedEnum
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.StorageEditionCapability
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.StorageEditionCapability
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.StorageMbCapability
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.StorageMbCapability
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.StorageTierCapability
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.StorageTierCapability
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.SystemData
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.SystemData
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.TrackedResource
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.TrackedResource
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.TriggerCutoverEnum
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.TriggerCutoverEnum
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.UserAssignedIdentity
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.UserAssignedIdentity
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.UserIdentity
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.UserIdentity
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.VirtualNetworkSubnetUsageParameter
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.VirtualNetworkSubnetUsageParameter
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.VirtualNetworkSubnetUsageResult
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.VirtualNetworkSubnetUsageResult
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ZoneRedundantHaAndGeoBackupSupportedEnum
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ZoneRedundantHaAndGeoBackupSupportedEnum
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.models.ZoneRedundantHaSupportedEnum
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.models.ZoneRedundantHaSupportedEnum
+ name: azure.mgmt.rdbms.postgresql_flexibleservers.models
+ - items:
+ - name: Overview
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.AdministratorsOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.AdministratorsOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.BackupsOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.BackupsOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.CheckNameAvailabilityOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.CheckNameAvailabilityOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.CheckNameAvailabilityWithLocationOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.CheckNameAvailabilityWithLocationOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.ConfigurationsOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.ConfigurationsOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.DatabasesOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.DatabasesOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.FirewallRulesOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.FirewallRulesOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.FlexibleServerOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.FlexibleServerOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.GetPrivateDnsZoneSuffixOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.GetPrivateDnsZoneSuffixOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.LocationBasedCapabilitiesOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.LocationBasedCapabilitiesOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.LogFilesOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.LogFilesOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.LtrBackupOperationsOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.LtrBackupOperationsOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.MigrationsOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.MigrationsOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.Operations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.Operations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.PostgreSQLManagementClientOperationsMixin
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.PostgreSQLManagementClientOperationsMixin
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.ReplicasOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.ReplicasOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.ServerCapabilitiesOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.ServerCapabilitiesOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.ServersOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.ServersOperations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.operations.VirtualNetworkSubnetUsageOperations
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.operations.VirtualNetworkSubnetUsageOperations
+ name: azure.mgmt.rdbms.postgresql_flexibleservers.operations
+ - name: azure.mgmt.rdbms.postgresql_flexibleservers.PostgreSQLManagementClient
+ uid: azure.mgmt.rdbms.postgresql_flexibleservers.PostgreSQLManagementClient
+ name: azure.mgmt.rdbms.postgresql_flexibleservers
+ name: azure.mgmt.rdbms
name: azure-mgmt-rdbms
-
- items:
- name: Overview
uid: project-azure-mgmt-recoveryservicesbackup
- items:
- name: Overview
- uid: azure.mgmt.recoveryservicesbackup.activestamp
- - items:
- - name: Overview
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio
- - items:
- - name: Overview
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BMSPrepareDataMoveOperationResultOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BMSPrepareDataMoveOperationResultOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupEnginesOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupEnginesOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupJobsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupJobsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupOperationResultsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupOperationResultsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupOperationStatusesOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupOperationStatusesOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupPoliciesOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupPoliciesOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupProtectableItemsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupProtectableItemsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupProtectedItemsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupProtectedItemsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupProtectionContainersOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupProtectionContainersOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupProtectionIntentOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupProtectionIntentOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupResourceEncryptionConfigsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupResourceEncryptionConfigsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupResourceStorageConfigsNonCRROperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupResourceStorageConfigsNonCRROperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupResourceVaultConfigsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupResourceVaultConfigsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupStatusOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupStatusOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupUsageSummariesOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupUsageSummariesOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupWorkloadItemsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupWorkloadItemsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.DeletedProtectionContainersOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.DeletedProtectionContainersOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ExportJobsOperationResultsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ExportJobsOperationResultsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.FeatureSupportOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.FeatureSupportOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ItemLevelRecoveryConnectionsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ItemLevelRecoveryConnectionsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.JobCancellationsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.JobCancellationsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.JobDetailsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.JobDetailsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.JobOperationResultsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.JobOperationResultsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.JobsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.JobsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.OperationOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.OperationOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.Operations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.Operations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.PrivateEndpointConnectionOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.PrivateEndpointConnectionOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.PrivateEndpointOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.PrivateEndpointOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectableContainersOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectableContainersOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectedItemOperationResultsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectedItemOperationResultsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectedItemOperationStatusesOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectedItemOperationStatusesOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectedItemsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectedItemsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionContainerOperationResultsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionContainerOperationResultsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionContainerRefreshOperationResultsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionContainerRefreshOperationResultsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionContainersOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionContainersOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionIntentOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionIntentOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionPoliciesOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionPoliciesOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionPolicyOperationResultsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionPolicyOperationResultsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionPolicyOperationStatusesOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionPolicyOperationStatusesOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.RecoveryPointsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.RecoveryPointsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.RecoveryPointsRecommendedForMoveOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.RecoveryPointsRecommendedForMoveOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.RecoveryServicesBackupClientOperationsMixin
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.RecoveryServicesBackupClientOperationsMixin
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ResourceGuardProxiesOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ResourceGuardProxiesOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ResourceGuardProxyOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ResourceGuardProxyOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.RestoresOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.RestoresOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.SecurityPINsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.SecurityPINsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ValidateOperationOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ValidateOperationOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ValidateOperationResultsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ValidateOperationResultsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ValidateOperationStatusesOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ValidateOperationStatusesOperations
- name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.RecoveryServicesBackupClient
- uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.RecoveryServicesBackupClient
- name: azure.mgmt.recoveryservicesbackup.activestamp.aio
- - items:
- - name: Overview
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AcquireStorageAccountLock
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AcquireStorageAccountLock
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureBackupGoalFeatureSupportRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureBackupGoalFeatureSupportRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureBackupServerContainer
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureBackupServerContainer
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureBackupServerEngine
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureBackupServerEngine
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareBackupRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareBackupRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareProtectableItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareProtectableItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareProtectionPolicy
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareProtectionPolicy
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareProvisionILRRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareProvisionILRRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareRecoveryPoint
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareRecoveryPoint
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareRestoreRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareRestoreRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileshareProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileshareProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileshareProtectedItemExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileshareProtectedItemExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSClassicComputeVMContainer
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSClassicComputeVMContainer
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSClassicComputeVMProtectableItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSClassicComputeVMProtectableItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSClassicComputeVMProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSClassicComputeVMProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSComputeVMContainer
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSComputeVMContainer
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSComputeVMProtectableItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSComputeVMProtectableItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSComputeVMProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSComputeVMProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMErrorInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMErrorInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMHealthDetails
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMHealthDetails
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMJob
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMJob
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMJobExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMJobExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMJobTaskDetails
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMJobTaskDetails
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMJobV2
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMJobV2
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMProtectedItemExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMProtectedItemExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMProtectionPolicy
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMProtectionPolicy
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureRecoveryServiceVaultProtectionIntent
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureRecoveryServiceVaultProtectionIntent
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureResourceProtectionIntent
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureResourceProtectionIntent
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureSQLAGWorkloadContainerProtectionContainer
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureSQLAGWorkloadContainerProtectionContainer
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureSqlContainer
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureSqlContainer
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureSqlProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureSqlProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureSqlProtectedItemExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureSqlProtectedItemExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureSqlProtectionPolicy
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureSqlProtectionPolicy
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageContainer
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageContainer
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageErrorInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageErrorInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageJob
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageJob
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageJobExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageJobExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageJobTaskDetails
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageJobTaskDetails
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageProtectableContainer
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageProtectableContainer
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVMAppContainerProtectableContainer
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVMAppContainerProtectableContainer
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVMAppContainerProtectionContainer
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVMAppContainerProtectionContainer
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVMResourceFeatureSupportRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVMResourceFeatureSupportRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVMResourceFeatureSupportResponse
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVMResourceFeatureSupportResponse
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadProtectableItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadProtectableItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadProtectedItemExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadProtectedItemExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadProtectionPolicy
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadProtectionPolicy
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPAseDatabaseProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPAseDatabaseProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPAseDatabaseWorkloadItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPAseDatabaseWorkloadItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPAseSystemProtectableItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPAseSystemProtectableItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPAseSystemWorkloadItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPAseSystemWorkloadItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaDBInstance
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaDBInstance
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaDBInstanceProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaDBInstanceProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaDatabaseProtectableItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaDatabaseProtectableItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaDatabaseProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaDatabaseProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaDatabaseWorkloadItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaDatabaseWorkloadItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaHSR
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaHSR
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaSystemProtectableItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaSystemProtectableItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaSystemWorkloadItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaSystemWorkloadItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLAvailabilityGroupProtectableItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLAvailabilityGroupProtectableItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLDatabaseProtectableItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLDatabaseProtectableItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLDatabaseProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLDatabaseProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLDatabaseWorkloadItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLDatabaseWorkloadItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLInstanceProtectableItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLInstanceProtectableItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLInstanceWorkloadItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLInstanceWorkloadItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadAutoProtectionIntent
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadAutoProtectionIntent
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadBackupRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadBackupRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadContainer
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadContainer
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadContainerAutoProtectionIntent
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadContainerAutoProtectionIntent
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadContainerExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadContainerExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadErrorInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadErrorInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadJob
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadJob
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadJobExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadJobExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadJobTaskDetails
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadJobTaskDetails
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadPointInTimeRecoveryPoint
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadPointInTimeRecoveryPoint
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadPointInTimeRestoreRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadPointInTimeRestoreRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadRecoveryPoint
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadRecoveryPoint
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadRestoreRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadRestoreRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaPointInTimeRecoveryPoint
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaPointInTimeRecoveryPoint
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaPointInTimeRestoreRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaPointInTimeRestoreRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaPointInTimeRestoreWithRehydrateRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaPointInTimeRestoreWithRehydrateRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaRecoveryPoint
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaRecoveryPoint
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaRestoreRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaRestoreRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaRestoreWithRehydrateRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaRestoreWithRehydrateRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLAutoProtectionIntent
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLAutoProtectionIntent
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLPointInTimeRecoveryPoint
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLPointInTimeRecoveryPoint
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLPointInTimeRestoreRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLPointInTimeRestoreRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLPointInTimeRestoreWithRehydrateRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLPointInTimeRestoreWithRehydrateRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLRecoveryPoint
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLRecoveryPoint
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLRecoveryPointExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLRecoveryPointExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLRestoreRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLRestoreRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLRestoreWithRehydrateRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLRestoreWithRehydrateRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BEKDetails
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BEKDetails
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSBackupEngineQueryObject
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSBackupEngineQueryObject
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSBackupEnginesQueryObject
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSBackupEnginesQueryObject
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSBackupSummariesQueryObject
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSBackupSummariesQueryObject
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSContainerQueryObject
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSContainerQueryObject
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSContainersInquiryQueryObject
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSContainersInquiryQueryObject
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSPOQueryObject
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSPOQueryObject
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSRPQueryObject
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSRPQueryObject
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSRefreshContainersQueryObject
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSRefreshContainersQueryObject
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSWorkloadItemQueryObject
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSWorkloadItemQueryObject
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupEngineBase
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupEngineBase
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupEngineBaseResource
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupEngineBaseResource
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupEngineBaseResourceList
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupEngineBaseResourceList
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupEngineExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupEngineExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupEngineType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupEngineType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupItemType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupItemType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupManagementType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupManagementType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupManagementUsage
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupManagementUsage
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupManagementUsageList
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupManagementUsageList
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupRequestResource
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupRequestResource
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceConfig
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceConfig
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceConfigResource
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceConfigResource
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceEncryptionConfig
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceEncryptionConfig
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceEncryptionConfigExtended
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceEncryptionConfigExtended
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceEncryptionConfigExtendedResource
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceEncryptionConfigExtendedResource
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceEncryptionConfigResource
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceEncryptionConfigResource
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceVaultConfig
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceVaultConfig
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceVaultConfigResource
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceVaultConfigResource
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupStatusRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupStatusRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupStatusResponse
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupStatusResponse
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryDisplay
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryDisplay
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryForLogSpecification
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryForLogSpecification
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryForProperties
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryForProperties
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryForServiceSpecification
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryForServiceSpecification
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryResponse
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryResponse
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryValueForSingleApi
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryValueForSingleApi
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientScriptForConnect
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientScriptForConnect
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.CloudErrorBody
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.CloudErrorBody
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ContainerIdentityInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ContainerIdentityInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ContainerType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ContainerType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.CopyOptions
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.CopyOptions
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.CreateMode
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.CreateMode
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DPMContainerExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DPMContainerExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DPMProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DPMProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DPMProtectedItemExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DPMProtectedItemExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DailyRetentionFormat
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DailyRetentionFormat
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DailyRetentionSchedule
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DailyRetentionSchedule
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DailySchedule
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DailySchedule
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DataMoveLevel
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DataMoveLevel
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DataSourceType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DataSourceType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.Day
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.Day
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DayOfWeek
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DayOfWeek
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DedupState
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DedupState
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DiskExclusionProperties
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DiskExclusionProperties
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DiskInformation
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DiskInformation
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DistributedNodesInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DistributedNodesInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmBackupEngine
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmBackupEngine
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmContainer
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmContainer
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmErrorInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmErrorInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmJob
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmJob
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmJobExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmJobExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmJobTaskDetails
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmJobTaskDetails
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.EncryptionAtRestType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.EncryptionAtRestType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.EncryptionDetails
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.EncryptionDetails
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.EnhancedSecurityState
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.EnhancedSecurityState
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ErrorAdditionalInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ErrorAdditionalInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ErrorDetail
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ErrorDetail
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ExportJobsOperationResultInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ExportJobsOperationResultInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ExtendedProperties
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ExtendedProperties
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.FabricName
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.FabricName
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.FeatureSupportRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.FeatureSupportRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.GenericContainer
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.GenericContainer
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.GenericContainerExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.GenericContainerExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.GenericProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.GenericProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.GenericProtectionPolicy
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.GenericProtectionPolicy
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.GenericRecoveryPoint
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.GenericRecoveryPoint
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.GetProtectedItemQueryObject
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.GetProtectedItemQueryObject
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.HealthState
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.HealthState
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.HealthStatus
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.HealthStatus
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.HourlySchedule
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.HourlySchedule
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.HttpStatusCode
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.HttpStatusCode
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.IAASVMPolicyType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.IAASVMPolicyType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ILRRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ILRRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ILRRequestResource
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ILRRequestResource
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.IaaSVMContainer
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.IaaSVMContainer
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.IaaSVMProtectableItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.IaaSVMProtectableItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.IaasVMBackupRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.IaasVMBackupRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.IaasVMILRRegistrationRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.IaasVMILRRegistrationRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.IaasVMRecoveryPoint
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.IaasVMRecoveryPoint
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.IaasVMRestoreRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.IaasVMRestoreRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.IaasVMRestoreWithRehydrationRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.IaasVMRestoreWithRehydrationRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.IdentityBasedRestoreDetails
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.IdentityBasedRestoreDetails
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.IdentityInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.IdentityInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.InfrastructureEncryptionState
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.InfrastructureEncryptionState
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.InquiryInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.InquiryInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.InquiryStatus
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.InquiryStatus
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.InquiryValidation
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.InquiryValidation
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.InstantItemRecoveryTarget
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.InstantItemRecoveryTarget
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.InstantRPAdditionalDetails
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.InstantRPAdditionalDetails
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.IntentItemType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.IntentItemType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.Job
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.Job
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.JobOperationType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.JobOperationType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.JobQueryObject
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.JobQueryObject
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.JobResource
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.JobResource
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.JobResourceList
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.JobResourceList
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.JobStatus
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.JobStatus
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.JobSupportedAction
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.JobSupportedAction
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.KEKDetails
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.KEKDetails
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.KPIResourceHealthDetails
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.KPIResourceHealthDetails
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.KeyAndSecretDetails
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.KeyAndSecretDetails
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.LastBackupStatus
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.LastBackupStatus
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.LastUpdateStatus
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.LastUpdateStatus
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ListRecoveryPointsRecommendedForMoveRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ListRecoveryPointsRecommendedForMoveRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.LogSchedulePolicy
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.LogSchedulePolicy
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.LongTermRetentionPolicy
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.LongTermRetentionPolicy
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.LongTermSchedulePolicy
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.LongTermSchedulePolicy
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MABContainerHealthDetails
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MABContainerHealthDetails
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MabContainer
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MabContainer
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MabContainerExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MabContainerExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MabErrorInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MabErrorInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MabFileFolderProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MabFileFolderProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MabFileFolderProtectedItemExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MabFileFolderProtectedItemExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MabJob
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MabJob
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MabJobExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MabJobExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MabJobTaskDetails
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MabJobTaskDetails
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MabProtectionPolicy
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MabProtectionPolicy
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MabServerType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MabServerType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MonthOfYear
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MonthOfYear
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MonthlyRetentionSchedule
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MonthlyRetentionSchedule
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MoveRPAcrossTiersRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MoveRPAcrossTiersRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.NameInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.NameInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.NewErrorResponse
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.NewErrorResponse
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.NewErrorResponseError
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.NewErrorResponseError
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationResultInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationResultInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationResultInfoBase
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationResultInfoBase
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationResultInfoBaseResource
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationResultInfoBaseResource
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatus
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatus
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusError
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusError
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusJobExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusJobExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusJobsExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusJobsExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusProvisionILRExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusProvisionILRExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusValidateOperationExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusValidateOperationExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusValues
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusValues
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationWorkerResponse
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationWorkerResponse
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OverwriteOptions
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OverwriteOptions
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PointInTimeRange
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PointInTimeRange
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PolicyType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PolicyType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PreBackupValidation
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PreBackupValidation
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PreValidateEnableBackupRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PreValidateEnableBackupRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PreValidateEnableBackupResponse
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PreValidateEnableBackupResponse
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PrepareDataMoveRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PrepareDataMoveRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PrepareDataMoveResponse
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PrepareDataMoveResponse
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PrivateEndpoint
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PrivateEndpoint
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PrivateEndpointConnection
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PrivateEndpointConnection
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PrivateEndpointConnectionResource
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PrivateEndpointConnectionResource
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PrivateEndpointConnectionStatus
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PrivateEndpointConnectionStatus
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PrivateLinkServiceConnectionState
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PrivateLinkServiceConnectionState
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectableContainer
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectableContainer
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectableContainerResource
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectableContainerResource
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectableContainerResourceList
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectableContainerResourceList
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectableContainerType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectableContainerType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItemHealthStatus
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItemHealthStatus
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItemQueryObject
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItemQueryObject
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItemResource
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItemResource
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItemResourceList
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItemResourceList
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItemState
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItemState
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionContainer
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionContainer
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionContainerResource
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionContainerResource
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionContainerResourceList
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionContainerResourceList
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionIntent
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionIntent
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionIntentItemType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionIntentItemType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionIntentQueryObject
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionIntentQueryObject
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionIntentResource
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionIntentResource
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionIntentResourceList
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionIntentResourceList
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionPolicy
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionPolicy
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionPolicyQueryObject
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionPolicyQueryObject
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionPolicyResource
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionPolicyResource
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionPolicyResourceList
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionPolicyResourceList
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionState
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionState
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionStatus
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionStatus
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProvisioningState
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProvisioningState
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryMode
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryMode
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPoint
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPoint
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointDiskConfiguration
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointDiskConfiguration
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointMoveReadinessInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointMoveReadinessInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointRehydrationInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointRehydrationInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointResource
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointResource
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointResourceList
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointResourceList
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointTierInformation
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointTierInformation
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointTierInformationV2
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointTierInformationV2
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointTierStatus
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointTierStatus
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointTierType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointTierType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RehydrationPriority
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RehydrationPriority
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.Resource
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.Resource
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceGuardOperationDetail
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceGuardOperationDetail
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceGuardProxyBase
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceGuardProxyBase
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceGuardProxyBaseResource
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceGuardProxyBaseResource
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceGuardProxyBaseResourceList
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceGuardProxyBaseResourceList
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceHealthDetails
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceHealthDetails
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceHealthStatus
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceHealthStatus
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceList
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceList
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RestoreFileSpecs
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RestoreFileSpecs
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RestorePointQueryType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RestorePointQueryType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RestorePointType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RestorePointType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RestoreRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RestoreRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RestoreRequestResource
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RestoreRequestResource
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RestoreRequestType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RestoreRequestType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RetentionDuration
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RetentionDuration
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RetentionDurationType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RetentionDurationType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RetentionPolicy
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RetentionPolicy
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RetentionScheduleFormat
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RetentionScheduleFormat
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.SQLDataDirectory
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.SQLDataDirectory
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.SQLDataDirectoryMapping
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.SQLDataDirectoryMapping
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.SQLDataDirectoryType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.SQLDataDirectoryType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.SchedulePolicy
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.SchedulePolicy
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ScheduleRunType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ScheduleRunType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.SecurityPinBase
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.SecurityPinBase
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.Settings
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.Settings
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.SimpleRetentionPolicy
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.SimpleRetentionPolicy
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.SimpleSchedulePolicy
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.SimpleSchedulePolicy
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.SimpleSchedulePolicyV2
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.SimpleSchedulePolicyV2
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.SoftDeleteFeatureState
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.SoftDeleteFeatureState
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.StorageType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.StorageType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.StorageTypeState
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.StorageTypeState
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.SubProtectionPolicy
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.SubProtectionPolicy
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.SupportStatus
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.SupportStatus
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.TargetAFSRestoreInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.TargetAFSRestoreInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.TargetRestoreInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.TargetRestoreInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.TieringMode
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.TieringMode
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.TieringPolicy
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.TieringPolicy
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.TokenInformation
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.TokenInformation
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.TriggerDataMoveRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.TriggerDataMoveRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.Type
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.Type
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.UnlockDeleteRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.UnlockDeleteRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.UnlockDeleteResponse
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.UnlockDeleteResponse
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.UsagesUnit
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.UsagesUnit
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidateIaasVMRestoreOperationRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidateIaasVMRestoreOperationRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidateOperationRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidateOperationRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidateOperationResponse
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidateOperationResponse
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidateOperationsResponse
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidateOperationsResponse
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidateRestoreOperationRequest
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidateRestoreOperationRequest
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidationStatus
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidationStatus
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.VaultJob
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.VaultJob
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.VaultJobErrorInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.VaultJobErrorInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.VaultJobExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.VaultJobExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.VaultStorageConfigOperationResultResponse
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.VaultStorageConfigOperationResultResponse
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WeekOfMonth
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WeekOfMonth
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WeeklyRetentionFormat
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WeeklyRetentionFormat
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WeeklyRetentionSchedule
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WeeklyRetentionSchedule
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WeeklySchedule
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WeeklySchedule
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadInquiryDetails
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadInquiryDetails
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadItemResource
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadItemResource
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadItemResourceList
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadItemResourceList
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadItemType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadItemType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadProtectableItem
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadProtectableItem
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadProtectableItemResource
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadProtectableItemResource
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadProtectableItemResourceList
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadProtectableItemResourceList
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadType
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadType
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.XcoolState
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.XcoolState
- - name: azure.mgmt.recoveryservicesbackup.activestamp.models.YearlyRetentionSchedule
- uid: azure.mgmt.recoveryservicesbackup.activestamp.models.YearlyRetentionSchedule
- name: azure.mgmt.recoveryservicesbackup.activestamp.models
- - items:
- - name: Overview
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BMSPrepareDataMoveOperationResultOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BMSPrepareDataMoveOperationResultOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupEnginesOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupEnginesOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupJobsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupJobsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupOperationResultsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupOperationResultsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupOperationStatusesOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupOperationStatusesOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupPoliciesOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupPoliciesOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupProtectableItemsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupProtectableItemsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupProtectedItemsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupProtectedItemsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupProtectionContainersOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupProtectionContainersOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupProtectionIntentOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupProtectionIntentOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupResourceEncryptionConfigsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupResourceEncryptionConfigsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupResourceStorageConfigsNonCRROperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupResourceStorageConfigsNonCRROperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupResourceVaultConfigsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupResourceVaultConfigsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupStatusOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupStatusOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupUsageSummariesOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupUsageSummariesOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupWorkloadItemsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupWorkloadItemsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.DeletedProtectionContainersOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.DeletedProtectionContainersOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ExportJobsOperationResultsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ExportJobsOperationResultsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.FeatureSupportOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.FeatureSupportOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ItemLevelRecoveryConnectionsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ItemLevelRecoveryConnectionsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.JobCancellationsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.JobCancellationsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.JobDetailsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.JobDetailsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.JobOperationResultsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.JobOperationResultsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.JobsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.JobsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.OperationOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.OperationOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.Operations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.Operations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.PrivateEndpointConnectionOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.PrivateEndpointConnectionOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.PrivateEndpointOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.PrivateEndpointOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectableContainersOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectableContainersOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectedItemOperationResultsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectedItemOperationResultsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectedItemOperationStatusesOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectedItemOperationStatusesOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectedItemsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectedItemsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionContainerOperationResultsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionContainerOperationResultsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionContainerRefreshOperationResultsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionContainerRefreshOperationResultsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionContainersOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionContainersOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionIntentOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionIntentOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionPoliciesOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionPoliciesOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionPolicyOperationResultsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionPolicyOperationResultsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionPolicyOperationStatusesOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionPolicyOperationStatusesOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.RecoveryPointsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.RecoveryPointsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.RecoveryPointsRecommendedForMoveOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.RecoveryPointsRecommendedForMoveOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.RecoveryServicesBackupClientOperationsMixin
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.RecoveryServicesBackupClientOperationsMixin
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ResourceGuardProxiesOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ResourceGuardProxiesOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ResourceGuardProxyOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ResourceGuardProxyOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.RestoresOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.RestoresOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.SecurityPINsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.SecurityPINsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ValidateOperationOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ValidateOperationOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ValidateOperationResultsOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ValidateOperationResultsOperations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ValidateOperationStatusesOperations
- uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ValidateOperationStatusesOperations
- name: azure.mgmt.recoveryservicesbackup.activestamp.operations
- - name: azure.mgmt.recoveryservicesbackup.activestamp.RecoveryServicesBackupClient
- uid: azure.mgmt.recoveryservicesbackup.activestamp.RecoveryServicesBackupClient
- name: azure.mgmt.recoveryservicesbackup.activestamp
- - items:
- - name: Overview
- uid: azure.mgmt.recoveryservicesbackup.passivestamp
- - items:
- - name: Overview
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio
- - items:
- - name: Overview
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.AadPropertiesOperations
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.AadPropertiesOperations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.BackupCrrJobDetailsOperations
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.BackupCrrJobDetailsOperations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.BackupCrrJobsOperations
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.BackupCrrJobsOperations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.BackupProtectedItemsCrrOperations
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.BackupProtectedItemsCrrOperations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.BackupResourceStorageConfigsOperations
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.BackupResourceStorageConfigsOperations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.BackupUsageSummariesCRROperations
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.BackupUsageSummariesCRROperations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.CrossRegionRestoreOperations
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.CrossRegionRestoreOperations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.CrrOperationResultsOperations
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.CrrOperationResultsOperations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.CrrOperationStatusOperations
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.CrrOperationStatusOperations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.RecoveryPointsCrrOperations
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.RecoveryPointsCrrOperations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.RecoveryPointsOperations
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.RecoveryPointsOperations
- name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.RecoveryServicesBackupPassiveClient
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.RecoveryServicesBackupPassiveClient
- name: azure.mgmt.recoveryservicesbackup.passivestamp.aio
- - items:
- - name: Overview
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AADProperties
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AADProperties
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AADPropertiesResource
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AADPropertiesResource
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureFileShareRecoveryPoint
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureFileShareRecoveryPoint
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureFileShareRestoreRequest
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureFileShareRestoreRequest
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureFileshareProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureFileshareProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureFileshareProtectedItemExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureFileshareProtectedItemExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSClassicComputeVMProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSClassicComputeVMProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSComputeVMProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSComputeVMProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMErrorInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMErrorInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMHealthDetails
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMHealthDetails
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMJob
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMJob
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMJobExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMJobExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMJobTaskDetails
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMJobTaskDetails
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMProtectedItemExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMProtectedItemExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureSqlProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureSqlProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureSqlProtectedItemExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureSqlProtectedItemExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureStorageErrorInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureStorageErrorInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureStorageJob
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureStorageJob
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureStorageJobExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureStorageJobExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureStorageJobTaskDetails
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureStorageJobTaskDetails
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureVmWorkloadProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureVmWorkloadProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureVmWorkloadProtectedItemExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureVmWorkloadProtectedItemExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureVmWorkloadSAPAseDatabaseProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureVmWorkloadSAPAseDatabaseProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureVmWorkloadSAPHanaDatabaseProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureVmWorkloadSAPHanaDatabaseProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureVmWorkloadSQLDatabaseProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureVmWorkloadSQLDatabaseProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadErrorInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadErrorInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadJob
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadJob
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadJobExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadJobExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadJobTaskDetails
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadJobTaskDetails
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadPointInTimeRecoveryPoint
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadPointInTimeRecoveryPoint
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadPointInTimeRestoreRequest
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadPointInTimeRestoreRequest
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadRecoveryPoint
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadRecoveryPoint
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadRestoreRequest
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadRestoreRequest
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSAPHanaPointInTimeRecoveryPoint
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSAPHanaPointInTimeRecoveryPoint
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSAPHanaPointInTimeRestoreRequest
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSAPHanaPointInTimeRestoreRequest
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSAPHanaRecoveryPoint
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSAPHanaRecoveryPoint
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSAPHanaRestoreRequest
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSAPHanaRestoreRequest
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSQLPointInTimeRecoveryPoint
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSQLPointInTimeRecoveryPoint
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSQLPointInTimeRestoreRequest
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSQLPointInTimeRestoreRequest
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSQLRecoveryPoint
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSQLRecoveryPoint
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSQLRecoveryPointExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSQLRecoveryPointExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSQLRestoreRequest
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSQLRestoreRequest
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.BEKDetails
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.BEKDetails
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.BMSAADPropertiesQueryObject
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.BMSAADPropertiesQueryObject
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.BMSBackupSummariesQueryObject
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.BMSBackupSummariesQueryObject
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.BMSRPQueryObject
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.BMSRPQueryObject
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.BackupManagementType
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.BackupManagementType
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.BackupManagementUsage
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.BackupManagementUsage
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.BackupManagementUsageList
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.BackupManagementUsageList
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.BackupResourceConfig
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.BackupResourceConfig
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.BackupResourceConfigResource
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.BackupResourceConfigResource
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ClientScriptForConnect
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ClientScriptForConnect
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.CopyOptions
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.CopyOptions
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.CreateMode
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.CreateMode
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrossRegionRestoreRequest
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrossRegionRestoreRequest
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrossRegionRestoreRequestResource
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrossRegionRestoreRequestResource
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrrAccessToken
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrrAccessToken
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrrAccessTokenResource
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrrAccessTokenResource
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrrJobRequest
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrrJobRequest
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrrJobRequestResource
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrrJobRequestResource
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.DPMProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.DPMProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.DPMProtectedItemExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.DPMProtectedItemExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.DataSourceType
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.DataSourceType
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.DiskExclusionProperties
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.DiskExclusionProperties
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.DiskInformation
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.DiskInformation
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.DpmErrorInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.DpmErrorInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.DpmJob
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.DpmJob
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.DpmJobExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.DpmJobExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.DpmJobTaskDetails
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.DpmJobTaskDetails
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.EncryptionDetails
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.EncryptionDetails
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ErrorAdditionalInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ErrorAdditionalInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ErrorDetail
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ErrorDetail
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ExtendedProperties
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ExtendedProperties
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.GenericProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.GenericProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.GenericRecoveryPoint
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.GenericRecoveryPoint
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.HealthState
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.HealthState
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.HealthStatus
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.HealthStatus
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.IaasVMRecoveryPoint
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.IaasVMRecoveryPoint
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.IaasVMRestoreRequest
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.IaasVMRestoreRequest
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.IdentityBasedRestoreDetails
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.IdentityBasedRestoreDetails
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.IdentityInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.IdentityInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.InstantItemRecoveryTarget
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.InstantItemRecoveryTarget
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.Job
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.Job
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobOperationType
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobOperationType
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobQueryObject
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobQueryObject
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobResource
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobResource
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobResourceList
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobResourceList
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobStatus
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobStatus
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobSupportedAction
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobSupportedAction
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.KEKDetails
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.KEKDetails
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.KPIResourceHealthDetails
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.KPIResourceHealthDetails
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.KeyAndSecretDetails
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.KeyAndSecretDetails
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.LastBackupStatus
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.LastBackupStatus
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabErrorInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabErrorInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabFileFolderProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabFileFolderProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabFileFolderProtectedItemExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabFileFolderProtectedItemExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabJob
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabJob
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabJobExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabJobExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabJobTaskDetails
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabJobTaskDetails
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabServerType
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabServerType
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.NameInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.NameInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.NewErrorResponse
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.NewErrorResponse
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.NewErrorResponseError
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.NewErrorResponseError
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatus
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatus
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusError
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusError
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusJobExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusJobExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusJobsExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusJobsExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusProvisionILRExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusProvisionILRExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusRecoveryPointExtendedInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusRecoveryPointExtendedInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusValues
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusValues
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.OverwriteOptions
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.OverwriteOptions
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.PointInTimeRange
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.PointInTimeRange
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItem
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItem
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItemHealthStatus
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItemHealthStatus
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItemQueryObject
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItemQueryObject
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItemResource
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItemResource
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItemResourceList
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItemResourceList
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItemState
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItemState
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectionState
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectionState
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryMode
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryMode
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPoint
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPoint
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointDiskConfiguration
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointDiskConfiguration
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointMoveReadinessInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointMoveReadinessInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointResource
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointResource
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointResourceList
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointResourceList
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointTierInformation
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointTierInformation
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointTierStatus
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointTierStatus
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointTierType
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointTierType
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryType
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryType
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.Resource
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.Resource
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ResourceHealthDetails
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ResourceHealthDetails
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ResourceHealthStatus
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ResourceHealthStatus
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ResourceList
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ResourceList
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RestoreFileSpecs
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RestoreFileSpecs
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RestorePointQueryType
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RestorePointQueryType
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RestorePointType
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RestorePointType
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RestoreRequest
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RestoreRequest
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RestoreRequestType
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RestoreRequestType
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.SQLDataDirectory
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.SQLDataDirectory
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.SQLDataDirectoryMapping
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.SQLDataDirectoryMapping
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.SQLDataDirectoryType
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.SQLDataDirectoryType
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.StorageType
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.StorageType
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.StorageTypeState
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.StorageTypeState
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.TargetAFSRestoreInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.TargetAFSRestoreInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.TargetRestoreInfo
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.TargetRestoreInfo
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.Type
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.Type
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.UsagesUnit
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.UsagesUnit
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.WorkloadCrrAccessToken
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.WorkloadCrrAccessToken
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.WorkloadType
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.WorkloadType
- name: azure.mgmt.recoveryservicesbackup.passivestamp.models
- - items:
- - name: Overview
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.operations.AadPropertiesOperations
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations.AadPropertiesOperations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.operations.BackupCrrJobDetailsOperations
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations.BackupCrrJobDetailsOperations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.operations.BackupCrrJobsOperations
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations.BackupCrrJobsOperations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.operations.BackupProtectedItemsCrrOperations
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations.BackupProtectedItemsCrrOperations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.operations.BackupResourceStorageConfigsOperations
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations.BackupResourceStorageConfigsOperations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.operations.BackupUsageSummariesCRROperations
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations.BackupUsageSummariesCRROperations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.operations.CrossRegionRestoreOperations
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations.CrossRegionRestoreOperations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.operations.CrrOperationResultsOperations
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations.CrrOperationResultsOperations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.operations.CrrOperationStatusOperations
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations.CrrOperationStatusOperations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.operations.RecoveryPointsCrrOperations
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations.RecoveryPointsCrrOperations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.operations.RecoveryPointsOperations
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations.RecoveryPointsOperations
- name: azure.mgmt.recoveryservicesbackup.passivestamp.operations
- - name: azure.mgmt.recoveryservicesbackup.passivestamp.RecoveryServicesBackupPassiveClient
- uid: azure.mgmt.recoveryservicesbackup.passivestamp.RecoveryServicesBackupPassiveClient
- name: azure.mgmt.recoveryservicesbackup.passivestamp
+ uid: azure.mgmt.recoveryservicesbackup
+ - items:
+ - name: Overview
+ uid: azure.mgmt.recoveryservicesbackup.activestamp
+ - items:
+ - name: Overview
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio
+ - items:
+ - name: Overview
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BMSPrepareDataMoveOperationResultOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BMSPrepareDataMoveOperationResultOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupEnginesOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupEnginesOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupJobsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupJobsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupOperationResultsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupOperationResultsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupOperationStatusesOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupOperationStatusesOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupPoliciesOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupPoliciesOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupProtectableItemsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupProtectableItemsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupProtectedItemsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupProtectedItemsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupProtectionContainersOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupProtectionContainersOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupProtectionIntentOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupProtectionIntentOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupResourceEncryptionConfigsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupResourceEncryptionConfigsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupResourceStorageConfigsNonCRROperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupResourceStorageConfigsNonCRROperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupResourceVaultConfigsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupResourceVaultConfigsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupStatusOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupStatusOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupUsageSummariesOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupUsageSummariesOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupWorkloadItemsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupWorkloadItemsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.BackupsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.DeletedProtectionContainersOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.DeletedProtectionContainersOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ExportJobsOperationResultsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ExportJobsOperationResultsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.FeatureSupportOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.FeatureSupportOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ItemLevelRecoveryConnectionsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ItemLevelRecoveryConnectionsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.JobCancellationsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.JobCancellationsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.JobDetailsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.JobDetailsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.JobOperationResultsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.JobOperationResultsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.JobsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.JobsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.OperationOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.OperationOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.Operations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.Operations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.PrivateEndpointConnectionOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.PrivateEndpointConnectionOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.PrivateEndpointOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.PrivateEndpointOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectableContainersOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectableContainersOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectedItemOperationResultsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectedItemOperationResultsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectedItemOperationStatusesOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectedItemOperationStatusesOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectedItemsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectedItemsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionContainerOperationResultsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionContainerOperationResultsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionContainerRefreshOperationResultsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionContainerRefreshOperationResultsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionContainersOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionContainersOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionIntentOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionIntentOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionPoliciesOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionPoliciesOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionPolicyOperationResultsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionPolicyOperationResultsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionPolicyOperationStatusesOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ProtectionPolicyOperationStatusesOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.RecoveryPointsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.RecoveryPointsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.RecoveryPointsRecommendedForMoveOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.RecoveryPointsRecommendedForMoveOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.RecoveryServicesBackupClientOperationsMixin
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.RecoveryServicesBackupClientOperationsMixin
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ResourceGuardProxiesOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ResourceGuardProxiesOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ResourceGuardProxyOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ResourceGuardProxyOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.RestoresOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.RestoresOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.SecurityPINsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.SecurityPINsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ValidateOperationOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ValidateOperationOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ValidateOperationResultsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ValidateOperationResultsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ValidateOperationStatusesOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations.ValidateOperationStatusesOperations
+ name: azure.mgmt.recoveryservicesbackup.activestamp.aio.operations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.aio.RecoveryServicesBackupClient
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.aio.RecoveryServicesBackupClient
+ name: azure.mgmt.recoveryservicesbackup.activestamp.aio
+ - items:
+ - name: Overview
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AcquireStorageAccountLock
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AcquireStorageAccountLock
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureBackupGoalFeatureSupportRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureBackupGoalFeatureSupportRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureBackupServerContainer
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureBackupServerContainer
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureBackupServerEngine
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureBackupServerEngine
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareBackupRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareBackupRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareProtectableItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareProtectableItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareProtectionPolicy
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareProtectionPolicy
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareProvisionILRRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareProvisionILRRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareRecoveryPoint
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareRecoveryPoint
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareRestoreRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareRestoreRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileShareType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileshareProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileshareProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileshareProtectedItemExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureFileshareProtectedItemExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSClassicComputeVMContainer
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSClassicComputeVMContainer
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSClassicComputeVMProtectableItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSClassicComputeVMProtectableItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSClassicComputeVMProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSClassicComputeVMProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSComputeVMContainer
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSComputeVMContainer
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSComputeVMProtectableItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSComputeVMProtectableItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSComputeVMProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSComputeVMProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMErrorInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMErrorInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMHealthDetails
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMHealthDetails
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMJob
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMJob
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMJobExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMJobExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMJobTaskDetails
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMJobTaskDetails
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMJobV2
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMJobV2
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMProtectedItemExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMProtectedItemExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMProtectionPolicy
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureIaaSVMProtectionPolicy
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureRecoveryServiceVaultProtectionIntent
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureRecoveryServiceVaultProtectionIntent
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureResourceProtectionIntent
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureResourceProtectionIntent
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureSQLAGWorkloadContainerProtectionContainer
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureSQLAGWorkloadContainerProtectionContainer
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureSqlContainer
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureSqlContainer
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureSqlProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureSqlProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureSqlProtectedItemExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureSqlProtectedItemExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureSqlProtectionPolicy
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureSqlProtectionPolicy
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageContainer
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageContainer
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageErrorInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageErrorInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageJob
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageJob
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageJobExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageJobExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageJobTaskDetails
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageJobTaskDetails
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageProtectableContainer
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureStorageProtectableContainer
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVMAppContainerProtectableContainer
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVMAppContainerProtectableContainer
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVMAppContainerProtectionContainer
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVMAppContainerProtectionContainer
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVMResourceFeatureSupportRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVMResourceFeatureSupportRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVMResourceFeatureSupportResponse
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVMResourceFeatureSupportResponse
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadProtectableItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadProtectableItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadProtectedItemExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadProtectedItemExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadProtectionPolicy
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadProtectionPolicy
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPAseDatabaseProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPAseDatabaseProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPAseDatabaseWorkloadItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPAseDatabaseWorkloadItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPAseSystemProtectableItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPAseSystemProtectableItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPAseSystemWorkloadItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPAseSystemWorkloadItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaDBInstance
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaDBInstance
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaDBInstanceProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaDBInstanceProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaDatabaseProtectableItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaDatabaseProtectableItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaDatabaseProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaDatabaseProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaDatabaseWorkloadItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaDatabaseWorkloadItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaHSR
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaHSR
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaSystemProtectableItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaSystemProtectableItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaSystemWorkloadItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSAPHanaSystemWorkloadItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLAvailabilityGroupProtectableItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLAvailabilityGroupProtectableItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLDatabaseProtectableItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLDatabaseProtectableItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLDatabaseProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLDatabaseProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLDatabaseWorkloadItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLDatabaseWorkloadItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLInstanceProtectableItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLInstanceProtectableItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLInstanceWorkloadItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureVmWorkloadSQLInstanceWorkloadItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadAutoProtectionIntent
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadAutoProtectionIntent
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadBackupRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadBackupRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadContainer
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadContainer
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadContainerAutoProtectionIntent
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadContainerAutoProtectionIntent
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadContainerExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadContainerExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadErrorInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadErrorInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadJob
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadJob
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadJobExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadJobExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadJobTaskDetails
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadJobTaskDetails
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadPointInTimeRecoveryPoint
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadPointInTimeRecoveryPoint
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadPointInTimeRestoreRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadPointInTimeRestoreRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadRecoveryPoint
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadRecoveryPoint
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadRestoreRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadRestoreRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaPointInTimeRecoveryPoint
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaPointInTimeRecoveryPoint
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaPointInTimeRestoreRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaPointInTimeRestoreRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaPointInTimeRestoreWithRehydrateRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaPointInTimeRestoreWithRehydrateRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaRecoveryPoint
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaRecoveryPoint
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaRestoreRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaRestoreRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaRestoreWithRehydrateRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSAPHanaRestoreWithRehydrateRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLAutoProtectionIntent
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLAutoProtectionIntent
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLPointInTimeRecoveryPoint
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLPointInTimeRecoveryPoint
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLPointInTimeRestoreRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLPointInTimeRestoreRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLPointInTimeRestoreWithRehydrateRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLPointInTimeRestoreWithRehydrateRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLRecoveryPoint
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLRecoveryPoint
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLRecoveryPointExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLRecoveryPointExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLRestoreRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLRestoreRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLRestoreWithRehydrateRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.AzureWorkloadSQLRestoreWithRehydrateRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BEKDetails
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BEKDetails
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSBackupEngineQueryObject
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSBackupEngineQueryObject
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSBackupEnginesQueryObject
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSBackupEnginesQueryObject
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSBackupSummariesQueryObject
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSBackupSummariesQueryObject
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSContainerQueryObject
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSContainerQueryObject
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSContainersInquiryQueryObject
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSContainersInquiryQueryObject
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSPOQueryObject
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSPOQueryObject
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSRPQueryObject
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSRPQueryObject
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSRefreshContainersQueryObject
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSRefreshContainersQueryObject
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSWorkloadItemQueryObject
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BMSWorkloadItemQueryObject
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupEngineBase
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupEngineBase
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupEngineBaseResource
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupEngineBaseResource
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupEngineBaseResourceList
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupEngineBaseResourceList
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupEngineExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupEngineExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupEngineType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupEngineType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupItemType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupItemType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupManagementType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupManagementType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupManagementUsage
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupManagementUsage
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupManagementUsageList
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupManagementUsageList
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupRequestResource
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupRequestResource
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceConfig
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceConfig
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceConfigResource
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceConfigResource
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceEncryptionConfig
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceEncryptionConfig
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceEncryptionConfigExtended
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceEncryptionConfigExtended
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceEncryptionConfigExtendedResource
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceEncryptionConfigExtendedResource
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceEncryptionConfigResource
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceEncryptionConfigResource
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceVaultConfig
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceVaultConfig
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceVaultConfigResource
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupResourceVaultConfigResource
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupStatusRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupStatusRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupStatusResponse
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupStatusResponse
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.BackupType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryDisplay
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryDisplay
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryForLogSpecification
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryForLogSpecification
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryForProperties
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryForProperties
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryForServiceSpecification
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryForServiceSpecification
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryResponse
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryResponse
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryValueForSingleApi
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientDiscoveryValueForSingleApi
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientScriptForConnect
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ClientScriptForConnect
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.CloudErrorBody
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.CloudErrorBody
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ContainerIdentityInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ContainerIdentityInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ContainerType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ContainerType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.CopyOptions
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.CopyOptions
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.CreateMode
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.CreateMode
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DPMContainerExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DPMContainerExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DPMProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DPMProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DPMProtectedItemExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DPMProtectedItemExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DailyRetentionFormat
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DailyRetentionFormat
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DailyRetentionSchedule
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DailyRetentionSchedule
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DailySchedule
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DailySchedule
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DataMoveLevel
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DataMoveLevel
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DataSourceType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DataSourceType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.Day
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.Day
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DayOfWeek
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DayOfWeek
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DedupState
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DedupState
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DiskExclusionProperties
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DiskExclusionProperties
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DiskInformation
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DiskInformation
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DistributedNodesInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DistributedNodesInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmBackupEngine
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmBackupEngine
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmContainer
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmContainer
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmErrorInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmErrorInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmJob
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmJob
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmJobExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmJobExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmJobTaskDetails
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.DpmJobTaskDetails
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.EncryptionAtRestType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.EncryptionAtRestType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.EncryptionDetails
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.EncryptionDetails
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.EnhancedSecurityState
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.EnhancedSecurityState
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ErrorAdditionalInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ErrorAdditionalInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ErrorDetail
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ErrorDetail
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ExportJobsOperationResultInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ExportJobsOperationResultInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ExtendedProperties
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ExtendedProperties
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.FabricName
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.FabricName
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.FeatureSupportRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.FeatureSupportRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.GenericContainer
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.GenericContainer
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.GenericContainerExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.GenericContainerExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.GenericProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.GenericProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.GenericProtectionPolicy
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.GenericProtectionPolicy
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.GenericRecoveryPoint
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.GenericRecoveryPoint
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.GetProtectedItemQueryObject
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.GetProtectedItemQueryObject
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.HealthState
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.HealthState
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.HealthStatus
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.HealthStatus
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.HourlySchedule
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.HourlySchedule
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.HttpStatusCode
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.HttpStatusCode
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.IAASVMPolicyType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.IAASVMPolicyType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ILRRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ILRRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ILRRequestResource
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ILRRequestResource
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.IaaSVMContainer
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.IaaSVMContainer
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.IaaSVMProtectableItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.IaaSVMProtectableItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.IaasVMBackupRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.IaasVMBackupRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.IaasVMILRRegistrationRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.IaasVMILRRegistrationRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.IaasVMRecoveryPoint
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.IaasVMRecoveryPoint
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.IaasVMRestoreRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.IaasVMRestoreRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.IaasVMRestoreWithRehydrationRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.IaasVMRestoreWithRehydrationRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.IdentityBasedRestoreDetails
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.IdentityBasedRestoreDetails
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.IdentityInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.IdentityInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.InfrastructureEncryptionState
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.InfrastructureEncryptionState
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.InquiryInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.InquiryInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.InquiryStatus
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.InquiryStatus
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.InquiryValidation
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.InquiryValidation
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.InstantItemRecoveryTarget
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.InstantItemRecoveryTarget
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.InstantRPAdditionalDetails
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.InstantRPAdditionalDetails
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.IntentItemType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.IntentItemType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.Job
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.Job
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.JobOperationType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.JobOperationType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.JobQueryObject
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.JobQueryObject
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.JobResource
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.JobResource
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.JobResourceList
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.JobResourceList
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.JobStatus
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.JobStatus
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.JobSupportedAction
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.JobSupportedAction
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.KEKDetails
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.KEKDetails
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.KPIResourceHealthDetails
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.KPIResourceHealthDetails
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.KeyAndSecretDetails
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.KeyAndSecretDetails
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.LastBackupStatus
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.LastBackupStatus
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.LastUpdateStatus
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.LastUpdateStatus
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ListRecoveryPointsRecommendedForMoveRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ListRecoveryPointsRecommendedForMoveRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.LogSchedulePolicy
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.LogSchedulePolicy
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.LongTermRetentionPolicy
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.LongTermRetentionPolicy
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.LongTermSchedulePolicy
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.LongTermSchedulePolicy
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MABContainerHealthDetails
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MABContainerHealthDetails
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MabContainer
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MabContainer
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MabContainerExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MabContainerExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MabErrorInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MabErrorInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MabFileFolderProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MabFileFolderProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MabFileFolderProtectedItemExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MabFileFolderProtectedItemExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MabJob
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MabJob
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MabJobExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MabJobExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MabJobTaskDetails
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MabJobTaskDetails
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MabProtectionPolicy
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MabProtectionPolicy
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MabServerType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MabServerType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MonthOfYear
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MonthOfYear
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MonthlyRetentionSchedule
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MonthlyRetentionSchedule
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.MoveRPAcrossTiersRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.MoveRPAcrossTiersRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.NameInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.NameInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.NewErrorResponse
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.NewErrorResponse
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.NewErrorResponseError
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.NewErrorResponseError
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationResultInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationResultInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationResultInfoBase
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationResultInfoBase
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationResultInfoBaseResource
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationResultInfoBaseResource
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatus
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatus
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusError
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusError
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusJobExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusJobExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusJobsExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusJobsExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusProvisionILRExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusProvisionILRExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusValidateOperationExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusValidateOperationExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusValues
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationStatusValues
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationWorkerResponse
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OperationWorkerResponse
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.OverwriteOptions
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.OverwriteOptions
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PointInTimeRange
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PointInTimeRange
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PolicyType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PolicyType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PreBackupValidation
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PreBackupValidation
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PreValidateEnableBackupRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PreValidateEnableBackupRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PreValidateEnableBackupResponse
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PreValidateEnableBackupResponse
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PrepareDataMoveRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PrepareDataMoveRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PrepareDataMoveResponse
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PrepareDataMoveResponse
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PrivateEndpoint
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PrivateEndpoint
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PrivateEndpointConnection
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PrivateEndpointConnection
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PrivateEndpointConnectionResource
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PrivateEndpointConnectionResource
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PrivateEndpointConnectionStatus
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PrivateEndpointConnectionStatus
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.PrivateLinkServiceConnectionState
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.PrivateLinkServiceConnectionState
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectableContainer
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectableContainer
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectableContainerResource
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectableContainerResource
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectableContainerResourceList
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectableContainerResourceList
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectableContainerType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectableContainerType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItemHealthStatus
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItemHealthStatus
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItemQueryObject
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItemQueryObject
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItemResource
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItemResource
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItemResourceList
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItemResourceList
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItemState
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectedItemState
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionContainer
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionContainer
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionContainerResource
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionContainerResource
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionContainerResourceList
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionContainerResourceList
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionIntent
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionIntent
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionIntentItemType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionIntentItemType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionIntentQueryObject
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionIntentQueryObject
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionIntentResource
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionIntentResource
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionIntentResourceList
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionIntentResourceList
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionPolicy
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionPolicy
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionPolicyQueryObject
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionPolicyQueryObject
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionPolicyResource
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionPolicyResource
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionPolicyResourceList
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionPolicyResourceList
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionState
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionState
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionStatus
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProtectionStatus
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ProvisioningState
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ProvisioningState
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryMode
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryMode
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPoint
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPoint
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointDiskConfiguration
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointDiskConfiguration
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointMoveReadinessInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointMoveReadinessInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointRehydrationInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointRehydrationInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointResource
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointResource
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointResourceList
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointResourceList
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointTierInformation
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointTierInformation
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointTierInformationV2
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointTierInformationV2
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointTierStatus
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointTierStatus
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointTierType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryPointTierType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RecoveryType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RehydrationPriority
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RehydrationPriority
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.Resource
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.Resource
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceGuardOperationDetail
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceGuardOperationDetail
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceGuardProxyBase
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceGuardProxyBase
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceGuardProxyBaseResource
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceGuardProxyBaseResource
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceGuardProxyBaseResourceList
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceGuardProxyBaseResourceList
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceHealthDetails
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceHealthDetails
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceHealthStatus
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceHealthStatus
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceList
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ResourceList
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RestoreFileSpecs
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RestoreFileSpecs
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RestorePointQueryType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RestorePointQueryType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RestorePointType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RestorePointType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RestoreRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RestoreRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RestoreRequestResource
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RestoreRequestResource
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RestoreRequestType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RestoreRequestType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RetentionDuration
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RetentionDuration
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RetentionDurationType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RetentionDurationType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RetentionPolicy
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RetentionPolicy
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.RetentionScheduleFormat
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.RetentionScheduleFormat
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.SQLDataDirectory
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.SQLDataDirectory
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.SQLDataDirectoryMapping
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.SQLDataDirectoryMapping
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.SQLDataDirectoryType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.SQLDataDirectoryType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.SchedulePolicy
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.SchedulePolicy
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ScheduleRunType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ScheduleRunType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.SecurityPinBase
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.SecurityPinBase
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.Settings
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.Settings
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.SimpleRetentionPolicy
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.SimpleRetentionPolicy
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.SimpleSchedulePolicy
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.SimpleSchedulePolicy
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.SimpleSchedulePolicyV2
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.SimpleSchedulePolicyV2
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.SoftDeleteFeatureState
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.SoftDeleteFeatureState
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.StorageType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.StorageType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.StorageTypeState
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.StorageTypeState
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.SubProtectionPolicy
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.SubProtectionPolicy
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.SupportStatus
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.SupportStatus
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.TargetAFSRestoreInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.TargetAFSRestoreInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.TargetRestoreInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.TargetRestoreInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.TieringMode
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.TieringMode
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.TieringPolicy
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.TieringPolicy
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.TokenInformation
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.TokenInformation
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.TriggerDataMoveRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.TriggerDataMoveRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.Type
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.Type
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.UnlockDeleteRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.UnlockDeleteRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.UnlockDeleteResponse
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.UnlockDeleteResponse
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.UsagesUnit
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.UsagesUnit
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidateIaasVMRestoreOperationRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidateIaasVMRestoreOperationRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidateOperationRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidateOperationRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidateOperationResponse
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidateOperationResponse
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidateOperationsResponse
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidateOperationsResponse
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidateRestoreOperationRequest
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidateRestoreOperationRequest
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidationStatus
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.ValidationStatus
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.VaultJob
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.VaultJob
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.VaultJobErrorInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.VaultJobErrorInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.VaultJobExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.VaultJobExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.VaultStorageConfigOperationResultResponse
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.VaultStorageConfigOperationResultResponse
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WeekOfMonth
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WeekOfMonth
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WeeklyRetentionFormat
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WeeklyRetentionFormat
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WeeklyRetentionSchedule
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WeeklyRetentionSchedule
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WeeklySchedule
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WeeklySchedule
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadInquiryDetails
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadInquiryDetails
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadItemResource
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadItemResource
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadItemResourceList
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadItemResourceList
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadItemType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadItemType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadProtectableItem
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadProtectableItem
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadProtectableItemResource
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadProtectableItemResource
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadProtectableItemResourceList
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadProtectableItemResourceList
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadType
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.WorkloadType
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.XcoolState
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.XcoolState
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.models.YearlyRetentionSchedule
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.models.YearlyRetentionSchedule
+ name: azure.mgmt.recoveryservicesbackup.activestamp.models
+ - items:
+ - name: Overview
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BMSPrepareDataMoveOperationResultOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BMSPrepareDataMoveOperationResultOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupEnginesOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupEnginesOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupJobsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupJobsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupOperationResultsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupOperationResultsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupOperationStatusesOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupOperationStatusesOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupPoliciesOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupPoliciesOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupProtectableItemsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupProtectableItemsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupProtectedItemsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupProtectedItemsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupProtectionContainersOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupProtectionContainersOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupProtectionIntentOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupProtectionIntentOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupResourceEncryptionConfigsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupResourceEncryptionConfigsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupResourceStorageConfigsNonCRROperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupResourceStorageConfigsNonCRROperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupResourceVaultConfigsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupResourceVaultConfigsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupStatusOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupStatusOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupUsageSummariesOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupUsageSummariesOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupWorkloadItemsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupWorkloadItemsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.BackupsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.DeletedProtectionContainersOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.DeletedProtectionContainersOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ExportJobsOperationResultsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ExportJobsOperationResultsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.FeatureSupportOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.FeatureSupportOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ItemLevelRecoveryConnectionsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ItemLevelRecoveryConnectionsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.JobCancellationsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.JobCancellationsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.JobDetailsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.JobDetailsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.JobOperationResultsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.JobOperationResultsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.JobsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.JobsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.OperationOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.OperationOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.Operations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.Operations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.PrivateEndpointConnectionOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.PrivateEndpointConnectionOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.PrivateEndpointOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.PrivateEndpointOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectableContainersOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectableContainersOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectedItemOperationResultsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectedItemOperationResultsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectedItemOperationStatusesOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectedItemOperationStatusesOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectedItemsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectedItemsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionContainerOperationResultsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionContainerOperationResultsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionContainerRefreshOperationResultsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionContainerRefreshOperationResultsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionContainersOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionContainersOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionIntentOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionIntentOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionPoliciesOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionPoliciesOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionPolicyOperationResultsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionPolicyOperationResultsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionPolicyOperationStatusesOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ProtectionPolicyOperationStatusesOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.RecoveryPointsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.RecoveryPointsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.RecoveryPointsRecommendedForMoveOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.RecoveryPointsRecommendedForMoveOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.RecoveryServicesBackupClientOperationsMixin
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.RecoveryServicesBackupClientOperationsMixin
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ResourceGuardProxiesOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ResourceGuardProxiesOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ResourceGuardProxyOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ResourceGuardProxyOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.RestoresOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.RestoresOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.SecurityPINsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.SecurityPINsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ValidateOperationOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ValidateOperationOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ValidateOperationResultsOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ValidateOperationResultsOperations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.operations.ValidateOperationStatusesOperations
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.operations.ValidateOperationStatusesOperations
+ name: azure.mgmt.recoveryservicesbackup.activestamp.operations
+ - name: azure.mgmt.recoveryservicesbackup.activestamp.RecoveryServicesBackupClient
+ uid: azure.mgmt.recoveryservicesbackup.activestamp.RecoveryServicesBackupClient
+ name: azure.mgmt.recoveryservicesbackup.activestamp
+ - items:
+ - name: Overview
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp
+ - items:
+ - name: Overview
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio
+ - items:
+ - name: Overview
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.AadPropertiesOperations
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.AadPropertiesOperations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.BackupCrrJobDetailsOperations
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.BackupCrrJobDetailsOperations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.BackupCrrJobsOperations
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.BackupCrrJobsOperations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.BackupProtectedItemsCrrOperations
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.BackupProtectedItemsCrrOperations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.BackupResourceStorageConfigsOperations
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.BackupResourceStorageConfigsOperations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.BackupUsageSummariesCRROperations
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.BackupUsageSummariesCRROperations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.CrossRegionRestoreOperations
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.CrossRegionRestoreOperations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.CrrOperationResultsOperations
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.CrrOperationResultsOperations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.CrrOperationStatusOperations
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.CrrOperationStatusOperations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.RecoveryPointsCrrOperations
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.RecoveryPointsCrrOperations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.RecoveryPointsOperations
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations.RecoveryPointsOperations
+ name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.operations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.aio.RecoveryServicesBackupPassiveClient
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.aio.RecoveryServicesBackupPassiveClient
+ name: azure.mgmt.recoveryservicesbackup.passivestamp.aio
+ - items:
+ - name: Overview
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AADProperties
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AADProperties
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AADPropertiesResource
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AADPropertiesResource
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureFileShareRecoveryPoint
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureFileShareRecoveryPoint
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureFileShareRestoreRequest
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureFileShareRestoreRequest
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureFileshareProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureFileshareProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureFileshareProtectedItemExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureFileshareProtectedItemExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSClassicComputeVMProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSClassicComputeVMProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSComputeVMProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSComputeVMProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMErrorInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMErrorInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMHealthDetails
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMHealthDetails
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMJob
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMJob
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMJobExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMJobExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMJobTaskDetails
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMJobTaskDetails
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMProtectedItemExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureIaaSVMProtectedItemExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureSqlProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureSqlProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureSqlProtectedItemExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureSqlProtectedItemExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureStorageErrorInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureStorageErrorInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureStorageJob
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureStorageJob
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureStorageJobExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureStorageJobExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureStorageJobTaskDetails
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureStorageJobTaskDetails
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureVmWorkloadProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureVmWorkloadProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureVmWorkloadProtectedItemExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureVmWorkloadProtectedItemExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureVmWorkloadSAPAseDatabaseProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureVmWorkloadSAPAseDatabaseProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureVmWorkloadSAPHanaDatabaseProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureVmWorkloadSAPHanaDatabaseProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureVmWorkloadSQLDatabaseProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureVmWorkloadSQLDatabaseProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadErrorInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadErrorInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadJob
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadJob
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadJobExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadJobExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadJobTaskDetails
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadJobTaskDetails
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadPointInTimeRecoveryPoint
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadPointInTimeRecoveryPoint
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadPointInTimeRestoreRequest
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadPointInTimeRestoreRequest
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadRecoveryPoint
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadRecoveryPoint
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadRestoreRequest
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadRestoreRequest
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSAPHanaPointInTimeRecoveryPoint
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSAPHanaPointInTimeRecoveryPoint
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSAPHanaPointInTimeRestoreRequest
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSAPHanaPointInTimeRestoreRequest
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSAPHanaRecoveryPoint
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSAPHanaRecoveryPoint
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSAPHanaRestoreRequest
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSAPHanaRestoreRequest
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSQLPointInTimeRecoveryPoint
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSQLPointInTimeRecoveryPoint
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSQLPointInTimeRestoreRequest
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSQLPointInTimeRestoreRequest
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSQLRecoveryPoint
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSQLRecoveryPoint
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSQLRecoveryPointExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSQLRecoveryPointExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSQLRestoreRequest
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.AzureWorkloadSQLRestoreRequest
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.BEKDetails
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.BEKDetails
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.BMSAADPropertiesQueryObject
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.BMSAADPropertiesQueryObject
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.BMSBackupSummariesQueryObject
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.BMSBackupSummariesQueryObject
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.BMSRPQueryObject
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.BMSRPQueryObject
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.BackupManagementType
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.BackupManagementType
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.BackupManagementUsage
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.BackupManagementUsage
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.BackupManagementUsageList
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.BackupManagementUsageList
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.BackupResourceConfig
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.BackupResourceConfig
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.BackupResourceConfigResource
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.BackupResourceConfigResource
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ClientScriptForConnect
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ClientScriptForConnect
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.CopyOptions
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.CopyOptions
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.CreateMode
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.CreateMode
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrossRegionRestoreRequest
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrossRegionRestoreRequest
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrossRegionRestoreRequestResource
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrossRegionRestoreRequestResource
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrrAccessToken
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrrAccessToken
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrrAccessTokenResource
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrrAccessTokenResource
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrrJobRequest
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrrJobRequest
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrrJobRequestResource
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.CrrJobRequestResource
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.DPMProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.DPMProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.DPMProtectedItemExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.DPMProtectedItemExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.DataSourceType
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.DataSourceType
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.DiskExclusionProperties
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.DiskExclusionProperties
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.DiskInformation
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.DiskInformation
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.DpmErrorInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.DpmErrorInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.DpmJob
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.DpmJob
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.DpmJobExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.DpmJobExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.DpmJobTaskDetails
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.DpmJobTaskDetails
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.EncryptionDetails
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.EncryptionDetails
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ErrorAdditionalInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ErrorAdditionalInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ErrorDetail
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ErrorDetail
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ExtendedProperties
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ExtendedProperties
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.GenericProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.GenericProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.GenericRecoveryPoint
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.GenericRecoveryPoint
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.HealthState
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.HealthState
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.HealthStatus
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.HealthStatus
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.IaasVMRecoveryPoint
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.IaasVMRecoveryPoint
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.IaasVMRestoreRequest
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.IaasVMRestoreRequest
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.IdentityBasedRestoreDetails
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.IdentityBasedRestoreDetails
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.IdentityInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.IdentityInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.InstantItemRecoveryTarget
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.InstantItemRecoveryTarget
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.Job
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.Job
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobOperationType
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobOperationType
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobQueryObject
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobQueryObject
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobResource
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobResource
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobResourceList
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobResourceList
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobStatus
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobStatus
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobSupportedAction
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.JobSupportedAction
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.KEKDetails
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.KEKDetails
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.KPIResourceHealthDetails
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.KPIResourceHealthDetails
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.KeyAndSecretDetails
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.KeyAndSecretDetails
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.LastBackupStatus
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.LastBackupStatus
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabErrorInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabErrorInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabFileFolderProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabFileFolderProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabFileFolderProtectedItemExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabFileFolderProtectedItemExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabJob
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabJob
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabJobExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabJobExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabJobTaskDetails
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabJobTaskDetails
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabServerType
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.MabServerType
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.NameInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.NameInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.NewErrorResponse
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.NewErrorResponse
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.NewErrorResponseError
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.NewErrorResponseError
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatus
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatus
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusError
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusError
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusJobExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusJobExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusJobsExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusJobsExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusProvisionILRExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusProvisionILRExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusRecoveryPointExtendedInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusRecoveryPointExtendedInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusValues
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.OperationStatusValues
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.OverwriteOptions
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.OverwriteOptions
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.PointInTimeRange
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.PointInTimeRange
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItem
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItem
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItemHealthStatus
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItemHealthStatus
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItemQueryObject
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItemQueryObject
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItemResource
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItemResource
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItemResourceList
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItemResourceList
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItemState
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectedItemState
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectionState
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ProtectionState
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryMode
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryMode
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPoint
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPoint
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointDiskConfiguration
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointDiskConfiguration
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointMoveReadinessInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointMoveReadinessInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointResource
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointResource
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointResourceList
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointResourceList
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointTierInformation
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointTierInformation
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointTierStatus
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointTierStatus
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointTierType
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryPointTierType
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryType
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RecoveryType
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.Resource
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.Resource
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ResourceHealthDetails
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ResourceHealthDetails
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ResourceHealthStatus
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ResourceHealthStatus
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.ResourceList
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.ResourceList
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RestoreFileSpecs
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RestoreFileSpecs
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RestorePointQueryType
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RestorePointQueryType
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RestorePointType
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RestorePointType
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RestoreRequest
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RestoreRequest
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.RestoreRequestType
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.RestoreRequestType
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.SQLDataDirectory
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.SQLDataDirectory
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.SQLDataDirectoryMapping
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.SQLDataDirectoryMapping
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.SQLDataDirectoryType
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.SQLDataDirectoryType
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.StorageType
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.StorageType
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.StorageTypeState
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.StorageTypeState
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.TargetAFSRestoreInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.TargetAFSRestoreInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.TargetRestoreInfo
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.TargetRestoreInfo
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.Type
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.Type
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.UsagesUnit
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.UsagesUnit
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.WorkloadCrrAccessToken
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.WorkloadCrrAccessToken
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.models.WorkloadType
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.models.WorkloadType
+ name: azure.mgmt.recoveryservicesbackup.passivestamp.models
+ - items:
+ - name: Overview
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.operations.AadPropertiesOperations
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations.AadPropertiesOperations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.operations.BackupCrrJobDetailsOperations
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations.BackupCrrJobDetailsOperations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.operations.BackupCrrJobsOperations
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations.BackupCrrJobsOperations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.operations.BackupProtectedItemsCrrOperations
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations.BackupProtectedItemsCrrOperations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.operations.BackupResourceStorageConfigsOperations
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations.BackupResourceStorageConfigsOperations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.operations.BackupUsageSummariesCRROperations
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations.BackupUsageSummariesCRROperations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.operations.CrossRegionRestoreOperations
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations.CrossRegionRestoreOperations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.operations.CrrOperationResultsOperations
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations.CrrOperationResultsOperations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.operations.CrrOperationStatusOperations
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations.CrrOperationStatusOperations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.operations.RecoveryPointsCrrOperations
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations.RecoveryPointsCrrOperations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.operations.RecoveryPointsOperations
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.operations.RecoveryPointsOperations
+ name: azure.mgmt.recoveryservicesbackup.passivestamp.operations
+ - name: azure.mgmt.recoveryservicesbackup.passivestamp.RecoveryServicesBackupPassiveClient
+ uid: azure.mgmt.recoveryservicesbackup.passivestamp.RecoveryServicesBackupPassiveClient
+ name: azure.mgmt.recoveryservicesbackup.passivestamp
+ name: azure.mgmt.recoveryservicesbackup
name: azure-mgmt-recoveryservicesbackup
-
- items:
- name: Overview
uid: project-azure-mgmt-recoveryservicessiterecovery
@@ -65050,7 +64892,6 @@
uid: azure.mgmt.recoveryservicessiterecovery.SiteRecoveryManagementClient
name: azure.mgmt.recoveryservicessiterecovery
name: azure-mgmt-recoveryservicessiterecovery
-
- items:
- name: Overview
uid: project-azure-mgmt-redhatopenshift
@@ -65441,7 +65282,6 @@
uid: azure.mgmt.redhatopenshift.AzureRedHatOpenShiftClient
name: azure.mgmt.redhatopenshift
name: azure-mgmt-redhatopenshift
-
- items:
- name: Overview
uid: project-azure-mgmt-redisenterprise
@@ -65622,7 +65462,6 @@
uid: azure.mgmt.redisenterprise.RedisEnterpriseManagementClient
name: azure.mgmt.redisenterprise
name: azure-mgmt-redisenterprise
-
- items:
- name: Overview
uid: project-azure-mgmt-relay
@@ -65765,7 +65604,6 @@
uid: azure.mgmt.relay.RelayAPI
name: azure.mgmt.relay
name: azure-mgmt-relay
-
- items:
- name: Overview
uid: project-azure-mgmt-resource
@@ -71472,7 +71310,6 @@
uid: azure.mgmt.resource.SubscriptionClient
name: azure.mgmt.resource
name: azure-mgmt-resource
-
- items:
- name: Overview
uid: project-azure-mgmt-resourceconnector
@@ -71573,7 +71410,6 @@
uid: azure.mgmt.resourceconnector.ResourceConnectorMgmtClient
name: azure.mgmt.resourceconnector
name: azure-mgmt-resourceconnector
-
- items:
- name: Overview
uid: project-azure-mgmt-resourcegraph
@@ -71682,7 +71518,6 @@
uid: azure.mgmt.resourcegraph.ResourceGraphClient
name: azure.mgmt.resourcegraph
name: azure-mgmt-resourcegraph
-
- items:
- name: Overview
uid: project-azure-mgmt-resourcehealth
@@ -72075,7 +71910,6 @@
uid: azure.mgmt.resourcehealth.ResourceHealthMgmtClient
name: azure.mgmt.resourcehealth
name: azure-mgmt-resourcehealth
-
- items:
- name: Overview
uid: project-azure-mgmt-resourcemover
@@ -72280,7 +72114,6 @@
uid: azure.mgmt.resourcemover.ResourceMoverServiceAPI
name: azure.mgmt.resourcemover
name: azure-mgmt-resourcemover
-
- items:
- name: Overview
uid: project-azure-mgmt-scheduler
@@ -72409,7 +72242,6 @@
uid: azure.mgmt.scheduler.SchedulerManagementClient
name: azure.mgmt.scheduler
name: azure-mgmt-scheduler
-
- items:
- name: Overview
uid: project-azure-mgmt-scvmm
@@ -72592,7 +72424,6 @@
uid: azure.mgmt.scvmm.SCVMM
name: azure.mgmt.scvmm
name: azure-mgmt-scvmm
-
- items:
- name: Overview
uid: project-azure-mgmt-search
@@ -72713,7 +72544,6 @@
uid: azure.mgmt.search.SearchManagementClient
name: azure.mgmt.search
name: azure-mgmt-search
-
- items:
- name: Overview
uid: project-azure-mgmt-security
@@ -74876,7 +74706,6 @@
uid: azure.mgmt.security.SecurityCenter
name: azure.mgmt.security
name: azure-mgmt-security
-
- items:
- name: Overview
uid: project-azure-mgmt-securitydevops
@@ -75045,7 +74874,6 @@
uid: azure.mgmt.securitydevops.MicrosoftSecurityDevOps
name: azure.mgmt.securitydevops
name: azure-mgmt-securitydevops
-
- items:
- name: Overview
uid: project-azure-mgmt-securityinsight
@@ -76214,7 +76042,6 @@
uid: azure.mgmt.securityinsight.SecurityInsights
name: azure.mgmt.securityinsight
name: azure-mgmt-securityinsight
-
- items:
- name: Overview
uid: project-azure-mgmt-selfhelp
@@ -76303,7 +76130,6 @@
uid: azure.mgmt.selfhelp.SelfHelpMgmtClient
name: azure.mgmt.selfhelp
name: azure-mgmt-selfhelp
-
- items:
- name: Overview
uid: project-azure-mgmt-serialconsole
@@ -76368,7 +76194,6 @@
uid: azure.mgmt.serialconsole.MicrosoftSerialConsoleClient
name: azure.mgmt.serialconsole
name: azure-mgmt-serialconsole
-
- items:
- name: Overview
uid: project-azure-mgmt-servicefabric
@@ -76617,7 +76442,6 @@
uid: azure.mgmt.servicefabric.ServiceFabricManagementClient
name: azure.mgmt.servicefabric
name: azure-mgmt-servicefabric
-
- items:
- name: Overview
uid: project-azure-mgmt-servicefabricmanagedclusters
@@ -76946,7 +76770,6 @@
uid: azure.mgmt.servicefabricmanagedclusters.ServiceFabricManagedClustersManagementClient
name: azure.mgmt.servicefabricmanagedclusters
name: azure-mgmt-servicefabricmanagedclusters
-
- items:
- name: Overview
uid: project-azure-mgmt-servicelinker
@@ -77135,7 +76958,6 @@
uid: azure.mgmt.servicelinker.ServiceLinkerManagementClient
name: azure.mgmt.servicelinker
name: azure-mgmt-servicelinker
-
- items:
- name: Overview
uid: project-azure-mgmt-servicenetworking
@@ -77232,7 +77054,6 @@
uid: azure.mgmt.servicenetworking.ServiceNetworkingMgmtClient
name: azure.mgmt.servicenetworking
name: azure-mgmt-servicenetworking
-
- items:
- name: Overview
uid: project-azure-mgmt-sphere
@@ -77399,7 +77220,6 @@
uid: azure.mgmt.sphere.AzureSphereMgmtClient
name: azure.mgmt.sphere
name: azure-mgmt-sphere
-
- items:
- name: Overview
uid: project-azure-mgmt-sql
@@ -79146,7 +78966,6 @@
uid: azure.mgmt.sql.SqlManagementClient
name: azure.mgmt.sql
name: azure-mgmt-sql
-
- items:
- name: Overview
uid: project-azure-mgmt-sqlvirtualmachine
@@ -79337,7 +79156,6 @@
uid: azure.mgmt.sqlvirtualmachine.SqlVirtualMachineManagementClient
name: azure.mgmt.sqlvirtualmachine
name: azure-mgmt-sqlvirtualmachine
-
- items:
- name: Overview
uid: project-azure-mgmt-storage
@@ -86016,7 +85834,6 @@
uid: azure.mgmt.storage.StorageManagementClient
name: azure.mgmt.storage
name: azure-mgmt-storage
-
- items:
- name: Overview
uid: project-azure-mgmt-storagecache
@@ -86215,7 +86032,6 @@
uid: azure.mgmt.storagecache.StorageCacheManagementClient
name: azure.mgmt.storagecache
name: azure-mgmt-storagecache
-
- items:
- name: Overview
uid: project-azure-mgmt-storagemover
@@ -86378,7 +86194,6 @@
uid: azure.mgmt.storagemover.StorageMoverMgmtClient
name: azure.mgmt.storagemover
name: azure-mgmt-storagemover
-
- items:
- name: Overview
uid: project-azure-mgmt-storagepool
@@ -86511,7 +86326,6 @@
uid: azure.mgmt.storagepool.StoragePoolManagement
name: azure.mgmt.storagepool
name: azure-mgmt-storagepool
-
- items:
- name: Overview
uid: project-azure-mgmt-storagesync
@@ -86776,7 +86590,6 @@
uid: azure.mgmt.storagesync.MicrosoftStorageSync
name: azure.mgmt.storagesync
name: azure-mgmt-storagesync
-
- items:
- name: Overview
uid: project-azure-mgmt-streamanalytics
@@ -87193,7 +87006,6 @@
uid: azure.mgmt.streamanalytics.StreamAnalyticsManagementClient
name: azure.mgmt.streamanalytics
name: azure-mgmt-streamanalytics
-
- items:
- name: Overview
uid: project-azure-mgmt-subscription
@@ -87330,7 +87142,6 @@
uid: azure.mgmt.subscription.SubscriptionClient
name: azure.mgmt.subscription
name: azure-mgmt-subscription
-
- items:
- name: Overview
uid: project-azure-mgmt-support
@@ -87439,7 +87250,6 @@
uid: azure.mgmt.support.MicrosoftSupport
name: azure.mgmt.support
name: azure-mgmt-support
-
- items:
- name: Overview
uid: project-azure-mgmt-synapse
@@ -88454,7 +88264,6 @@
uid: azure.mgmt.synapse.SynapseManagementClient
name: azure.mgmt.synapse
name: azure-mgmt-synapse
-
- items:
- name: Overview
uid: project-azure-mgmt-testbase
@@ -88757,7 +88566,6 @@
uid: azure.mgmt.testbase.TestBase
name: azure.mgmt.testbase
name: azure-mgmt-testbase
-
- items:
- name: Overview
uid: project-azure-mgmt-timeseriesinsights
@@ -89004,7 +88812,6 @@
uid: azure.mgmt.timeseriesinsights.TimeSeriesInsightsClient
name: azure.mgmt.timeseriesinsights
name: azure-mgmt-timeseriesinsights
-
- items:
- name: Overview
uid: project-azure-mgmt-trafficmanager
@@ -89119,7 +88926,6 @@
uid: azure.mgmt.trafficmanager.TrafficManagerManagementClient
name: azure.mgmt.trafficmanager
name: azure-mgmt-trafficmanager
-
- items:
- name: Overview
uid: project-azure-mgmt-vmwarecloudsimple
@@ -89312,7 +89118,6 @@
uid: azure.mgmt.vmwarecloudsimple.VMwareCloudSimple
name: azure.mgmt.vmwarecloudsimple
name: azure-mgmt-vmwarecloudsimple
-
- items:
- name: Overview
uid: project-azure-mgmt-voiceservices
@@ -89419,7 +89224,6 @@
uid: azure.mgmt.voiceservices.VoiceServicesMgmtClient
name: azure.mgmt.voiceservices
name: azure-mgmt-voiceservices
-
- items:
- name: Overview
uid: project-azure-mgmt-webpubsub
@@ -89648,7 +89452,6 @@
uid: azure.mgmt.webpubsub.WebPubSubManagementClient
name: azure.mgmt.webpubsub
name: azure-mgmt-webpubsub
-
- items:
- name: Overview
uid: project-azure-mgmt-workloads
@@ -90023,7 +89826,6 @@
uid: azure.mgmt.workloads.WorkloadsClient
name: azure.mgmt.workloads
name: azure-mgmt-workloads
-
- items:
- name: Overview
uid: project-azure-mixedreality-authentication
@@ -90040,7 +89842,6 @@
uid: azure.mixedreality.authentication.MixedRealityStsClient
name: azure.mixedreality.authentication
name: azure-mixedreality-authentication
-
- items:
- name: Overview
uid: project-azure-mixedreality-remoterendering
@@ -90077,7 +89878,6 @@
uid: azure.mixedreality.remoterendering.RenderingSessionStatus
name: azure.mixedreality.remoterendering
name: azure-mixedreality-remoterendering
-
- items:
- name: Overview
uid: project-azure-monitor-ingestion
@@ -90102,7 +89902,6 @@
uid: azure.monitor.ingestion.UploadLogsStatus
name: azure.monitor.ingestion
name: azure-monitor-ingestion
-
- items:
- name: Overview
uid: project-azure-monitor-opentelemetry
@@ -90117,7 +89916,6 @@
uid: azure.monitor.opentelemetry.util
name: azure.monitor.opentelemetry
name: azure-monitor-opentelemetry
-
- items:
- name: Overview
uid: project-azure-monitor-opentelemetry-exporter
@@ -90146,7 +89944,6 @@
uid: azure.monitor.opentelemetry.exporter.AzureMonitorTraceExporter
name: azure.monitor.opentelemetry.exporter
name: azure-monitor-opentelemetry-exporter
-
- items:
- name: Overview
uid: project-azure-monitor-query
@@ -90207,7 +90004,6 @@
uid: azure.monitor.query.TimeSeriesElement
name: azure.monitor.query
name: azure-monitor-query
-
- items:
- name: Overview
uid: project-azure-purview-account
@@ -90244,72 +90040,74 @@
uid: azure.purview.account.PurviewAccountClient
name: azure.purview.account
name: azure-purview-account
-
- items:
- name: Overview
uid: project-azure-purview-administration
- items:
- name: Overview
- uid: azure.purview.administration.account
+ uid: azure.purview.administration
- items:
- name: Overview
- uid: azure.purview.administration.account.aio
+ uid: azure.purview.administration.account
- items:
- name: Overview
- uid: azure.purview.administration.account.aio.operations
- - name: azure.purview.administration.account.aio.operations.AccountsOperations
- uid: azure.purview.administration.account.aio.operations.AccountsOperations
- - name: azure.purview.administration.account.aio.operations.CollectionsOperations
- uid: azure.purview.administration.account.aio.operations.CollectionsOperations
- - name: azure.purview.administration.account.aio.operations.ResourceSetRulesOperations
- uid: azure.purview.administration.account.aio.operations.ResourceSetRulesOperations
- name: azure.purview.administration.account.aio.operations
- - name: azure.purview.administration.account.aio.PurviewAccountClient
- uid: azure.purview.administration.account.aio.PurviewAccountClient
- name: azure.purview.administration.account.aio
- - items:
- - name: Overview
- uid: azure.purview.administration.account.operations
- - name: azure.purview.administration.account.operations.AccountsOperations
- uid: azure.purview.administration.account.operations.AccountsOperations
- - name: azure.purview.administration.account.operations.CollectionsOperations
- uid: azure.purview.administration.account.operations.CollectionsOperations
- - name: azure.purview.administration.account.operations.ResourceSetRulesOperations
- uid: azure.purview.administration.account.operations.ResourceSetRulesOperations
- name: azure.purview.administration.account.operations
- - name: azure.purview.administration.account.PurviewAccountClient
- uid: azure.purview.administration.account.PurviewAccountClient
- name: azure.purview.administration.account
- - items:
- - name: Overview
- uid: azure.purview.administration.metadatapolicies
- - items:
- - name: Overview
- uid: azure.purview.administration.metadatapolicies.aio
- - items:
- - name: Overview
- uid: azure.purview.administration.metadatapolicies.aio.operations
- - name: azure.purview.administration.metadatapolicies.aio.operations.MetadataPolicyOperations
- uid: azure.purview.administration.metadatapolicies.aio.operations.MetadataPolicyOperations
- - name: azure.purview.administration.metadatapolicies.aio.operations.MetadataRolesOperations
- uid: azure.purview.administration.metadatapolicies.aio.operations.MetadataRolesOperations
- name: azure.purview.administration.metadatapolicies.aio.operations
- - name: azure.purview.administration.metadatapolicies.aio.PurviewMetadataPoliciesClient
- uid: azure.purview.administration.metadatapolicies.aio.PurviewMetadataPoliciesClient
- name: azure.purview.administration.metadatapolicies.aio
- - items:
- - name: Overview
- uid: azure.purview.administration.metadatapolicies.operations
- - name: azure.purview.administration.metadatapolicies.operations.MetadataPolicyOperations
- uid: azure.purview.administration.metadatapolicies.operations.MetadataPolicyOperations
- - name: azure.purview.administration.metadatapolicies.operations.MetadataRolesOperations
- uid: azure.purview.administration.metadatapolicies.operations.MetadataRolesOperations
- name: azure.purview.administration.metadatapolicies.operations
- - name: azure.purview.administration.metadatapolicies.PurviewMetadataPoliciesClient
- uid: azure.purview.administration.metadatapolicies.PurviewMetadataPoliciesClient
- name: azure.purview.administration.metadatapolicies
+ uid: azure.purview.administration.account.aio
+ - items:
+ - name: Overview
+ uid: azure.purview.administration.account.aio.operations
+ - name: azure.purview.administration.account.aio.operations.AccountsOperations
+ uid: azure.purview.administration.account.aio.operations.AccountsOperations
+ - name: azure.purview.administration.account.aio.operations.CollectionsOperations
+ uid: azure.purview.administration.account.aio.operations.CollectionsOperations
+ - name: azure.purview.administration.account.aio.operations.ResourceSetRulesOperations
+ uid: azure.purview.administration.account.aio.operations.ResourceSetRulesOperations
+ name: azure.purview.administration.account.aio.operations
+ - name: azure.purview.administration.account.aio.PurviewAccountClient
+ uid: azure.purview.administration.account.aio.PurviewAccountClient
+ name: azure.purview.administration.account.aio
+ - items:
+ - name: Overview
+ uid: azure.purview.administration.account.operations
+ - name: azure.purview.administration.account.operations.AccountsOperations
+ uid: azure.purview.administration.account.operations.AccountsOperations
+ - name: azure.purview.administration.account.operations.CollectionsOperations
+ uid: azure.purview.administration.account.operations.CollectionsOperations
+ - name: azure.purview.administration.account.operations.ResourceSetRulesOperations
+ uid: azure.purview.administration.account.operations.ResourceSetRulesOperations
+ name: azure.purview.administration.account.operations
+ - name: azure.purview.administration.account.PurviewAccountClient
+ uid: azure.purview.administration.account.PurviewAccountClient
+ name: azure.purview.administration.account
+ - items:
+ - name: Overview
+ uid: azure.purview.administration.metadatapolicies
+ - items:
+ - name: Overview
+ uid: azure.purview.administration.metadatapolicies.aio
+ - items:
+ - name: Overview
+ uid: azure.purview.administration.metadatapolicies.aio.operations
+ - name: azure.purview.administration.metadatapolicies.aio.operations.MetadataPolicyOperations
+ uid: azure.purview.administration.metadatapolicies.aio.operations.MetadataPolicyOperations
+ - name: azure.purview.administration.metadatapolicies.aio.operations.MetadataRolesOperations
+ uid: azure.purview.administration.metadatapolicies.aio.operations.MetadataRolesOperations
+ name: azure.purview.administration.metadatapolicies.aio.operations
+ - name: azure.purview.administration.metadatapolicies.aio.PurviewMetadataPoliciesClient
+ uid: azure.purview.administration.metadatapolicies.aio.PurviewMetadataPoliciesClient
+ name: azure.purview.administration.metadatapolicies.aio
+ - items:
+ - name: Overview
+ uid: azure.purview.administration.metadatapolicies.operations
+ - name: azure.purview.administration.metadatapolicies.operations.MetadataPolicyOperations
+ uid: azure.purview.administration.metadatapolicies.operations.MetadataPolicyOperations
+ - name: azure.purview.administration.metadatapolicies.operations.MetadataRolesOperations
+ uid: azure.purview.administration.metadatapolicies.operations.MetadataRolesOperations
+ name: azure.purview.administration.metadatapolicies.operations
+ - name: azure.purview.administration.metadatapolicies.PurviewMetadataPoliciesClient
+ uid: azure.purview.administration.metadatapolicies.PurviewMetadataPoliciesClient
+ name: azure.purview.administration.metadatapolicies
+ name: azure.purview.administration
name: azure-purview-administration
-
- items:
- name: Overview
uid: project-azure-purview-catalog
@@ -90362,7 +90160,6 @@
uid: azure.purview.catalog.PurviewCatalogClient
name: azure.purview.catalog
name: azure-purview-catalog
-
- items:
- name: Overview
uid: project-azure-purview-scanning
@@ -90423,7 +90220,6 @@
uid: azure.purview.scanning.PurviewScanningClient
name: azure.purview.scanning
name: azure-purview-scanning
-
- items:
- name: Overview
uid: project-azure-purview-sharing
@@ -90460,7 +90256,6 @@
uid: azure.purview.sharing.PurviewSharingClient
name: azure.purview.sharing
name: azure-purview-sharing
-
- items:
- name: Overview
uid: project-azure-purview-workflow
@@ -90477,7 +90272,6 @@
uid: azure.purview.workflow.PurviewWorkflowClient
name: azure.purview.workflow
name: azure-purview-workflow
-
- items:
- name: Overview
uid: project-azure-schemaregistry
@@ -90492,6 +90286,26 @@
- name: azure.schemaregistry.aio.SchemaRegistryClient
uid: azure.schemaregistry.aio.SchemaRegistryClient
name: azure.schemaregistry.aio
+ - items:
+ - name: Overview
+ uid: azure.schemaregistry.encoder
+ - items:
+ - name: Overview
+ uid: azure.schemaregistry.encoder.jsonencoder
+ - items:
+ - name: Overview
+ uid: azure.schemaregistry.encoder.jsonencoder.aio
+ - name: azure.schemaregistry.encoder.jsonencoder.aio.JsonSchemaEncoder
+ uid: azure.schemaregistry.encoder.jsonencoder.aio.JsonSchemaEncoder
+ name: azure.schemaregistry.encoder.jsonencoder.aio
+ - name: azure.schemaregistry.encoder.jsonencoder.InvalidContentError
+ uid: azure.schemaregistry.encoder.jsonencoder.InvalidContentError
+ - name: azure.schemaregistry.encoder.jsonencoder.JsonSchemaDraftIdentifier
+ uid: azure.schemaregistry.encoder.jsonencoder.JsonSchemaDraftIdentifier
+ - name: azure.schemaregistry.encoder.jsonencoder.JsonSchemaEncoder
+ uid: azure.schemaregistry.encoder.jsonencoder.JsonSchemaEncoder
+ name: azure.schemaregistry.encoder.jsonencoder
+ name: azure.schemaregistry.encoder
- name: azure.schemaregistry.ApiVersion
uid: azure.schemaregistry.ApiVersion
- name: azure.schemaregistry.MessageContent
@@ -90511,24 +90325,7 @@
- name: azure.schemaregistry.SchemaRegistryClient
uid: azure.schemaregistry.SchemaRegistryClient
name: azure.schemaregistry
- - items:
- - name: Overview
- uid: azure.schemaregistry.encoder.jsonencoder
- - items:
- - name: Overview
- uid: azure.schemaregistry.encoder.jsonencoder.aio
- - name: azure.schemaregistry.encoder.jsonencoder.aio.JsonSchemaEncoder
- uid: azure.schemaregistry.encoder.jsonencoder.aio.JsonSchemaEncoder
- name: azure.schemaregistry.encoder.jsonencoder.aio
- - name: azure.schemaregistry.encoder.jsonencoder.InvalidContentError
- uid: azure.schemaregistry.encoder.jsonencoder.InvalidContentError
- - name: azure.schemaregistry.encoder.jsonencoder.JsonSchemaDraftIdentifier
- uid: azure.schemaregistry.encoder.jsonencoder.JsonSchemaDraftIdentifier
- - name: azure.schemaregistry.encoder.jsonencoder.JsonSchemaEncoder
- uid: azure.schemaregistry.encoder.jsonencoder.JsonSchemaEncoder
- name: azure.schemaregistry.encoder.jsonencoder
name: azure-schemaregistry
-
- items:
- name: Overview
uid: project-azure-schemaregistry-avroencoder
@@ -90553,7 +90350,6 @@
uid: azure.schemaregistry.encoder.avroencoder.MessageType
name: azure.schemaregistry.encoder.avroencoder
name: azure-schemaregistry-avroencoder
-
- items:
- name: Overview
uid: project-azure-search-documents
@@ -90946,7 +90742,6 @@
uid: azure.search.documents.SearchItemPaged
name: azure.search.documents
name: azure-search-documents
-
- items:
- name: Overview
uid: project-azure-servicebus
@@ -91105,7 +90900,6 @@
uid: azure.servicebus.TransportType
name: azure.servicebus
name: azure-servicebus
-
- items:
- name: Overview
uid: project-azure-servicemanagement-legacy
@@ -91453,10 +91247,7 @@
- name: azure.servicemanagement.websitemanagementservice.WebsiteManagementService
uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService
name: azure.servicemanagement.websitemanagementservice
- - name: azure.servicemanagement
- uid: azure.servicemanagement
name: azure-servicemanagement-legacy
-
- items:
- name: Overview
uid: project-azure-storage-blob
@@ -91585,7 +91376,6 @@
uid: azure.storage.blob.UserDelegationKey
name: azure.storage.blob
name: azure-storage-blob
-
- items:
- name: Overview
uid: project-azure-storage-blob-changefeed
@@ -91596,7 +91386,6 @@
uid: azure.storage.blob.changefeed.ChangeFeedClient
name: azure.storage.blob.changefeed
name: azure-storage-blob-changefeed
-
- items:
- name: Overview
uid: project-azure-storage-file-datalake
@@ -91711,7 +91500,6 @@
uid: azure.storage.filedatalake.UserDelegationKey
name: azure.storage.filedatalake
name: azure-storage-file-datalake
-
- items:
- name: Overview
uid: project-azure-storage-file-share
@@ -91792,7 +91580,6 @@
uid: azure.storage.fileshare.StorageErrorCode
name: azure.storage.fileshare
name: azure-storage-file-share
-
- items:
- name: Overview
uid: project-azure-storage-queue
@@ -91849,7 +91636,6 @@
uid: azure.storage.queue.TextBase64EncodePolicy
name: azure.storage.queue
name: azure-storage-queue
-
- items:
- name: Overview
uid: project-azure-synapse
@@ -91874,40 +91660,26 @@
- items:
- name: Overview
uid: azure.synapse.accesscontrol.models
- - name: azure.synapse.accesscontrol.models.CheckAccessDecision
- uid: azure.synapse.accesscontrol.models.CheckAccessDecision
- - name: azure.synapse.accesscontrol.models.CheckPrincipalAccessRequest
- uid: azure.synapse.accesscontrol.models.CheckPrincipalAccessRequest
- - name: azure.synapse.accesscontrol.models.CheckPrincipalAccessResponse
- uid: azure.synapse.accesscontrol.models.CheckPrincipalAccessResponse
- - name: azure.synapse.accesscontrol.models.ErrorAdditionalInfo
- uid: azure.synapse.accesscontrol.models.ErrorAdditionalInfo
- name: azure.synapse.accesscontrol.models.ErrorContract
uid: azure.synapse.accesscontrol.models.ErrorContract
+ - name: azure.synapse.accesscontrol.models.ErrorDetail
+ uid: azure.synapse.accesscontrol.models.ErrorDetail
- name: azure.synapse.accesscontrol.models.ErrorResponse
uid: azure.synapse.accesscontrol.models.ErrorResponse
- - name: azure.synapse.accesscontrol.models.RequiredAction
- uid: azure.synapse.accesscontrol.models.RequiredAction
- name: azure.synapse.accesscontrol.models.RoleAssignmentDetails
uid: azure.synapse.accesscontrol.models.RoleAssignmentDetails
- - name: azure.synapse.accesscontrol.models.RoleAssignmentDetailsList
- uid: azure.synapse.accesscontrol.models.RoleAssignmentDetailsList
- - name: azure.synapse.accesscontrol.models.RoleAssignmentRequest
- uid: azure.synapse.accesscontrol.models.RoleAssignmentRequest
- - name: azure.synapse.accesscontrol.models.SubjectInfo
- uid: azure.synapse.accesscontrol.models.SubjectInfo
- - name: azure.synapse.accesscontrol.models.SynapseRbacPermission
- uid: azure.synapse.accesscontrol.models.SynapseRbacPermission
- - name: azure.synapse.accesscontrol.models.SynapseRoleDefinition
- uid: azure.synapse.accesscontrol.models.SynapseRoleDefinition
+ - name: azure.synapse.accesscontrol.models.RoleAssignmentOptions
+ uid: azure.synapse.accesscontrol.models.RoleAssignmentOptions
+ - name: azure.synapse.accesscontrol.models.RolesListResponse
+ uid: azure.synapse.accesscontrol.models.RolesListResponse
+ - name: azure.synapse.accesscontrol.models.SynapseRole
+ uid: azure.synapse.accesscontrol.models.SynapseRole
name: azure.synapse.accesscontrol.models
- items:
- name: Overview
uid: azure.synapse.accesscontrol.operations
- - name: azure.synapse.accesscontrol.operations.RoleAssignmentsOperations
- uid: azure.synapse.accesscontrol.operations.RoleAssignmentsOperations
- - name: azure.synapse.accesscontrol.operations.RoleDefinitionsOperations
- uid: azure.synapse.accesscontrol.operations.RoleDefinitionsOperations
+ - name: azure.synapse.accesscontrol.operations.AccessControlOperations
+ uid: azure.synapse.accesscontrol.operations.AccessControlOperations
name: azure.synapse.accesscontrol.operations
- name: azure.synapse.accesscontrol.AccessControlClient
uid: azure.synapse.accesscontrol.AccessControlClient
@@ -91968,162 +91740,54 @@
- items:
- name: Overview
uid: azure.synapse.artifacts.models
- - name: azure.synapse.artifacts.models.ActionOnExistingTargetTable
- uid: azure.synapse.artifacts.models.ActionOnExistingTargetTable
- name: azure.synapse.artifacts.models.Activity
uid: azure.synapse.artifacts.models.Activity
- name: azure.synapse.artifacts.models.ActivityDependency
uid: azure.synapse.artifacts.models.ActivityDependency
- - name: azure.synapse.artifacts.models.ActivityOnInactiveMarkAs
- uid: azure.synapse.artifacts.models.ActivityOnInactiveMarkAs
- name: azure.synapse.artifacts.models.ActivityPolicy
uid: azure.synapse.artifacts.models.ActivityPolicy
- name: azure.synapse.artifacts.models.ActivityRun
uid: azure.synapse.artifacts.models.ActivityRun
- name: azure.synapse.artifacts.models.ActivityRunsQueryResponse
uid: azure.synapse.artifacts.models.ActivityRunsQueryResponse
- - name: azure.synapse.artifacts.models.ActivityState
- uid: azure.synapse.artifacts.models.ActivityState
- name: azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse
uid: azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse
- - name: azure.synapse.artifacts.models.AdditionalColumns
- uid: azure.synapse.artifacts.models.AdditionalColumns
- name: azure.synapse.artifacts.models.AmazonMWSLinkedService
uid: azure.synapse.artifacts.models.AmazonMWSLinkedService
- name: azure.synapse.artifacts.models.AmazonMWSObjectDataset
uid: azure.synapse.artifacts.models.AmazonMWSObjectDataset
- - name: azure.synapse.artifacts.models.AmazonMWSSource
- uid: azure.synapse.artifacts.models.AmazonMWSSource
- - name: azure.synapse.artifacts.models.AmazonRdsForOracleLinkedService
- uid: azure.synapse.artifacts.models.AmazonRdsForOracleLinkedService
- - name: azure.synapse.artifacts.models.AmazonRdsForOraclePartitionOption
- uid: azure.synapse.artifacts.models.AmazonRdsForOraclePartitionOption
- - name: azure.synapse.artifacts.models.AmazonRdsForOraclePartitionSettings
- uid: azure.synapse.artifacts.models.AmazonRdsForOraclePartitionSettings
- - name: azure.synapse.artifacts.models.AmazonRdsForOracleSource
- uid: azure.synapse.artifacts.models.AmazonRdsForOracleSource
- - name: azure.synapse.artifacts.models.AmazonRdsForOracleTableDataset
- uid: azure.synapse.artifacts.models.AmazonRdsForOracleTableDataset
- - name: azure.synapse.artifacts.models.AmazonRdsForSqlServerLinkedService
- uid: azure.synapse.artifacts.models.AmazonRdsForSqlServerLinkedService
- - name: azure.synapse.artifacts.models.AmazonRdsForSqlServerSource
- uid: azure.synapse.artifacts.models.AmazonRdsForSqlServerSource
- - name: azure.synapse.artifacts.models.AmazonRdsForSqlServerTableDataset
- uid: azure.synapse.artifacts.models.AmazonRdsForSqlServerTableDataset
- name: azure.synapse.artifacts.models.AmazonRedshiftLinkedService
uid: azure.synapse.artifacts.models.AmazonRedshiftLinkedService
- - name: azure.synapse.artifacts.models.AmazonRedshiftSource
- uid: azure.synapse.artifacts.models.AmazonRedshiftSource
- name: azure.synapse.artifacts.models.AmazonRedshiftTableDataset
uid: azure.synapse.artifacts.models.AmazonRedshiftTableDataset
- - name: azure.synapse.artifacts.models.AmazonS3Dataset
- uid: azure.synapse.artifacts.models.AmazonS3Dataset
- name: azure.synapse.artifacts.models.AmazonS3LinkedService
uid: azure.synapse.artifacts.models.AmazonS3LinkedService
- - name: azure.synapse.artifacts.models.AmazonS3Location
- uid: azure.synapse.artifacts.models.AmazonS3Location
- - name: azure.synapse.artifacts.models.AmazonS3ReadSettings
- uid: azure.synapse.artifacts.models.AmazonS3ReadSettings
- - name: azure.synapse.artifacts.models.AppFiguresLinkedService
- uid: azure.synapse.artifacts.models.AppFiguresLinkedService
- name: azure.synapse.artifacts.models.AppendVariableActivity
uid: azure.synapse.artifacts.models.AppendVariableActivity
- - name: azure.synapse.artifacts.models.ArtifactRenameRequest
- uid: azure.synapse.artifacts.models.ArtifactRenameRequest
- - name: azure.synapse.artifacts.models.AsanaLinkedService
- uid: azure.synapse.artifacts.models.AsanaLinkedService
- - name: azure.synapse.artifacts.models.AutoPauseProperties
- uid: azure.synapse.artifacts.models.AutoPauseProperties
- - name: azure.synapse.artifacts.models.AutoScaleProperties
- uid: azure.synapse.artifacts.models.AutoScaleProperties
- name: azure.synapse.artifacts.models.AvroCompressionCodec
uid: azure.synapse.artifacts.models.AvroCompressionCodec
- name: azure.synapse.artifacts.models.AvroDataset
uid: azure.synapse.artifacts.models.AvroDataset
- - name: azure.synapse.artifacts.models.AvroFormat
- uid: azure.synapse.artifacts.models.AvroFormat
- - name: azure.synapse.artifacts.models.AvroSink
- uid: azure.synapse.artifacts.models.AvroSink
- - name: azure.synapse.artifacts.models.AvroSource
- uid: azure.synapse.artifacts.models.AvroSource
- - name: azure.synapse.artifacts.models.AvroWriteSettings
- uid: azure.synapse.artifacts.models.AvroWriteSettings
- name: azure.synapse.artifacts.models.AzureBatchLinkedService
uid: azure.synapse.artifacts.models.AzureBatchLinkedService
- - name: azure.synapse.artifacts.models.AzureBlobDataset
- uid: azure.synapse.artifacts.models.AzureBlobDataset
- - name: azure.synapse.artifacts.models.AzureBlobFSDataset
- uid: azure.synapse.artifacts.models.AzureBlobFSDataset
- name: azure.synapse.artifacts.models.AzureBlobFSLinkedService
uid: azure.synapse.artifacts.models.AzureBlobFSLinkedService
- - name: azure.synapse.artifacts.models.AzureBlobFSLocation
- uid: azure.synapse.artifacts.models.AzureBlobFSLocation
- - name: azure.synapse.artifacts.models.AzureBlobFSReadSettings
- uid: azure.synapse.artifacts.models.AzureBlobFSReadSettings
- - name: azure.synapse.artifacts.models.AzureBlobFSSink
- uid: azure.synapse.artifacts.models.AzureBlobFSSink
- - name: azure.synapse.artifacts.models.AzureBlobFSSource
- uid: azure.synapse.artifacts.models.AzureBlobFSSource
- - name: azure.synapse.artifacts.models.AzureBlobFSWriteSettings
- uid: azure.synapse.artifacts.models.AzureBlobFSWriteSettings
- name: azure.synapse.artifacts.models.AzureBlobStorageLinkedService
uid: azure.synapse.artifacts.models.AzureBlobStorageLinkedService
- - name: azure.synapse.artifacts.models.AzureBlobStorageLocation
- uid: azure.synapse.artifacts.models.AzureBlobStorageLocation
- - name: azure.synapse.artifacts.models.AzureBlobStorageReadSettings
- uid: azure.synapse.artifacts.models.AzureBlobStorageReadSettings
- - name: azure.synapse.artifacts.models.AzureBlobStorageWriteSettings
- uid: azure.synapse.artifacts.models.AzureBlobStorageWriteSettings
- name: azure.synapse.artifacts.models.AzureDataExplorerCommandActivity
uid: azure.synapse.artifacts.models.AzureDataExplorerCommandActivity
- name: azure.synapse.artifacts.models.AzureDataExplorerLinkedService
uid: azure.synapse.artifacts.models.AzureDataExplorerLinkedService
- - name: azure.synapse.artifacts.models.AzureDataExplorerSink
- uid: azure.synapse.artifacts.models.AzureDataExplorerSink
- - name: azure.synapse.artifacts.models.AzureDataExplorerSource
- uid: azure.synapse.artifacts.models.AzureDataExplorerSource
- name: azure.synapse.artifacts.models.AzureDataExplorerTableDataset
uid: azure.synapse.artifacts.models.AzureDataExplorerTableDataset
- name: azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService
uid: azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService
- - name: azure.synapse.artifacts.models.AzureDataLakeStoreDataset
- uid: azure.synapse.artifacts.models.AzureDataLakeStoreDataset
- name: azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService
uid: azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService
- - name: azure.synapse.artifacts.models.AzureDataLakeStoreLocation
- uid: azure.synapse.artifacts.models.AzureDataLakeStoreLocation
- - name: azure.synapse.artifacts.models.AzureDataLakeStoreReadSettings
- uid: azure.synapse.artifacts.models.AzureDataLakeStoreReadSettings
- - name: azure.synapse.artifacts.models.AzureDataLakeStoreSink
- uid: azure.synapse.artifacts.models.AzureDataLakeStoreSink
- - name: azure.synapse.artifacts.models.AzureDataLakeStoreSource
- uid: azure.synapse.artifacts.models.AzureDataLakeStoreSource
- - name: azure.synapse.artifacts.models.AzureDataLakeStoreWriteSettings
- uid: azure.synapse.artifacts.models.AzureDataLakeStoreWriteSettings
- - name: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeDataset
- uid: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeDataset
- - name: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeExportCommand
- uid: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeExportCommand
- - name: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeImportCommand
- uid: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeImportCommand
- - name: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeLinkedService
- uid: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeLinkedService
- - name: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeSink
- uid: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeSink
- - name: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeSource
- uid: azure.synapse.artifacts.models.AzureDatabricksDeltaLakeSource
- name: azure.synapse.artifacts.models.AzureDatabricksLinkedService
uid: azure.synapse.artifacts.models.AzureDatabricksLinkedService
- - name: azure.synapse.artifacts.models.AzureEntityResource
- uid: azure.synapse.artifacts.models.AzureEntityResource
- name: azure.synapse.artifacts.models.AzureFileStorageLinkedService
uid: azure.synapse.artifacts.models.AzureFileStorageLinkedService
- - name: azure.synapse.artifacts.models.AzureFileStorageLocation
- uid: azure.synapse.artifacts.models.AzureFileStorageLocation
- - name: azure.synapse.artifacts.models.AzureFileStorageReadSettings
- uid: azure.synapse.artifacts.models.AzureFileStorageReadSettings
- - name: azure.synapse.artifacts.models.AzureFileStorageWriteSettings
- uid: azure.synapse.artifacts.models.AzureFileStorageWriteSettings
- name: azure.synapse.artifacts.models.AzureFunctionActivity
uid: azure.synapse.artifacts.models.AzureFunctionActivity
- name: azure.synapse.artifacts.models.AzureFunctionActivityMethod
@@ -92148,34 +91812,18 @@
uid: azure.synapse.artifacts.models.AzureMLWebServiceFile
- name: azure.synapse.artifacts.models.AzureMariaDBLinkedService
uid: azure.synapse.artifacts.models.AzureMariaDBLinkedService
- - name: azure.synapse.artifacts.models.AzureMariaDBSource
- uid: azure.synapse.artifacts.models.AzureMariaDBSource
- name: azure.synapse.artifacts.models.AzureMariaDBTableDataset
uid: azure.synapse.artifacts.models.AzureMariaDBTableDataset
- name: azure.synapse.artifacts.models.AzureMySqlLinkedService
uid: azure.synapse.artifacts.models.AzureMySqlLinkedService
- - name: azure.synapse.artifacts.models.AzureMySqlSink
- uid: azure.synapse.artifacts.models.AzureMySqlSink
- - name: azure.synapse.artifacts.models.AzureMySqlSource
- uid: azure.synapse.artifacts.models.AzureMySqlSource
- name: azure.synapse.artifacts.models.AzureMySqlTableDataset
uid: azure.synapse.artifacts.models.AzureMySqlTableDataset
- name: azure.synapse.artifacts.models.AzurePostgreSqlLinkedService
uid: azure.synapse.artifacts.models.AzurePostgreSqlLinkedService
- - name: azure.synapse.artifacts.models.AzurePostgreSqlSink
- uid: azure.synapse.artifacts.models.AzurePostgreSqlSink
- - name: azure.synapse.artifacts.models.AzurePostgreSqlSource
- uid: azure.synapse.artifacts.models.AzurePostgreSqlSource
- name: azure.synapse.artifacts.models.AzurePostgreSqlTableDataset
uid: azure.synapse.artifacts.models.AzurePostgreSqlTableDataset
- - name: azure.synapse.artifacts.models.AzureQueueSink
- uid: azure.synapse.artifacts.models.AzureQueueSink
- name: azure.synapse.artifacts.models.AzureSearchIndexDataset
uid: azure.synapse.artifacts.models.AzureSearchIndexDataset
- - name: azure.synapse.artifacts.models.AzureSearchIndexSink
- uid: azure.synapse.artifacts.models.AzureSearchIndexSink
- - name: azure.synapse.artifacts.models.AzureSearchIndexWriteBehaviorType
- uid: azure.synapse.artifacts.models.AzureSearchIndexWriteBehaviorType
- name: azure.synapse.artifacts.models.AzureSearchLinkedService
uid: azure.synapse.artifacts.models.AzureSearchLinkedService
- name: azure.synapse.artifacts.models.AzureSqlDWLinkedService
@@ -92188,166 +91836,74 @@
uid: azure.synapse.artifacts.models.AzureSqlMILinkedService
- name: azure.synapse.artifacts.models.AzureSqlMITableDataset
uid: azure.synapse.artifacts.models.AzureSqlMITableDataset
- - name: azure.synapse.artifacts.models.AzureSqlSink
- uid: azure.synapse.artifacts.models.AzureSqlSink
- - name: azure.synapse.artifacts.models.AzureSqlSource
- uid: azure.synapse.artifacts.models.AzureSqlSource
- name: azure.synapse.artifacts.models.AzureSqlTableDataset
uid: azure.synapse.artifacts.models.AzureSqlTableDataset
- - name: azure.synapse.artifacts.models.AzureStorageAuthenticationType
- uid: azure.synapse.artifacts.models.AzureStorageAuthenticationType
- name: azure.synapse.artifacts.models.AzureStorageLinkedService
uid: azure.synapse.artifacts.models.AzureStorageLinkedService
- - name: azure.synapse.artifacts.models.AzureSynapseArtifactsLinkedService
- uid: azure.synapse.artifacts.models.AzureSynapseArtifactsLinkedService
- name: azure.synapse.artifacts.models.AzureTableDataset
uid: azure.synapse.artifacts.models.AzureTableDataset
- - name: azure.synapse.artifacts.models.AzureTableSink
- uid: azure.synapse.artifacts.models.AzureTableSink
- - name: azure.synapse.artifacts.models.AzureTableSource
- uid: azure.synapse.artifacts.models.AzureTableSource
- name: azure.synapse.artifacts.models.AzureTableStorageLinkedService
uid: azure.synapse.artifacts.models.AzureTableStorageLinkedService
- - name: azure.synapse.artifacts.models.BigDataPoolParametrizationReference
- uid: azure.synapse.artifacts.models.BigDataPoolParametrizationReference
- name: azure.synapse.artifacts.models.BigDataPoolReference
uid: azure.synapse.artifacts.models.BigDataPoolReference
- - name: azure.synapse.artifacts.models.BigDataPoolReferenceType
- uid: azure.synapse.artifacts.models.BigDataPoolReferenceType
- - name: azure.synapse.artifacts.models.BigDataPoolResourceInfo
- uid: azure.synapse.artifacts.models.BigDataPoolResourceInfo
- - name: azure.synapse.artifacts.models.BigDataPoolResourceInfoListResult
- uid: azure.synapse.artifacts.models.BigDataPoolResourceInfoListResult
- name: azure.synapse.artifacts.models.BinaryDataset
uid: azure.synapse.artifacts.models.BinaryDataset
- - name: azure.synapse.artifacts.models.BinaryReadSettings
- uid: azure.synapse.artifacts.models.BinaryReadSettings
- - name: azure.synapse.artifacts.models.BinarySink
- uid: azure.synapse.artifacts.models.BinarySink
- - name: azure.synapse.artifacts.models.BinarySource
- uid: azure.synapse.artifacts.models.BinarySource
- - name: azure.synapse.artifacts.models.BlobEventType
- uid: azure.synapse.artifacts.models.BlobEventType
- - name: azure.synapse.artifacts.models.BlobEventsTrigger
- uid: azure.synapse.artifacts.models.BlobEventsTrigger
- - name: azure.synapse.artifacts.models.BlobSink
- uid: azure.synapse.artifacts.models.BlobSink
- - name: azure.synapse.artifacts.models.BlobSource
- uid: azure.synapse.artifacts.models.BlobSource
- - name: azure.synapse.artifacts.models.BlobTrigger
- uid: azure.synapse.artifacts.models.BlobTrigger
- name: azure.synapse.artifacts.models.CassandraLinkedService
uid: azure.synapse.artifacts.models.CassandraLinkedService
- - name: azure.synapse.artifacts.models.CassandraSource
- uid: azure.synapse.artifacts.models.CassandraSource
- - name: azure.synapse.artifacts.models.CassandraSourceReadConsistencyLevels
- uid: azure.synapse.artifacts.models.CassandraSourceReadConsistencyLevels
- name: azure.synapse.artifacts.models.CassandraTableDataset
uid: azure.synapse.artifacts.models.CassandraTableDataset
- name: azure.synapse.artifacts.models.CellOutputType
uid: azure.synapse.artifacts.models.CellOutputType
- - name: azure.synapse.artifacts.models.ChainingTrigger
- uid: azure.synapse.artifacts.models.ChainingTrigger
- name: azure.synapse.artifacts.models.CloudError
uid: azure.synapse.artifacts.models.CloudError
- name: azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset
uid: azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset
- name: azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService
uid: azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService
- - name: azure.synapse.artifacts.models.CommonDataServiceForAppsSink
- uid: azure.synapse.artifacts.models.CommonDataServiceForAppsSink
- - name: azure.synapse.artifacts.models.CommonDataServiceForAppsSource
- uid: azure.synapse.artifacts.models.CommonDataServiceForAppsSource
- - name: azure.synapse.artifacts.models.CompressionCodec
- uid: azure.synapse.artifacts.models.CompressionCodec
- - name: azure.synapse.artifacts.models.CompressionReadSettings
- uid: azure.synapse.artifacts.models.CompressionReadSettings
- name: azure.synapse.artifacts.models.ConcurLinkedService
uid: azure.synapse.artifacts.models.ConcurLinkedService
- name: azure.synapse.artifacts.models.ConcurObjectDataset
uid: azure.synapse.artifacts.models.ConcurObjectDataset
- - name: azure.synapse.artifacts.models.ConcurSource
- uid: azure.synapse.artifacts.models.ConcurSource
- - name: azure.synapse.artifacts.models.ConfigurationType
- uid: azure.synapse.artifacts.models.ConfigurationType
- name: azure.synapse.artifacts.models.ControlActivity
uid: azure.synapse.artifacts.models.ControlActivity
- name: azure.synapse.artifacts.models.CopyActivity
uid: azure.synapse.artifacts.models.CopyActivity
- - name: azure.synapse.artifacts.models.CopyActivityLogSettings
- uid: azure.synapse.artifacts.models.CopyActivityLogSettings
- - name: azure.synapse.artifacts.models.CopyBehaviorType
- uid: azure.synapse.artifacts.models.CopyBehaviorType
- name: azure.synapse.artifacts.models.CopySink
uid: azure.synapse.artifacts.models.CopySink
- name: azure.synapse.artifacts.models.CopySource
uid: azure.synapse.artifacts.models.CopySource
- - name: azure.synapse.artifacts.models.CopyTranslator
- uid: azure.synapse.artifacts.models.CopyTranslator
- name: azure.synapse.artifacts.models.CosmosDbLinkedService
uid: azure.synapse.artifacts.models.CosmosDbLinkedService
- name: azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset
uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset
- name: azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService
uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService
- - name: azure.synapse.artifacts.models.CosmosDbMongoDbApiSink
- uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiSink
- - name: azure.synapse.artifacts.models.CosmosDbMongoDbApiSource
- uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiSource
- name: azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset
uid: azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset
- - name: azure.synapse.artifacts.models.CosmosDbSqlApiSink
- uid: azure.synapse.artifacts.models.CosmosDbSqlApiSink
- - name: azure.synapse.artifacts.models.CosmosDbSqlApiSource
- uid: azure.synapse.artifacts.models.CosmosDbSqlApiSource
- name: azure.synapse.artifacts.models.CouchbaseLinkedService
uid: azure.synapse.artifacts.models.CouchbaseLinkedService
- - name: azure.synapse.artifacts.models.CouchbaseSource
- uid: azure.synapse.artifacts.models.CouchbaseSource
- name: azure.synapse.artifacts.models.CouchbaseTableDataset
uid: azure.synapse.artifacts.models.CouchbaseTableDataset
- name: azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest
uid: azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest
- name: azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse
uid: azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse
- - name: azure.synapse.artifacts.models.CreateMode
- uid: azure.synapse.artifacts.models.CreateMode
- name: azure.synapse.artifacts.models.CreateRunResponse
uid: azure.synapse.artifacts.models.CreateRunResponse
- - name: azure.synapse.artifacts.models.CredentialReference
- uid: azure.synapse.artifacts.models.CredentialReference
- - name: azure.synapse.artifacts.models.CredentialReferenceType
- uid: azure.synapse.artifacts.models.CredentialReferenceType
- name: azure.synapse.artifacts.models.CustomActivity
uid: azure.synapse.artifacts.models.CustomActivity
- name: azure.synapse.artifacts.models.CustomActivityReferenceObject
uid: azure.synapse.artifacts.models.CustomActivityReferenceObject
- name: azure.synapse.artifacts.models.CustomDataSourceLinkedService
uid: azure.synapse.artifacts.models.CustomDataSourceLinkedService
- - name: azure.synapse.artifacts.models.CustomDataset
- uid: azure.synapse.artifacts.models.CustomDataset
- - name: azure.synapse.artifacts.models.CustomEventsTrigger
- uid: azure.synapse.artifacts.models.CustomEventsTrigger
- - name: azure.synapse.artifacts.models.CustomSetupBase
- uid: azure.synapse.artifacts.models.CustomSetupBase
- - name: azure.synapse.artifacts.models.CustomerManagedKeyDetails
- uid: azure.synapse.artifacts.models.CustomerManagedKeyDetails
- - name: azure.synapse.artifacts.models.DWCopyCommandDefaultValue
- uid: azure.synapse.artifacts.models.DWCopyCommandDefaultValue
- - name: azure.synapse.artifacts.models.DWCopyCommandSettings
- uid: azure.synapse.artifacts.models.DWCopyCommandSettings
- name: azure.synapse.artifacts.models.DataFlow
uid: azure.synapse.artifacts.models.DataFlow
- name: azure.synapse.artifacts.models.DataFlowComputeType
uid: azure.synapse.artifacts.models.DataFlowComputeType
- - name: azure.synapse.artifacts.models.DataFlowDebugCommandPayload
- uid: azure.synapse.artifacts.models.DataFlowDebugCommandPayload
- name: azure.synapse.artifacts.models.DataFlowDebugCommandRequest
uid: azure.synapse.artifacts.models.DataFlowDebugCommandRequest
- name: azure.synapse.artifacts.models.DataFlowDebugCommandResponse
uid: azure.synapse.artifacts.models.DataFlowDebugCommandResponse
- - name: azure.synapse.artifacts.models.DataFlowDebugCommandType
- uid: azure.synapse.artifacts.models.DataFlowDebugCommandType
- name: azure.synapse.artifacts.models.DataFlowDebugPackage
uid: azure.synapse.artifacts.models.DataFlowDebugPackage
- name: azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings
@@ -92370,8 +91926,6 @@
uid: azure.synapse.artifacts.models.DataFlowListResponse
- name: azure.synapse.artifacts.models.DataFlowReference
uid: azure.synapse.artifacts.models.DataFlowReference
- - name: azure.synapse.artifacts.models.DataFlowReferenceType
- uid: azure.synapse.artifacts.models.DataFlowReferenceType
- name: azure.synapse.artifacts.models.DataFlowResource
uid: azure.synapse.artifacts.models.DataFlowResource
- name: azure.synapse.artifacts.models.DataFlowSink
@@ -92384,8 +91938,6 @@
uid: azure.synapse.artifacts.models.DataFlowStagingInfo
- name: azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity
uid: azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity
- - name: azure.synapse.artifacts.models.DataLakeStorageAccountDetails
- uid: azure.synapse.artifacts.models.DataLakeStorageAccountDetails
- name: azure.synapse.artifacts.models.DatabricksNotebookActivity
uid: azure.synapse.artifacts.models.DatabricksNotebookActivity
- name: azure.synapse.artifacts.models.DatabricksSparkJarActivity
@@ -92394,92 +91946,60 @@
uid: azure.synapse.artifacts.models.DatabricksSparkPythonActivity
- name: azure.synapse.artifacts.models.Dataset
uid: azure.synapse.artifacts.models.Dataset
+ - name: azure.synapse.artifacts.models.DatasetBZip2Compression
+ uid: azure.synapse.artifacts.models.DatasetBZip2Compression
- name: azure.synapse.artifacts.models.DatasetCompression
uid: azure.synapse.artifacts.models.DatasetCompression
- name: azure.synapse.artifacts.models.DatasetCompressionLevel
uid: azure.synapse.artifacts.models.DatasetCompressionLevel
- - name: azure.synapse.artifacts.models.DatasetDataElement
- uid: azure.synapse.artifacts.models.DatasetDataElement
- name: azure.synapse.artifacts.models.DatasetDebugResource
uid: azure.synapse.artifacts.models.DatasetDebugResource
+ - name: azure.synapse.artifacts.models.DatasetDeflateCompression
+ uid: azure.synapse.artifacts.models.DatasetDeflateCompression
- name: azure.synapse.artifacts.models.DatasetFolder
uid: azure.synapse.artifacts.models.DatasetFolder
+ - name: azure.synapse.artifacts.models.DatasetGZipCompression
+ uid: azure.synapse.artifacts.models.DatasetGZipCompression
- name: azure.synapse.artifacts.models.DatasetListResponse
uid: azure.synapse.artifacts.models.DatasetListResponse
- name: azure.synapse.artifacts.models.DatasetLocation
uid: azure.synapse.artifacts.models.DatasetLocation
- name: azure.synapse.artifacts.models.DatasetReference
uid: azure.synapse.artifacts.models.DatasetReference
- - name: azure.synapse.artifacts.models.DatasetReferenceType
- uid: azure.synapse.artifacts.models.DatasetReferenceType
- name: azure.synapse.artifacts.models.DatasetResource
uid: azure.synapse.artifacts.models.DatasetResource
- - name: azure.synapse.artifacts.models.DatasetSchemaDataElement
- uid: azure.synapse.artifacts.models.DatasetSchemaDataElement
- - name: azure.synapse.artifacts.models.DatasetStorageFormat
- uid: azure.synapse.artifacts.models.DatasetStorageFormat
- - name: azure.synapse.artifacts.models.DataworldLinkedService
- uid: azure.synapse.artifacts.models.DataworldLinkedService
- - name: azure.synapse.artifacts.models.DayOfWeek
- uid: azure.synapse.artifacts.models.DayOfWeek
- - name: azure.synapse.artifacts.models.Db2AuthenticationType
- uid: azure.synapse.artifacts.models.Db2AuthenticationType
+ - name: azure.synapse.artifacts.models.DatasetZipDeflateCompression
+ uid: azure.synapse.artifacts.models.DatasetZipDeflateCompression
- name: azure.synapse.artifacts.models.Db2LinkedService
uid: azure.synapse.artifacts.models.Db2LinkedService
- - name: azure.synapse.artifacts.models.Db2Source
- uid: azure.synapse.artifacts.models.Db2Source
- name: azure.synapse.artifacts.models.Db2TableDataset
uid: azure.synapse.artifacts.models.Db2TableDataset
- name: azure.synapse.artifacts.models.DeleteActivity
uid: azure.synapse.artifacts.models.DeleteActivity
- name: azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest
uid: azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest
+ - name: azure.synapse.artifacts.models.DelimitedTextCompressionCodec
+ uid: azure.synapse.artifacts.models.DelimitedTextCompressionCodec
- name: azure.synapse.artifacts.models.DelimitedTextDataset
uid: azure.synapse.artifacts.models.DelimitedTextDataset
- - name: azure.synapse.artifacts.models.DelimitedTextReadSettings
- uid: azure.synapse.artifacts.models.DelimitedTextReadSettings
- - name: azure.synapse.artifacts.models.DelimitedTextSink
- uid: azure.synapse.artifacts.models.DelimitedTextSink
- - name: azure.synapse.artifacts.models.DelimitedTextSource
- uid: azure.synapse.artifacts.models.DelimitedTextSource
- - name: azure.synapse.artifacts.models.DelimitedTextWriteSettings
- uid: azure.synapse.artifacts.models.DelimitedTextWriteSettings
- name: azure.synapse.artifacts.models.DependencyCondition
uid: azure.synapse.artifacts.models.DependencyCondition
- - name: azure.synapse.artifacts.models.DependencyReference
- uid: azure.synapse.artifacts.models.DependencyReference
- - name: azure.synapse.artifacts.models.DistcpSettings
- uid: azure.synapse.artifacts.models.DistcpSettings
- name: azure.synapse.artifacts.models.DocumentDbCollectionDataset
uid: azure.synapse.artifacts.models.DocumentDbCollectionDataset
- - name: azure.synapse.artifacts.models.DocumentDbCollectionSink
- uid: azure.synapse.artifacts.models.DocumentDbCollectionSink
- - name: azure.synapse.artifacts.models.DocumentDbCollectionSource
- uid: azure.synapse.artifacts.models.DocumentDbCollectionSource
- name: azure.synapse.artifacts.models.DrillLinkedService
uid: azure.synapse.artifacts.models.DrillLinkedService
- - name: azure.synapse.artifacts.models.DrillSource
- uid: azure.synapse.artifacts.models.DrillSource
- name: azure.synapse.artifacts.models.DrillTableDataset
uid: azure.synapse.artifacts.models.DrillTableDataset
- - name: azure.synapse.artifacts.models.DynamicExecutorAllocation
- uid: azure.synapse.artifacts.models.DynamicExecutorAllocation
- name: azure.synapse.artifacts.models.DynamicsAXLinkedService
uid: azure.synapse.artifacts.models.DynamicsAXLinkedService
- name: azure.synapse.artifacts.models.DynamicsAXResourceDataset
uid: azure.synapse.artifacts.models.DynamicsAXResourceDataset
- - name: azure.synapse.artifacts.models.DynamicsAXSource
- uid: azure.synapse.artifacts.models.DynamicsAXSource
- name: azure.synapse.artifacts.models.DynamicsAuthenticationType
uid: azure.synapse.artifacts.models.DynamicsAuthenticationType
- name: azure.synapse.artifacts.models.DynamicsCrmEntityDataset
uid: azure.synapse.artifacts.models.DynamicsCrmEntityDataset
- name: azure.synapse.artifacts.models.DynamicsCrmLinkedService
uid: azure.synapse.artifacts.models.DynamicsCrmLinkedService
- - name: azure.synapse.artifacts.models.DynamicsCrmSink
- uid: azure.synapse.artifacts.models.DynamicsCrmSink
- - name: azure.synapse.artifacts.models.DynamicsCrmSource
- uid: azure.synapse.artifacts.models.DynamicsCrmSource
- name: azure.synapse.artifacts.models.DynamicsDeploymentType
uid: azure.synapse.artifacts.models.DynamicsDeploymentType
- name: azure.synapse.artifacts.models.DynamicsEntityDataset
@@ -92488,40 +92008,14 @@
uid: azure.synapse.artifacts.models.DynamicsLinkedService
- name: azure.synapse.artifacts.models.DynamicsServicePrincipalCredentialType
uid: azure.synapse.artifacts.models.DynamicsServicePrincipalCredentialType
- - name: azure.synapse.artifacts.models.DynamicsSink
- uid: azure.synapse.artifacts.models.DynamicsSink
- - name: azure.synapse.artifacts.models.DynamicsSinkWriteBehavior
- uid: azure.synapse.artifacts.models.DynamicsSinkWriteBehavior
- - name: azure.synapse.artifacts.models.DynamicsSource
- uid: azure.synapse.artifacts.models.DynamicsSource
- - name: azure.synapse.artifacts.models.EditTablesRequest
- uid: azure.synapse.artifacts.models.EditTablesRequest
- name: azure.synapse.artifacts.models.EloquaLinkedService
uid: azure.synapse.artifacts.models.EloquaLinkedService
- name: azure.synapse.artifacts.models.EloquaObjectDataset
uid: azure.synapse.artifacts.models.EloquaObjectDataset
- - name: azure.synapse.artifacts.models.EloquaSource
- uid: azure.synapse.artifacts.models.EloquaSource
- - name: azure.synapse.artifacts.models.EncryptionDetails
- uid: azure.synapse.artifacts.models.EncryptionDetails
- - name: azure.synapse.artifacts.models.EntityReference
- uid: azure.synapse.artifacts.models.EntityReference
- - name: azure.synapse.artifacts.models.Enum13
- uid: azure.synapse.artifacts.models.Enum13
- - name: azure.synapse.artifacts.models.ErrorAdditionalInfo
- uid: azure.synapse.artifacts.models.ErrorAdditionalInfo
- - name: azure.synapse.artifacts.models.ErrorContract
- uid: azure.synapse.artifacts.models.ErrorContract
- - name: azure.synapse.artifacts.models.ErrorResponse
- uid: azure.synapse.artifacts.models.ErrorResponse
- name: azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest
uid: azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest
- name: azure.synapse.artifacts.models.EventSubscriptionStatus
uid: azure.synapse.artifacts.models.EventSubscriptionStatus
- - name: azure.synapse.artifacts.models.ExcelDataset
- uid: azure.synapse.artifacts.models.ExcelDataset
- - name: azure.synapse.artifacts.models.ExcelSource
- uid: azure.synapse.artifacts.models.ExcelSource
- name: azure.synapse.artifacts.models.ExecuteDataFlowActivity
uid: azure.synapse.artifacts.models.ExecuteDataFlowActivity
- name: azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute
@@ -92532,88 +92026,42 @@
uid: azure.synapse.artifacts.models.ExecuteSSISPackageActivity
- name: azure.synapse.artifacts.models.ExecutionActivity
uid: azure.synapse.artifacts.models.ExecutionActivity
- - name: azure.synapse.artifacts.models.ExportSettings
- uid: azure.synapse.artifacts.models.ExportSettings
- name: azure.synapse.artifacts.models.ExposureControlRequest
uid: azure.synapse.artifacts.models.ExposureControlRequest
- name: azure.synapse.artifacts.models.ExposureControlResponse
uid: azure.synapse.artifacts.models.ExposureControlResponse
- name: azure.synapse.artifacts.models.Expression
uid: azure.synapse.artifacts.models.Expression
- - name: azure.synapse.artifacts.models.ExpressionType
- uid: azure.synapse.artifacts.models.ExpressionType
- - name: azure.synapse.artifacts.models.FailActivity
- uid: azure.synapse.artifacts.models.FailActivity
- name: azure.synapse.artifacts.models.FileServerLinkedService
uid: azure.synapse.artifacts.models.FileServerLinkedService
- - name: azure.synapse.artifacts.models.FileServerLocation
- uid: azure.synapse.artifacts.models.FileServerLocation
- - name: azure.synapse.artifacts.models.FileServerReadSettings
- uid: azure.synapse.artifacts.models.FileServerReadSettings
- - name: azure.synapse.artifacts.models.FileServerWriteSettings
- uid: azure.synapse.artifacts.models.FileServerWriteSettings
- - name: azure.synapse.artifacts.models.FileShareDataset
- uid: azure.synapse.artifacts.models.FileShareDataset
- - name: azure.synapse.artifacts.models.FileSystemSink
- uid: azure.synapse.artifacts.models.FileSystemSink
- - name: azure.synapse.artifacts.models.FileSystemSource
- uid: azure.synapse.artifacts.models.FileSystemSource
- name: azure.synapse.artifacts.models.FilterActivity
uid: azure.synapse.artifacts.models.FilterActivity
- - name: azure.synapse.artifacts.models.Flowlet
- uid: azure.synapse.artifacts.models.Flowlet
- name: azure.synapse.artifacts.models.ForEachActivity
uid: azure.synapse.artifacts.models.ForEachActivity
- - name: azure.synapse.artifacts.models.FormatReadSettings
- uid: azure.synapse.artifacts.models.FormatReadSettings
- - name: azure.synapse.artifacts.models.FormatWriteSettings
- uid: azure.synapse.artifacts.models.FormatWriteSettings
- name: azure.synapse.artifacts.models.FtpAuthenticationType
uid: azure.synapse.artifacts.models.FtpAuthenticationType
- - name: azure.synapse.artifacts.models.FtpReadSettings
- uid: azure.synapse.artifacts.models.FtpReadSettings
- name: azure.synapse.artifacts.models.FtpServerLinkedService
uid: azure.synapse.artifacts.models.FtpServerLinkedService
- - name: azure.synapse.artifacts.models.FtpServerLocation
- uid: azure.synapse.artifacts.models.FtpServerLocation
- name: azure.synapse.artifacts.models.GetMetadataActivity
uid: azure.synapse.artifacts.models.GetMetadataActivity
- name: azure.synapse.artifacts.models.GetSsisObjectMetadataRequest
uid: azure.synapse.artifacts.models.GetSsisObjectMetadataRequest
- - name: azure.synapse.artifacts.models.GitHubAccessTokenRequest
- uid: azure.synapse.artifacts.models.GitHubAccessTokenRequest
- - name: azure.synapse.artifacts.models.GitHubAccessTokenResponse
- uid: azure.synapse.artifacts.models.GitHubAccessTokenResponse
- - name: azure.synapse.artifacts.models.GitHubClientSecret
- uid: azure.synapse.artifacts.models.GitHubClientSecret
- name: azure.synapse.artifacts.models.GoogleAdWordsAuthenticationType
uid: azure.synapse.artifacts.models.GoogleAdWordsAuthenticationType
- name: azure.synapse.artifacts.models.GoogleAdWordsLinkedService
uid: azure.synapse.artifacts.models.GoogleAdWordsLinkedService
- name: azure.synapse.artifacts.models.GoogleAdWordsObjectDataset
uid: azure.synapse.artifacts.models.GoogleAdWordsObjectDataset
- - name: azure.synapse.artifacts.models.GoogleAdWordsSource
- uid: azure.synapse.artifacts.models.GoogleAdWordsSource
- name: azure.synapse.artifacts.models.GoogleBigQueryAuthenticationType
uid: azure.synapse.artifacts.models.GoogleBigQueryAuthenticationType
- name: azure.synapse.artifacts.models.GoogleBigQueryLinkedService
uid: azure.synapse.artifacts.models.GoogleBigQueryLinkedService
- name: azure.synapse.artifacts.models.GoogleBigQueryObjectDataset
uid: azure.synapse.artifacts.models.GoogleBigQueryObjectDataset
- - name: azure.synapse.artifacts.models.GoogleBigQuerySource
- uid: azure.synapse.artifacts.models.GoogleBigQuerySource
- name: azure.synapse.artifacts.models.GoogleCloudStorageLinkedService
uid: azure.synapse.artifacts.models.GoogleCloudStorageLinkedService
- - name: azure.synapse.artifacts.models.GoogleCloudStorageLocation
- uid: azure.synapse.artifacts.models.GoogleCloudStorageLocation
- - name: azure.synapse.artifacts.models.GoogleCloudStorageReadSettings
- uid: azure.synapse.artifacts.models.GoogleCloudStorageReadSettings
- - name: azure.synapse.artifacts.models.GoogleSheetsLinkedService
- uid: azure.synapse.artifacts.models.GoogleSheetsLinkedService
- name: azure.synapse.artifacts.models.GreenplumLinkedService
uid: azure.synapse.artifacts.models.GreenplumLinkedService
- - name: azure.synapse.artifacts.models.GreenplumSource
- uid: azure.synapse.artifacts.models.GreenplumSource
- name: azure.synapse.artifacts.models.GreenplumTableDataset
uid: azure.synapse.artifacts.models.GreenplumTableDataset
- name: azure.synapse.artifacts.models.HBaseAuthenticationType
@@ -92622,8 +92070,6 @@
uid: azure.synapse.artifacts.models.HBaseLinkedService
- name: azure.synapse.artifacts.models.HBaseObjectDataset
uid: azure.synapse.artifacts.models.HBaseObjectDataset
- - name: azure.synapse.artifacts.models.HBaseSource
- uid: azure.synapse.artifacts.models.HBaseSource
- name: azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption
uid: azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption
- name: azure.synapse.artifacts.models.HDInsightHiveActivity
@@ -92642,12 +92088,6 @@
uid: azure.synapse.artifacts.models.HDInsightStreamingActivity
- name: azure.synapse.artifacts.models.HdfsLinkedService
uid: azure.synapse.artifacts.models.HdfsLinkedService
- - name: azure.synapse.artifacts.models.HdfsLocation
- uid: azure.synapse.artifacts.models.HdfsLocation
- - name: azure.synapse.artifacts.models.HdfsReadSettings
- uid: azure.synapse.artifacts.models.HdfsReadSettings
- - name: azure.synapse.artifacts.models.HdfsSource
- uid: azure.synapse.artifacts.models.HdfsSource
- name: azure.synapse.artifacts.models.HdiNodeTypes
uid: azure.synapse.artifacts.models.HdiNodeTypes
- name: azure.synapse.artifacts.models.HiveAuthenticationType
@@ -92658,28 +92098,16 @@
uid: azure.synapse.artifacts.models.HiveObjectDataset
- name: azure.synapse.artifacts.models.HiveServerType
uid: azure.synapse.artifacts.models.HiveServerType
- - name: azure.synapse.artifacts.models.HiveSource
- uid: azure.synapse.artifacts.models.HiveSource
- name: azure.synapse.artifacts.models.HiveThriftTransportProtocol
uid: azure.synapse.artifacts.models.HiveThriftTransportProtocol
- name: azure.synapse.artifacts.models.HttpAuthenticationType
uid: azure.synapse.artifacts.models.HttpAuthenticationType
- - name: azure.synapse.artifacts.models.HttpDataset
- uid: azure.synapse.artifacts.models.HttpDataset
- name: azure.synapse.artifacts.models.HttpLinkedService
uid: azure.synapse.artifacts.models.HttpLinkedService
- - name: azure.synapse.artifacts.models.HttpReadSettings
- uid: azure.synapse.artifacts.models.HttpReadSettings
- - name: azure.synapse.artifacts.models.HttpServerLocation
- uid: azure.synapse.artifacts.models.HttpServerLocation
- - name: azure.synapse.artifacts.models.HttpSource
- uid: azure.synapse.artifacts.models.HttpSource
- name: azure.synapse.artifacts.models.HubspotLinkedService
uid: azure.synapse.artifacts.models.HubspotLinkedService
- name: azure.synapse.artifacts.models.HubspotObjectDataset
uid: azure.synapse.artifacts.models.HubspotObjectDataset
- - name: azure.synapse.artifacts.models.HubspotSource
- uid: azure.synapse.artifacts.models.HubspotSource
- name: azure.synapse.artifacts.models.IfConditionActivity
uid: azure.synapse.artifacts.models.IfConditionActivity
- name: azure.synapse.artifacts.models.ImpalaAuthenticationType
@@ -92688,148 +92116,18 @@
uid: azure.synapse.artifacts.models.ImpalaLinkedService
- name: azure.synapse.artifacts.models.ImpalaObjectDataset
uid: azure.synapse.artifacts.models.ImpalaObjectDataset
- - name: azure.synapse.artifacts.models.ImpalaSource
- uid: azure.synapse.artifacts.models.ImpalaSource
- - name: azure.synapse.artifacts.models.ImportSettings
- uid: azure.synapse.artifacts.models.ImportSettings
- name: azure.synapse.artifacts.models.InformixLinkedService
uid: azure.synapse.artifacts.models.InformixLinkedService
- - name: azure.synapse.artifacts.models.InformixSink
- uid: azure.synapse.artifacts.models.InformixSink
- - name: azure.synapse.artifacts.models.InformixSource
- uid: azure.synapse.artifacts.models.InformixSource
- name: azure.synapse.artifacts.models.InformixTableDataset
uid: azure.synapse.artifacts.models.InformixTableDataset
- - name: azure.synapse.artifacts.models.IntegrationRuntime
- uid: azure.synapse.artifacts.models.IntegrationRuntime
- - name: azure.synapse.artifacts.models.IntegrationRuntimeComputeProperties
- uid: azure.synapse.artifacts.models.IntegrationRuntimeComputeProperties
- - name: azure.synapse.artifacts.models.IntegrationRuntimeCustomSetupScriptProperties
- uid: azure.synapse.artifacts.models.IntegrationRuntimeCustomSetupScriptProperties
- - name: azure.synapse.artifacts.models.IntegrationRuntimeDataFlowProperties
- uid: azure.synapse.artifacts.models.IntegrationRuntimeDataFlowProperties
- - name: azure.synapse.artifacts.models.IntegrationRuntimeDataProxyProperties
- uid: azure.synapse.artifacts.models.IntegrationRuntimeDataProxyProperties
- - name: azure.synapse.artifacts.models.IntegrationRuntimeDebugResource
- uid: azure.synapse.artifacts.models.IntegrationRuntimeDebugResource
- - name: azure.synapse.artifacts.models.IntegrationRuntimeEdition
- uid: azure.synapse.artifacts.models.IntegrationRuntimeEdition
- - name: azure.synapse.artifacts.models.IntegrationRuntimeEntityReferenceType
- uid: azure.synapse.artifacts.models.IntegrationRuntimeEntityReferenceType
- - name: azure.synapse.artifacts.models.IntegrationRuntimeLicenseType
- uid: azure.synapse.artifacts.models.IntegrationRuntimeLicenseType
- - name: azure.synapse.artifacts.models.IntegrationRuntimeListResponse
- uid: azure.synapse.artifacts.models.IntegrationRuntimeListResponse
- name: azure.synapse.artifacts.models.IntegrationRuntimeReference
uid: azure.synapse.artifacts.models.IntegrationRuntimeReference
- - name: azure.synapse.artifacts.models.IntegrationRuntimeReferenceType
- uid: azure.synapse.artifacts.models.IntegrationRuntimeReferenceType
- - name: azure.synapse.artifacts.models.IntegrationRuntimeResource
- uid: azure.synapse.artifacts.models.IntegrationRuntimeResource
- - name: azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogInfo
- uid: azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogInfo
- - name: azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogPricingTier
- uid: azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogPricingTier
- - name: azure.synapse.artifacts.models.IntegrationRuntimeSsisProperties
- uid: azure.synapse.artifacts.models.IntegrationRuntimeSsisProperties
- - name: azure.synapse.artifacts.models.IntegrationRuntimeState
- uid: azure.synapse.artifacts.models.IntegrationRuntimeState
- - name: azure.synapse.artifacts.models.IntegrationRuntimeType
- uid: azure.synapse.artifacts.models.IntegrationRuntimeType
- - name: azure.synapse.artifacts.models.IntegrationRuntimeVNetProperties
- uid: azure.synapse.artifacts.models.IntegrationRuntimeVNetProperties
- name: azure.synapse.artifacts.models.JiraLinkedService
uid: azure.synapse.artifacts.models.JiraLinkedService
- name: azure.synapse.artifacts.models.JiraObjectDataset
uid: azure.synapse.artifacts.models.JiraObjectDataset
- - name: azure.synapse.artifacts.models.JiraSource
- uid: azure.synapse.artifacts.models.JiraSource
- name: azure.synapse.artifacts.models.JsonDataset
uid: azure.synapse.artifacts.models.JsonDataset
- - name: azure.synapse.artifacts.models.JsonFormat
- uid: azure.synapse.artifacts.models.JsonFormat
- - name: azure.synapse.artifacts.models.JsonFormatFilePattern
- uid: azure.synapse.artifacts.models.JsonFormatFilePattern
- - name: azure.synapse.artifacts.models.JsonReadSettings
- uid: azure.synapse.artifacts.models.JsonReadSettings
- - name: azure.synapse.artifacts.models.JsonSink
- uid: azure.synapse.artifacts.models.JsonSink
- - name: azure.synapse.artifacts.models.JsonSource
- uid: azure.synapse.artifacts.models.JsonSource
- - name: azure.synapse.artifacts.models.JsonWriteFilePattern
- uid: azure.synapse.artifacts.models.JsonWriteFilePattern
- - name: azure.synapse.artifacts.models.JsonWriteSettings
- uid: azure.synapse.artifacts.models.JsonWriteSettings
- - name: azure.synapse.artifacts.models.KqlScript
- uid: azure.synapse.artifacts.models.KqlScript
- - name: azure.synapse.artifacts.models.KqlScriptContent
- uid: azure.synapse.artifacts.models.KqlScriptContent
- - name: azure.synapse.artifacts.models.KqlScriptContentCurrentConnection
- uid: azure.synapse.artifacts.models.KqlScriptContentCurrentConnection
- - name: azure.synapse.artifacts.models.KqlScriptContentMetadata
- uid: azure.synapse.artifacts.models.KqlScriptContentMetadata
- - name: azure.synapse.artifacts.models.KqlScriptResource
- uid: azure.synapse.artifacts.models.KqlScriptResource
- - name: azure.synapse.artifacts.models.KqlScriptsResourceCollectionResponse
- uid: azure.synapse.artifacts.models.KqlScriptsResourceCollectionResponse
- - name: azure.synapse.artifacts.models.LibraryInfo
- uid: azure.synapse.artifacts.models.LibraryInfo
- - name: azure.synapse.artifacts.models.LibraryListResponse
- uid: azure.synapse.artifacts.models.LibraryListResponse
- - name: azure.synapse.artifacts.models.LibraryRequirements
- uid: azure.synapse.artifacts.models.LibraryRequirements
- - name: azure.synapse.artifacts.models.LibraryResource
- uid: azure.synapse.artifacts.models.LibraryResource
- - name: azure.synapse.artifacts.models.LibraryResourceInfo
- uid: azure.synapse.artifacts.models.LibraryResourceInfo
- - name: azure.synapse.artifacts.models.LibraryResourceProperties
- uid: azure.synapse.artifacts.models.LibraryResourceProperties
- - name: azure.synapse.artifacts.models.LinkConnection
- uid: azure.synapse.artifacts.models.LinkConnection
- - name: azure.synapse.artifacts.models.LinkConnectionCompute
- uid: azure.synapse.artifacts.models.LinkConnectionCompute
- - name: azure.synapse.artifacts.models.LinkConnectionDetailedStatus
- uid: azure.synapse.artifacts.models.LinkConnectionDetailedStatus
- - name: azure.synapse.artifacts.models.LinkConnectionLandingZone
- uid: azure.synapse.artifacts.models.LinkConnectionLandingZone
- - name: azure.synapse.artifacts.models.LinkConnectionListResponse
- uid: azure.synapse.artifacts.models.LinkConnectionListResponse
- - name: azure.synapse.artifacts.models.LinkConnectionQueryTableStatus
- uid: azure.synapse.artifacts.models.LinkConnectionQueryTableStatus
- - name: azure.synapse.artifacts.models.LinkConnectionRefreshStatus
- uid: azure.synapse.artifacts.models.LinkConnectionRefreshStatus
- - name: azure.synapse.artifacts.models.LinkConnectionResource
- uid: azure.synapse.artifacts.models.LinkConnectionResource
- - name: azure.synapse.artifacts.models.LinkConnectionSourceDatabase
- uid: azure.synapse.artifacts.models.LinkConnectionSourceDatabase
- - name: azure.synapse.artifacts.models.LinkConnectionSourceDatabaseTypeProperties
- uid: azure.synapse.artifacts.models.LinkConnectionSourceDatabaseTypeProperties
- - name: azure.synapse.artifacts.models.LinkConnectionTargetDatabase
- uid: azure.synapse.artifacts.models.LinkConnectionTargetDatabase
- - name: azure.synapse.artifacts.models.LinkConnectionTargetDatabaseTypeProperties
- uid: azure.synapse.artifacts.models.LinkConnectionTargetDatabaseTypeProperties
- - name: azure.synapse.artifacts.models.LinkTableListResponse
- uid: azure.synapse.artifacts.models.LinkTableListResponse
- - name: azure.synapse.artifacts.models.LinkTableRequest
- uid: azure.synapse.artifacts.models.LinkTableRequest
- - name: azure.synapse.artifacts.models.LinkTableRequestSource
- uid: azure.synapse.artifacts.models.LinkTableRequestSource
- - name: azure.synapse.artifacts.models.LinkTableRequestTarget
- uid: azure.synapse.artifacts.models.LinkTableRequestTarget
- - name: azure.synapse.artifacts.models.LinkTableRequestTargetDistributionOptions
- uid: azure.synapse.artifacts.models.LinkTableRequestTargetDistributionOptions
- - name: azure.synapse.artifacts.models.LinkTableRequestTargetStructureOptions
- uid: azure.synapse.artifacts.models.LinkTableRequestTargetStructureOptions
- - name: azure.synapse.artifacts.models.LinkTableResource
- uid: azure.synapse.artifacts.models.LinkTableResource
- - name: azure.synapse.artifacts.models.LinkTableStatus
- uid: azure.synapse.artifacts.models.LinkTableStatus
- - name: azure.synapse.artifacts.models.LinkedIntegrationRuntimeKeyAuthorization
- uid: azure.synapse.artifacts.models.LinkedIntegrationRuntimeKeyAuthorization
- - name: azure.synapse.artifacts.models.LinkedIntegrationRuntimeRbacAuthorization
- uid: azure.synapse.artifacts.models.LinkedIntegrationRuntimeRbacAuthorization
- - name: azure.synapse.artifacts.models.LinkedIntegrationRuntimeType
- uid: azure.synapse.artifacts.models.LinkedIntegrationRuntimeType
- name: azure.synapse.artifacts.models.LinkedService
uid: azure.synapse.artifacts.models.LinkedService
- name: azure.synapse.artifacts.models.LinkedServiceDebugResource
@@ -92840,12 +92138,6 @@
uid: azure.synapse.artifacts.models.LinkedServiceReference
- name: azure.synapse.artifacts.models.LinkedServiceResource
uid: azure.synapse.artifacts.models.LinkedServiceResource
- - name: azure.synapse.artifacts.models.LivyStates
- uid: azure.synapse.artifacts.models.LivyStates
- - name: azure.synapse.artifacts.models.LogLocationSettings
- uid: azure.synapse.artifacts.models.LogLocationSettings
- - name: azure.synapse.artifacts.models.LogSettings
- uid: azure.synapse.artifacts.models.LogSettings
- name: azure.synapse.artifacts.models.LogStorageSettings
uid: azure.synapse.artifacts.models.LogStorageSettings
- name: azure.synapse.artifacts.models.LookupActivity
@@ -92854,102 +92146,46 @@
uid: azure.synapse.artifacts.models.MagentoLinkedService
- name: azure.synapse.artifacts.models.MagentoObjectDataset
uid: azure.synapse.artifacts.models.MagentoObjectDataset
- - name: azure.synapse.artifacts.models.MagentoSource
- uid: azure.synapse.artifacts.models.MagentoSource
- - name: azure.synapse.artifacts.models.ManagedIdentity
- uid: azure.synapse.artifacts.models.ManagedIdentity
- - name: azure.synapse.artifacts.models.ManagedIntegrationRuntime
- uid: azure.synapse.artifacts.models.ManagedIntegrationRuntime
- - name: azure.synapse.artifacts.models.ManagedVirtualNetworkReference
- uid: azure.synapse.artifacts.models.ManagedVirtualNetworkReference
- - name: azure.synapse.artifacts.models.ManagedVirtualNetworkReferenceType
- uid: azure.synapse.artifacts.models.ManagedVirtualNetworkReferenceType
- - name: azure.synapse.artifacts.models.ManagedVirtualNetworkSettings
- uid: azure.synapse.artifacts.models.ManagedVirtualNetworkSettings
- name: azure.synapse.artifacts.models.MappingDataFlow
uid: azure.synapse.artifacts.models.MappingDataFlow
- name: azure.synapse.artifacts.models.MariaDBLinkedService
uid: azure.synapse.artifacts.models.MariaDBLinkedService
- - name: azure.synapse.artifacts.models.MariaDBSource
- uid: azure.synapse.artifacts.models.MariaDBSource
- name: azure.synapse.artifacts.models.MariaDBTableDataset
uid: azure.synapse.artifacts.models.MariaDBTableDataset
- name: azure.synapse.artifacts.models.MarketoLinkedService
uid: azure.synapse.artifacts.models.MarketoLinkedService
- name: azure.synapse.artifacts.models.MarketoObjectDataset
uid: azure.synapse.artifacts.models.MarketoObjectDataset
- - name: azure.synapse.artifacts.models.MarketoSource
- uid: azure.synapse.artifacts.models.MarketoSource
- - name: azure.synapse.artifacts.models.MetastoreRegisterObject
- uid: azure.synapse.artifacts.models.MetastoreRegisterObject
- - name: azure.synapse.artifacts.models.MetastoreRegistrationResponse
- uid: azure.synapse.artifacts.models.MetastoreRegistrationResponse
- - name: azure.synapse.artifacts.models.MetastoreRequestSuccessResponse
- uid: azure.synapse.artifacts.models.MetastoreRequestSuccessResponse
- - name: azure.synapse.artifacts.models.MetastoreUpdateObject
- uid: azure.synapse.artifacts.models.MetastoreUpdateObject
- - name: azure.synapse.artifacts.models.MetastoreUpdationResponse
- uid: azure.synapse.artifacts.models.MetastoreUpdationResponse
- name: azure.synapse.artifacts.models.MicrosoftAccessLinkedService
uid: azure.synapse.artifacts.models.MicrosoftAccessLinkedService
- - name: azure.synapse.artifacts.models.MicrosoftAccessSink
- uid: azure.synapse.artifacts.models.MicrosoftAccessSink
- - name: azure.synapse.artifacts.models.MicrosoftAccessSource
- uid: azure.synapse.artifacts.models.MicrosoftAccessSource
- name: azure.synapse.artifacts.models.MicrosoftAccessTableDataset
uid: azure.synapse.artifacts.models.MicrosoftAccessTableDataset
- - name: azure.synapse.artifacts.models.MongoDbAtlasCollectionDataset
- uid: azure.synapse.artifacts.models.MongoDbAtlasCollectionDataset
- - name: azure.synapse.artifacts.models.MongoDbAtlasLinkedService
- uid: azure.synapse.artifacts.models.MongoDbAtlasLinkedService
- - name: azure.synapse.artifacts.models.MongoDbAtlasSource
- uid: azure.synapse.artifacts.models.MongoDbAtlasSource
- name: azure.synapse.artifacts.models.MongoDbAuthenticationType
uid: azure.synapse.artifacts.models.MongoDbAuthenticationType
- name: azure.synapse.artifacts.models.MongoDbCollectionDataset
uid: azure.synapse.artifacts.models.MongoDbCollectionDataset
- - name: azure.synapse.artifacts.models.MongoDbCursorMethodsProperties
- uid: azure.synapse.artifacts.models.MongoDbCursorMethodsProperties
- name: azure.synapse.artifacts.models.MongoDbLinkedService
uid: azure.synapse.artifacts.models.MongoDbLinkedService
- - name: azure.synapse.artifacts.models.MongoDbSource
- uid: azure.synapse.artifacts.models.MongoDbSource
- name: azure.synapse.artifacts.models.MongoDbV2CollectionDataset
uid: azure.synapse.artifacts.models.MongoDbV2CollectionDataset
- name: azure.synapse.artifacts.models.MongoDbV2LinkedService
uid: azure.synapse.artifacts.models.MongoDbV2LinkedService
- - name: azure.synapse.artifacts.models.MongoDbV2Source
- uid: azure.synapse.artifacts.models.MongoDbV2Source
- name: azure.synapse.artifacts.models.MultiplePipelineTrigger
uid: azure.synapse.artifacts.models.MultiplePipelineTrigger
- name: azure.synapse.artifacts.models.MySqlLinkedService
uid: azure.synapse.artifacts.models.MySqlLinkedService
- - name: azure.synapse.artifacts.models.MySqlSource
- uid: azure.synapse.artifacts.models.MySqlSource
- name: azure.synapse.artifacts.models.MySqlTableDataset
uid: azure.synapse.artifacts.models.MySqlTableDataset
- name: azure.synapse.artifacts.models.NetezzaLinkedService
uid: azure.synapse.artifacts.models.NetezzaLinkedService
- - name: azure.synapse.artifacts.models.NetezzaPartitionOption
- uid: azure.synapse.artifacts.models.NetezzaPartitionOption
- - name: azure.synapse.artifacts.models.NetezzaPartitionSettings
- uid: azure.synapse.artifacts.models.NetezzaPartitionSettings
- - name: azure.synapse.artifacts.models.NetezzaSource
- uid: azure.synapse.artifacts.models.NetezzaSource
- name: azure.synapse.artifacts.models.NetezzaTableDataset
uid: azure.synapse.artifacts.models.NetezzaTableDataset
- - name: azure.synapse.artifacts.models.NodeSize
- uid: azure.synapse.artifacts.models.NodeSize
- - name: azure.synapse.artifacts.models.NodeSizeFamily
- uid: azure.synapse.artifacts.models.NodeSizeFamily
- name: azure.synapse.artifacts.models.Notebook
uid: azure.synapse.artifacts.models.Notebook
- name: azure.synapse.artifacts.models.NotebookCell
uid: azure.synapse.artifacts.models.NotebookCell
- name: azure.synapse.artifacts.models.NotebookCellOutputItem
uid: azure.synapse.artifacts.models.NotebookCellOutputItem
- - name: azure.synapse.artifacts.models.NotebookFolder
- uid: azure.synapse.artifacts.models.NotebookFolder
- name: azure.synapse.artifacts.models.NotebookKernelSpec
uid: azure.synapse.artifacts.models.NotebookKernelSpec
- name: azure.synapse.artifacts.models.NotebookLanguageInfo
@@ -92958,12 +92194,6 @@
uid: azure.synapse.artifacts.models.NotebookListResponse
- name: azure.synapse.artifacts.models.NotebookMetadata
uid: azure.synapse.artifacts.models.NotebookMetadata
- - name: azure.synapse.artifacts.models.NotebookParameter
- uid: azure.synapse.artifacts.models.NotebookParameter
- - name: azure.synapse.artifacts.models.NotebookParameterType
- uid: azure.synapse.artifacts.models.NotebookParameterType
- - name: azure.synapse.artifacts.models.NotebookReferenceType
- uid: azure.synapse.artifacts.models.NotebookReferenceType
- name: azure.synapse.artifacts.models.NotebookResource
uid: azure.synapse.artifacts.models.NotebookResource
- name: azure.synapse.artifacts.models.NotebookSessionProperties
@@ -92976,94 +92206,50 @@
uid: azure.synapse.artifacts.models.ODataLinkedService
- name: azure.synapse.artifacts.models.ODataResourceDataset
uid: azure.synapse.artifacts.models.ODataResourceDataset
- - name: azure.synapse.artifacts.models.ODataSource
- uid: azure.synapse.artifacts.models.ODataSource
- name: azure.synapse.artifacts.models.OdbcLinkedService
uid: azure.synapse.artifacts.models.OdbcLinkedService
- - name: azure.synapse.artifacts.models.OdbcSink
- uid: azure.synapse.artifacts.models.OdbcSink
- - name: azure.synapse.artifacts.models.OdbcSource
- uid: azure.synapse.artifacts.models.OdbcSource
- name: azure.synapse.artifacts.models.OdbcTableDataset
uid: azure.synapse.artifacts.models.OdbcTableDataset
- name: azure.synapse.artifacts.models.Office365Dataset
uid: azure.synapse.artifacts.models.Office365Dataset
- name: azure.synapse.artifacts.models.Office365LinkedService
uid: azure.synapse.artifacts.models.Office365LinkedService
- - name: azure.synapse.artifacts.models.Office365Source
- uid: azure.synapse.artifacts.models.Office365Source
- - name: azure.synapse.artifacts.models.OperationResult
- uid: azure.synapse.artifacts.models.OperationResult
- name: azure.synapse.artifacts.models.OracleLinkedService
uid: azure.synapse.artifacts.models.OracleLinkedService
- - name: azure.synapse.artifacts.models.OraclePartitionOption
- uid: azure.synapse.artifacts.models.OraclePartitionOption
- - name: azure.synapse.artifacts.models.OraclePartitionSettings
- uid: azure.synapse.artifacts.models.OraclePartitionSettings
- name: azure.synapse.artifacts.models.OracleServiceCloudLinkedService
uid: azure.synapse.artifacts.models.OracleServiceCloudLinkedService
- name: azure.synapse.artifacts.models.OracleServiceCloudObjectDataset
uid: azure.synapse.artifacts.models.OracleServiceCloudObjectDataset
- - name: azure.synapse.artifacts.models.OracleServiceCloudSource
- uid: azure.synapse.artifacts.models.OracleServiceCloudSource
- - name: azure.synapse.artifacts.models.OracleSink
- uid: azure.synapse.artifacts.models.OracleSink
- - name: azure.synapse.artifacts.models.OracleSource
- uid: azure.synapse.artifacts.models.OracleSource
- name: azure.synapse.artifacts.models.OracleTableDataset
uid: azure.synapse.artifacts.models.OracleTableDataset
- name: azure.synapse.artifacts.models.OrcCompressionCodec
uid: azure.synapse.artifacts.models.OrcCompressionCodec
- name: azure.synapse.artifacts.models.OrcDataset
uid: azure.synapse.artifacts.models.OrcDataset
- - name: azure.synapse.artifacts.models.OrcFormat
- uid: azure.synapse.artifacts.models.OrcFormat
- - name: azure.synapse.artifacts.models.OrcSink
- uid: azure.synapse.artifacts.models.OrcSink
- - name: azure.synapse.artifacts.models.OrcSource
- uid: azure.synapse.artifacts.models.OrcSource
- - name: azure.synapse.artifacts.models.OrcWriteSettings
- uid: azure.synapse.artifacts.models.OrcWriteSettings
- - name: azure.synapse.artifacts.models.OutputColumn
- uid: azure.synapse.artifacts.models.OutputColumn
- name: azure.synapse.artifacts.models.ParameterSpecification
uid: azure.synapse.artifacts.models.ParameterSpecification
- name: azure.synapse.artifacts.models.ParameterType
uid: azure.synapse.artifacts.models.ParameterType
- - name: azure.synapse.artifacts.models.ParquetCompressionCodecEnum
- uid: azure.synapse.artifacts.models.ParquetCompressionCodecEnum
+ - name: azure.synapse.artifacts.models.ParquetCompressionCodec
+ uid: azure.synapse.artifacts.models.ParquetCompressionCodec
- name: azure.synapse.artifacts.models.ParquetDataset
uid: azure.synapse.artifacts.models.ParquetDataset
- - name: azure.synapse.artifacts.models.ParquetFormat
- uid: azure.synapse.artifacts.models.ParquetFormat
- - name: azure.synapse.artifacts.models.ParquetSink
- uid: azure.synapse.artifacts.models.ParquetSink
- - name: azure.synapse.artifacts.models.ParquetSource
- uid: azure.synapse.artifacts.models.ParquetSource
- - name: azure.synapse.artifacts.models.ParquetWriteSettings
- uid: azure.synapse.artifacts.models.ParquetWriteSettings
- name: azure.synapse.artifacts.models.PaypalLinkedService
uid: azure.synapse.artifacts.models.PaypalLinkedService
- name: azure.synapse.artifacts.models.PaypalObjectDataset
uid: azure.synapse.artifacts.models.PaypalObjectDataset
- - name: azure.synapse.artifacts.models.PaypalSource
- uid: azure.synapse.artifacts.models.PaypalSource
- name: azure.synapse.artifacts.models.PhoenixAuthenticationType
uid: azure.synapse.artifacts.models.PhoenixAuthenticationType
- name: azure.synapse.artifacts.models.PhoenixLinkedService
uid: azure.synapse.artifacts.models.PhoenixLinkedService
- name: azure.synapse.artifacts.models.PhoenixObjectDataset
uid: azure.synapse.artifacts.models.PhoenixObjectDataset
- - name: azure.synapse.artifacts.models.PhoenixSource
- uid: azure.synapse.artifacts.models.PhoenixSource
- name: azure.synapse.artifacts.models.PipelineFolder
uid: azure.synapse.artifacts.models.PipelineFolder
- name: azure.synapse.artifacts.models.PipelineListResponse
uid: azure.synapse.artifacts.models.PipelineListResponse
- name: azure.synapse.artifacts.models.PipelineReference
uid: azure.synapse.artifacts.models.PipelineReference
- - name: azure.synapse.artifacts.models.PipelineReferenceType
- uid: azure.synapse.artifacts.models.PipelineReferenceType
- name: azure.synapse.artifacts.models.PipelineResource
uid: azure.synapse.artifacts.models.PipelineResource
- name: azure.synapse.artifacts.models.PipelineRun
@@ -93074,64 +92260,26 @@
uid: azure.synapse.artifacts.models.PipelineRunsQueryResponse
- name: azure.synapse.artifacts.models.PluginCurrentState
uid: azure.synapse.artifacts.models.PluginCurrentState
- - name: azure.synapse.artifacts.models.PolybaseSettings
- uid: azure.synapse.artifacts.models.PolybaseSettings
- - name: azure.synapse.artifacts.models.PolybaseSettingsRejectType
- uid: azure.synapse.artifacts.models.PolybaseSettingsRejectType
- name: azure.synapse.artifacts.models.PostgreSqlLinkedService
uid: azure.synapse.artifacts.models.PostgreSqlLinkedService
- - name: azure.synapse.artifacts.models.PostgreSqlSource
- uid: azure.synapse.artifacts.models.PostgreSqlSource
- name: azure.synapse.artifacts.models.PostgreSqlTableDataset
uid: azure.synapse.artifacts.models.PostgreSqlTableDataset
- - name: azure.synapse.artifacts.models.PowerBIWorkspaceLinkedService
- uid: azure.synapse.artifacts.models.PowerBIWorkspaceLinkedService
- name: azure.synapse.artifacts.models.PrestoAuthenticationType
uid: azure.synapse.artifacts.models.PrestoAuthenticationType
- name: azure.synapse.artifacts.models.PrestoLinkedService
uid: azure.synapse.artifacts.models.PrestoLinkedService
- name: azure.synapse.artifacts.models.PrestoObjectDataset
uid: azure.synapse.artifacts.models.PrestoObjectDataset
- - name: azure.synapse.artifacts.models.PrestoSource
- uid: azure.synapse.artifacts.models.PrestoSource
- - name: azure.synapse.artifacts.models.PrivateEndpoint
- uid: azure.synapse.artifacts.models.PrivateEndpoint
- - name: azure.synapse.artifacts.models.PrivateEndpointConnection
- uid: azure.synapse.artifacts.models.PrivateEndpointConnection
- - name: azure.synapse.artifacts.models.PrivateLinkServiceConnectionState
- uid: azure.synapse.artifacts.models.PrivateLinkServiceConnectionState
- - name: azure.synapse.artifacts.models.ProxyResource
- uid: azure.synapse.artifacts.models.ProxyResource
- - name: azure.synapse.artifacts.models.PurviewConfiguration
- uid: azure.synapse.artifacts.models.PurviewConfiguration
- name: azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse
uid: azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse
- - name: azure.synapse.artifacts.models.QueryTableStatusRequest
- uid: azure.synapse.artifacts.models.QueryTableStatusRequest
- name: azure.synapse.artifacts.models.QuickBooksLinkedService
uid: azure.synapse.artifacts.models.QuickBooksLinkedService
- name: azure.synapse.artifacts.models.QuickBooksObjectDataset
uid: azure.synapse.artifacts.models.QuickBooksObjectDataset
- - name: azure.synapse.artifacts.models.QuickBooksSource
- uid: azure.synapse.artifacts.models.QuickBooksSource
- - name: azure.synapse.artifacts.models.QuickbaseLinkedService
- uid: azure.synapse.artifacts.models.QuickbaseLinkedService
- - name: azure.synapse.artifacts.models.RecurrenceFrequency
- uid: azure.synapse.artifacts.models.RecurrenceFrequency
- - name: azure.synapse.artifacts.models.RecurrenceSchedule
- uid: azure.synapse.artifacts.models.RecurrenceSchedule
- - name: azure.synapse.artifacts.models.RecurrenceScheduleOccurrence
- uid: azure.synapse.artifacts.models.RecurrenceScheduleOccurrence
- name: azure.synapse.artifacts.models.RedirectIncompatibleRowSettings
uid: azure.synapse.artifacts.models.RedirectIncompatibleRowSettings
- - name: azure.synapse.artifacts.models.RedshiftUnloadSettings
- uid: azure.synapse.artifacts.models.RedshiftUnloadSettings
- - name: azure.synapse.artifacts.models.RelationalSource
- uid: azure.synapse.artifacts.models.RelationalSource
- name: azure.synapse.artifacts.models.RelationalTableDataset
uid: azure.synapse.artifacts.models.RelationalTableDataset
- - name: azure.synapse.artifacts.models.RequestStatus
- uid: azure.synapse.artifacts.models.RequestStatus
- name: azure.synapse.artifacts.models.RerunTriggerListResponse
uid: azure.synapse.artifacts.models.RerunTriggerListResponse
- name: azure.synapse.artifacts.models.RerunTriggerResource
@@ -93142,48 +92290,18 @@
uid: azure.synapse.artifacts.models.RerunTumblingWindowTriggerActionParameters
- name: azure.synapse.artifacts.models.Resource
uid: azure.synapse.artifacts.models.Resource
- - name: azure.synapse.artifacts.models.ResourceIdentityType
- uid: azure.synapse.artifacts.models.ResourceIdentityType
- - name: azure.synapse.artifacts.models.ResourceStatus
- uid: azure.synapse.artifacts.models.ResourceStatus
- name: azure.synapse.artifacts.models.ResponsysLinkedService
uid: azure.synapse.artifacts.models.ResponsysLinkedService
- name: azure.synapse.artifacts.models.ResponsysObjectDataset
uid: azure.synapse.artifacts.models.ResponsysObjectDataset
- - name: azure.synapse.artifacts.models.ResponsysSource
- uid: azure.synapse.artifacts.models.ResponsysSource
- name: azure.synapse.artifacts.models.RestResourceDataset
uid: azure.synapse.artifacts.models.RestResourceDataset
- name: azure.synapse.artifacts.models.RestServiceAuthenticationType
uid: azure.synapse.artifacts.models.RestServiceAuthenticationType
- name: azure.synapse.artifacts.models.RestServiceLinkedService
uid: azure.synapse.artifacts.models.RestServiceLinkedService
- - name: azure.synapse.artifacts.models.RestSink
- uid: azure.synapse.artifacts.models.RestSink
- - name: azure.synapse.artifacts.models.RestSource
- uid: azure.synapse.artifacts.models.RestSource
- - name: azure.synapse.artifacts.models.RetryPolicy
- uid: azure.synapse.artifacts.models.RetryPolicy
- name: azure.synapse.artifacts.models.RunFilterParameters
uid: azure.synapse.artifacts.models.RunFilterParameters
- - name: azure.synapse.artifacts.models.RunNotebookError
- uid: azure.synapse.artifacts.models.RunNotebookError
- - name: azure.synapse.artifacts.models.RunNotebookParameter
- uid: azure.synapse.artifacts.models.RunNotebookParameter
- - name: azure.synapse.artifacts.models.RunNotebookRequest
- uid: azure.synapse.artifacts.models.RunNotebookRequest
- - name: azure.synapse.artifacts.models.RunNotebookResponse
- uid: azure.synapse.artifacts.models.RunNotebookResponse
- - name: azure.synapse.artifacts.models.RunNotebookResult
- uid: azure.synapse.artifacts.models.RunNotebookResult
- - name: azure.synapse.artifacts.models.RunNotebookSnapshot
- uid: azure.synapse.artifacts.models.RunNotebookSnapshot
- - name: azure.synapse.artifacts.models.RunNotebookSnapshotResponse
- uid: azure.synapse.artifacts.models.RunNotebookSnapshotResponse
- - name: azure.synapse.artifacts.models.RunNotebookSnapshotResult
- uid: azure.synapse.artifacts.models.RunNotebookSnapshotResult
- - name: azure.synapse.artifacts.models.RunNotebookSparkSessionOptions
- uid: azure.synapse.artifacts.models.RunNotebookSparkSessionOptions
- name: azure.synapse.artifacts.models.RunQueryFilter
uid: azure.synapse.artifacts.models.RunQueryFilter
- name: azure.synapse.artifacts.models.RunQueryFilterOperand
@@ -93216,166 +92334,62 @@
uid: azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService
- name: azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset
uid: azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset
- - name: azure.synapse.artifacts.models.SalesforceMarketingCloudSource
- uid: azure.synapse.artifacts.models.SalesforceMarketingCloudSource
- name: azure.synapse.artifacts.models.SalesforceObjectDataset
uid: azure.synapse.artifacts.models.SalesforceObjectDataset
- name: azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService
uid: azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService
- name: azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset
uid: azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset
- - name: azure.synapse.artifacts.models.SalesforceServiceCloudSink
- uid: azure.synapse.artifacts.models.SalesforceServiceCloudSink
- - name: azure.synapse.artifacts.models.SalesforceServiceCloudSource
- uid: azure.synapse.artifacts.models.SalesforceServiceCloudSource
- - name: azure.synapse.artifacts.models.SalesforceSink
- uid: azure.synapse.artifacts.models.SalesforceSink
- - name: azure.synapse.artifacts.models.SalesforceSinkWriteBehavior
- uid: azure.synapse.artifacts.models.SalesforceSinkWriteBehavior
- - name: azure.synapse.artifacts.models.SalesforceSource
- uid: azure.synapse.artifacts.models.SalesforceSource
- - name: azure.synapse.artifacts.models.SalesforceSourceReadBehavior
- uid: azure.synapse.artifacts.models.SalesforceSourceReadBehavior
- name: azure.synapse.artifacts.models.SapBWLinkedService
uid: azure.synapse.artifacts.models.SapBWLinkedService
- name: azure.synapse.artifacts.models.SapBwCubeDataset
uid: azure.synapse.artifacts.models.SapBwCubeDataset
- - name: azure.synapse.artifacts.models.SapBwSource
- uid: azure.synapse.artifacts.models.SapBwSource
- name: azure.synapse.artifacts.models.SapCloudForCustomerLinkedService
uid: azure.synapse.artifacts.models.SapCloudForCustomerLinkedService
- name: azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset
uid: azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset
- - name: azure.synapse.artifacts.models.SapCloudForCustomerSink
- uid: azure.synapse.artifacts.models.SapCloudForCustomerSink
- - name: azure.synapse.artifacts.models.SapCloudForCustomerSinkWriteBehavior
- uid: azure.synapse.artifacts.models.SapCloudForCustomerSinkWriteBehavior
- - name: azure.synapse.artifacts.models.SapCloudForCustomerSource
- uid: azure.synapse.artifacts.models.SapCloudForCustomerSource
- name: azure.synapse.artifacts.models.SapEccLinkedService
uid: azure.synapse.artifacts.models.SapEccLinkedService
- name: azure.synapse.artifacts.models.SapEccResourceDataset
uid: azure.synapse.artifacts.models.SapEccResourceDataset
- - name: azure.synapse.artifacts.models.SapEccSource
- uid: azure.synapse.artifacts.models.SapEccSource
- name: azure.synapse.artifacts.models.SapHanaAuthenticationType
uid: azure.synapse.artifacts.models.SapHanaAuthenticationType
- name: azure.synapse.artifacts.models.SapHanaLinkedService
uid: azure.synapse.artifacts.models.SapHanaLinkedService
- - name: azure.synapse.artifacts.models.SapHanaPartitionOption
- uid: azure.synapse.artifacts.models.SapHanaPartitionOption
- - name: azure.synapse.artifacts.models.SapHanaPartitionSettings
- uid: azure.synapse.artifacts.models.SapHanaPartitionSettings
- - name: azure.synapse.artifacts.models.SapHanaSource
- uid: azure.synapse.artifacts.models.SapHanaSource
- name: azure.synapse.artifacts.models.SapHanaTableDataset
uid: azure.synapse.artifacts.models.SapHanaTableDataset
- - name: azure.synapse.artifacts.models.SapOdpLinkedService
- uid: azure.synapse.artifacts.models.SapOdpLinkedService
- - name: azure.synapse.artifacts.models.SapOdpResourceDataset
- uid: azure.synapse.artifacts.models.SapOdpResourceDataset
- - name: azure.synapse.artifacts.models.SapOdpSource
- uid: azure.synapse.artifacts.models.SapOdpSource
- name: azure.synapse.artifacts.models.SapOpenHubLinkedService
uid: azure.synapse.artifacts.models.SapOpenHubLinkedService
- - name: azure.synapse.artifacts.models.SapOpenHubSource
- uid: azure.synapse.artifacts.models.SapOpenHubSource
- name: azure.synapse.artifacts.models.SapOpenHubTableDataset
uid: azure.synapse.artifacts.models.SapOpenHubTableDataset
- name: azure.synapse.artifacts.models.SapTableLinkedService
uid: azure.synapse.artifacts.models.SapTableLinkedService
- - name: azure.synapse.artifacts.models.SapTablePartitionOption
- uid: azure.synapse.artifacts.models.SapTablePartitionOption
- - name: azure.synapse.artifacts.models.SapTablePartitionSettings
- uid: azure.synapse.artifacts.models.SapTablePartitionSettings
- name: azure.synapse.artifacts.models.SapTableResourceDataset
uid: azure.synapse.artifacts.models.SapTableResourceDataset
- - name: azure.synapse.artifacts.models.SapTableSource
- uid: azure.synapse.artifacts.models.SapTableSource
- - name: azure.synapse.artifacts.models.ScheduleTrigger
- uid: azure.synapse.artifacts.models.ScheduleTrigger
- - name: azure.synapse.artifacts.models.ScheduleTriggerRecurrence
- uid: azure.synapse.artifacts.models.ScheduleTriggerRecurrence
- name: azure.synapse.artifacts.models.SchedulerCurrentState
uid: azure.synapse.artifacts.models.SchedulerCurrentState
- name: azure.synapse.artifacts.models.ScriptAction
uid: azure.synapse.artifacts.models.ScriptAction
- - name: azure.synapse.artifacts.models.ScriptActivity
- uid: azure.synapse.artifacts.models.ScriptActivity
- - name: azure.synapse.artifacts.models.ScriptActivityLogDestination
- uid: azure.synapse.artifacts.models.ScriptActivityLogDestination
- - name: azure.synapse.artifacts.models.ScriptActivityParameter
- uid: azure.synapse.artifacts.models.ScriptActivityParameter
- - name: azure.synapse.artifacts.models.ScriptActivityParameterDirection
- uid: azure.synapse.artifacts.models.ScriptActivityParameterDirection
- - name: azure.synapse.artifacts.models.ScriptActivityParameterType
- uid: azure.synapse.artifacts.models.ScriptActivityParameterType
- - name: azure.synapse.artifacts.models.ScriptActivityScriptBlock
- uid: azure.synapse.artifacts.models.ScriptActivityScriptBlock
- - name: azure.synapse.artifacts.models.ScriptActivityTypePropertiesLogSettings
- uid: azure.synapse.artifacts.models.ScriptActivityTypePropertiesLogSettings
- - name: azure.synapse.artifacts.models.ScriptType
- uid: azure.synapse.artifacts.models.ScriptType
- name: azure.synapse.artifacts.models.SecretBase
uid: azure.synapse.artifacts.models.SecretBase
- - name: azure.synapse.artifacts.models.SecureInputOutputPolicy
- uid: azure.synapse.artifacts.models.SecureInputOutputPolicy
- name: azure.synapse.artifacts.models.SecureString
uid: azure.synapse.artifacts.models.SecureString
- - name: azure.synapse.artifacts.models.SelfDependencyTumblingWindowTriggerReference
- uid: azure.synapse.artifacts.models.SelfDependencyTumblingWindowTriggerReference
- - name: azure.synapse.artifacts.models.SelfHostedIntegrationRuntime
- uid: azure.synapse.artifacts.models.SelfHostedIntegrationRuntime
- name: azure.synapse.artifacts.models.ServiceNowAuthenticationType
uid: azure.synapse.artifacts.models.ServiceNowAuthenticationType
- name: azure.synapse.artifacts.models.ServiceNowLinkedService
uid: azure.synapse.artifacts.models.ServiceNowLinkedService
- name: azure.synapse.artifacts.models.ServiceNowObjectDataset
uid: azure.synapse.artifacts.models.ServiceNowObjectDataset
- - name: azure.synapse.artifacts.models.ServiceNowSource
- uid: azure.synapse.artifacts.models.ServiceNowSource
- name: azure.synapse.artifacts.models.SetVariableActivity
uid: azure.synapse.artifacts.models.SetVariableActivity
- name: azure.synapse.artifacts.models.SftpAuthenticationType
uid: azure.synapse.artifacts.models.SftpAuthenticationType
- - name: azure.synapse.artifacts.models.SftpLocation
- uid: azure.synapse.artifacts.models.SftpLocation
- - name: azure.synapse.artifacts.models.SftpReadSettings
- uid: azure.synapse.artifacts.models.SftpReadSettings
- name: azure.synapse.artifacts.models.SftpServerLinkedService
uid: azure.synapse.artifacts.models.SftpServerLinkedService
- - name: azure.synapse.artifacts.models.SftpWriteSettings
- uid: azure.synapse.artifacts.models.SftpWriteSettings
- - name: azure.synapse.artifacts.models.SharePointOnlineListLinkedService
- uid: azure.synapse.artifacts.models.SharePointOnlineListLinkedService
- - name: azure.synapse.artifacts.models.SharePointOnlineListResourceDataset
- uid: azure.synapse.artifacts.models.SharePointOnlineListResourceDataset
- - name: azure.synapse.artifacts.models.SharePointOnlineListSource
- uid: azure.synapse.artifacts.models.SharePointOnlineListSource
- name: azure.synapse.artifacts.models.ShopifyLinkedService
uid: azure.synapse.artifacts.models.ShopifyLinkedService
- name: azure.synapse.artifacts.models.ShopifyObjectDataset
uid: azure.synapse.artifacts.models.ShopifyObjectDataset
- - name: azure.synapse.artifacts.models.ShopifySource
- uid: azure.synapse.artifacts.models.ShopifySource
- - name: azure.synapse.artifacts.models.SkipErrorFile
- uid: azure.synapse.artifacts.models.SkipErrorFile
- - name: azure.synapse.artifacts.models.Sku
- uid: azure.synapse.artifacts.models.Sku
- - name: azure.synapse.artifacts.models.SmartsheetLinkedService
- uid: azure.synapse.artifacts.models.SmartsheetLinkedService
- - name: azure.synapse.artifacts.models.SnowflakeDataset
- uid: azure.synapse.artifacts.models.SnowflakeDataset
- - name: azure.synapse.artifacts.models.SnowflakeExportCopyCommand
- uid: azure.synapse.artifacts.models.SnowflakeExportCopyCommand
- - name: azure.synapse.artifacts.models.SnowflakeImportCopyCommand
- uid: azure.synapse.artifacts.models.SnowflakeImportCopyCommand
- - name: azure.synapse.artifacts.models.SnowflakeLinkedService
- uid: azure.synapse.artifacts.models.SnowflakeLinkedService
- - name: azure.synapse.artifacts.models.SnowflakeSink
- uid: azure.synapse.artifacts.models.SnowflakeSink
- - name: azure.synapse.artifacts.models.SnowflakeSource
- uid: azure.synapse.artifacts.models.SnowflakeSource
- name: azure.synapse.artifacts.models.SparkAuthenticationType
uid: azure.synapse.artifacts.models.SparkAuthenticationType
- name: azure.synapse.artifacts.models.SparkBatchJob
@@ -93384,32 +92398,16 @@
uid: azure.synapse.artifacts.models.SparkBatchJobResultType
- name: azure.synapse.artifacts.models.SparkBatchJobState
uid: azure.synapse.artifacts.models.SparkBatchJobState
- - name: azure.synapse.artifacts.models.SparkConfiguration
- uid: azure.synapse.artifacts.models.SparkConfiguration
- - name: azure.synapse.artifacts.models.SparkConfigurationListResponse
- uid: azure.synapse.artifacts.models.SparkConfigurationListResponse
- - name: azure.synapse.artifacts.models.SparkConfigurationParametrizationReference
- uid: azure.synapse.artifacts.models.SparkConfigurationParametrizationReference
- - name: azure.synapse.artifacts.models.SparkConfigurationReference
- uid: azure.synapse.artifacts.models.SparkConfigurationReference
- - name: azure.synapse.artifacts.models.SparkConfigurationReferenceType
- uid: azure.synapse.artifacts.models.SparkConfigurationReferenceType
- - name: azure.synapse.artifacts.models.SparkConfigurationResource
- uid: azure.synapse.artifacts.models.SparkConfigurationResource
- name: azure.synapse.artifacts.models.SparkErrorSource
uid: azure.synapse.artifacts.models.SparkErrorSource
- name: azure.synapse.artifacts.models.SparkJobDefinition
uid: azure.synapse.artifacts.models.SparkJobDefinition
- - name: azure.synapse.artifacts.models.SparkJobDefinitionFolder
- uid: azure.synapse.artifacts.models.SparkJobDefinitionFolder
- name: azure.synapse.artifacts.models.SparkJobDefinitionResource
uid: azure.synapse.artifacts.models.SparkJobDefinitionResource
- name: azure.synapse.artifacts.models.SparkJobDefinitionsListResponse
uid: azure.synapse.artifacts.models.SparkJobDefinitionsListResponse
- name: azure.synapse.artifacts.models.SparkJobProperties
uid: azure.synapse.artifacts.models.SparkJobProperties
- - name: azure.synapse.artifacts.models.SparkJobReferenceType
- uid: azure.synapse.artifacts.models.SparkJobReferenceType
- name: azure.synapse.artifacts.models.SparkJobType
uid: azure.synapse.artifacts.models.SparkJobType
- name: azure.synapse.artifacts.models.SparkLinkedService
@@ -93426,76 +92424,32 @@
uid: azure.synapse.artifacts.models.SparkServiceError
- name: azure.synapse.artifacts.models.SparkServicePlugin
uid: azure.synapse.artifacts.models.SparkServicePlugin
- - name: azure.synapse.artifacts.models.SparkSource
- uid: azure.synapse.artifacts.models.SparkSource
- name: azure.synapse.artifacts.models.SparkThriftTransportProtocol
uid: azure.synapse.artifacts.models.SparkThriftTransportProtocol
- - name: azure.synapse.artifacts.models.SqlAlwaysEncryptedAkvAuthType
- uid: azure.synapse.artifacts.models.SqlAlwaysEncryptedAkvAuthType
- - name: azure.synapse.artifacts.models.SqlAlwaysEncryptedProperties
- uid: azure.synapse.artifacts.models.SqlAlwaysEncryptedProperties
- name: azure.synapse.artifacts.models.SqlConnection
uid: azure.synapse.artifacts.models.SqlConnection
- name: azure.synapse.artifacts.models.SqlConnectionType
uid: azure.synapse.artifacts.models.SqlConnectionType
- - name: azure.synapse.artifacts.models.SqlDWSink
- uid: azure.synapse.artifacts.models.SqlDWSink
- - name: azure.synapse.artifacts.models.SqlDWSource
- uid: azure.synapse.artifacts.models.SqlDWSource
- - name: azure.synapse.artifacts.models.SqlMISink
- uid: azure.synapse.artifacts.models.SqlMISink
- - name: azure.synapse.artifacts.models.SqlMISource
- uid: azure.synapse.artifacts.models.SqlMISource
- - name: azure.synapse.artifacts.models.SqlPartitionOption
- uid: azure.synapse.artifacts.models.SqlPartitionOption
- - name: azure.synapse.artifacts.models.SqlPartitionSettings
- uid: azure.synapse.artifacts.models.SqlPartitionSettings
- - name: azure.synapse.artifacts.models.SqlPool
- uid: azure.synapse.artifacts.models.SqlPool
- - name: azure.synapse.artifacts.models.SqlPoolInfoListResult
- uid: azure.synapse.artifacts.models.SqlPoolInfoListResult
- - name: azure.synapse.artifacts.models.SqlPoolReference
- uid: azure.synapse.artifacts.models.SqlPoolReference
- - name: azure.synapse.artifacts.models.SqlPoolReferenceType
- uid: azure.synapse.artifacts.models.SqlPoolReferenceType
- - name: azure.synapse.artifacts.models.SqlPoolStoredProcedureActivity
- uid: azure.synapse.artifacts.models.SqlPoolStoredProcedureActivity
- name: azure.synapse.artifacts.models.SqlScript
uid: azure.synapse.artifacts.models.SqlScript
- name: azure.synapse.artifacts.models.SqlScriptContent
uid: azure.synapse.artifacts.models.SqlScriptContent
- - name: azure.synapse.artifacts.models.SqlScriptFolder
- uid: azure.synapse.artifacts.models.SqlScriptFolder
- name: azure.synapse.artifacts.models.SqlScriptMetadata
uid: azure.synapse.artifacts.models.SqlScriptMetadata
- name: azure.synapse.artifacts.models.SqlScriptResource
uid: azure.synapse.artifacts.models.SqlScriptResource
- - name: azure.synapse.artifacts.models.SqlScriptType
- uid: azure.synapse.artifacts.models.SqlScriptType
- name: azure.synapse.artifacts.models.SqlScriptsListResponse
uid: azure.synapse.artifacts.models.SqlScriptsListResponse
- name: azure.synapse.artifacts.models.SqlServerLinkedService
uid: azure.synapse.artifacts.models.SqlServerLinkedService
- - name: azure.synapse.artifacts.models.SqlServerSink
- uid: azure.synapse.artifacts.models.SqlServerSink
- - name: azure.synapse.artifacts.models.SqlServerSource
- uid: azure.synapse.artifacts.models.SqlServerSource
- name: azure.synapse.artifacts.models.SqlServerStoredProcedureActivity
uid: azure.synapse.artifacts.models.SqlServerStoredProcedureActivity
- name: azure.synapse.artifacts.models.SqlServerTableDataset
uid: azure.synapse.artifacts.models.SqlServerTableDataset
- - name: azure.synapse.artifacts.models.SqlSink
- uid: azure.synapse.artifacts.models.SqlSink
- - name: azure.synapse.artifacts.models.SqlSource
- uid: azure.synapse.artifacts.models.SqlSource
- name: azure.synapse.artifacts.models.SquareLinkedService
uid: azure.synapse.artifacts.models.SquareLinkedService
- name: azure.synapse.artifacts.models.SquareObjectDataset
uid: azure.synapse.artifacts.models.SquareObjectDataset
- - name: azure.synapse.artifacts.models.SquareSource
- uid: azure.synapse.artifacts.models.SquareSource
- - name: azure.synapse.artifacts.models.SsisLogLocationType
- uid: azure.synapse.artifacts.models.SsisLogLocationType
- name: azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse
uid: azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse
- name: azure.synapse.artifacts.models.SsisPackageLocationType
@@ -93506,10 +92460,6 @@
uid: azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest
- name: azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse
uid: azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse
- - name: azure.synapse.artifacts.models.StoreReadSettings
- uid: azure.synapse.artifacts.models.StoreReadSettings
- - name: azure.synapse.artifacts.models.StoreWriteSettings
- uid: azure.synapse.artifacts.models.StoreWriteSettings
- name: azure.synapse.artifacts.models.StoredProcedureParameter
uid: azure.synapse.artifacts.models.StoredProcedureParameter
- name: azure.synapse.artifacts.models.StoredProcedureParameterType
@@ -93526,62 +92476,24 @@
uid: azure.synapse.artifacts.models.SybaseAuthenticationType
- name: azure.synapse.artifacts.models.SybaseLinkedService
uid: azure.synapse.artifacts.models.SybaseLinkedService
- - name: azure.synapse.artifacts.models.SybaseSource
- uid: azure.synapse.artifacts.models.SybaseSource
- name: azure.synapse.artifacts.models.SybaseTableDataset
uid: azure.synapse.artifacts.models.SybaseTableDataset
- - name: azure.synapse.artifacts.models.SynapseNotebookActivity
- uid: azure.synapse.artifacts.models.SynapseNotebookActivity
- - name: azure.synapse.artifacts.models.SynapseNotebookReference
- uid: azure.synapse.artifacts.models.SynapseNotebookReference
- - name: azure.synapse.artifacts.models.SynapseSparkJobDefinitionActivity
- uid: azure.synapse.artifacts.models.SynapseSparkJobDefinitionActivity
- - name: azure.synapse.artifacts.models.SynapseSparkJobReference
- uid: azure.synapse.artifacts.models.SynapseSparkJobReference
- - name: azure.synapse.artifacts.models.TabularSource
- uid: azure.synapse.artifacts.models.TabularSource
- - name: azure.synapse.artifacts.models.TabularTranslator
- uid: azure.synapse.artifacts.models.TabularTranslator
- - name: azure.synapse.artifacts.models.TarGZipReadSettings
- uid: azure.synapse.artifacts.models.TarGZipReadSettings
- - name: azure.synapse.artifacts.models.TarReadSettings
- uid: azure.synapse.artifacts.models.TarReadSettings
- - name: azure.synapse.artifacts.models.TeamDeskAuthenticationType
- uid: azure.synapse.artifacts.models.TeamDeskAuthenticationType
- - name: azure.synapse.artifacts.models.TeamDeskLinkedService
- uid: azure.synapse.artifacts.models.TeamDeskLinkedService
- name: azure.synapse.artifacts.models.TeradataAuthenticationType
uid: azure.synapse.artifacts.models.TeradataAuthenticationType
- name: azure.synapse.artifacts.models.TeradataLinkedService
uid: azure.synapse.artifacts.models.TeradataLinkedService
- - name: azure.synapse.artifacts.models.TeradataPartitionOption
- uid: azure.synapse.artifacts.models.TeradataPartitionOption
- - name: azure.synapse.artifacts.models.TeradataPartitionSettings
- uid: azure.synapse.artifacts.models.TeradataPartitionSettings
- - name: azure.synapse.artifacts.models.TeradataSource
- uid: azure.synapse.artifacts.models.TeradataSource
- name: azure.synapse.artifacts.models.TeradataTableDataset
uid: azure.synapse.artifacts.models.TeradataTableDataset
- - name: azure.synapse.artifacts.models.TextFormat
- uid: azure.synapse.artifacts.models.TextFormat
- - name: azure.synapse.artifacts.models.TrackedResource
- uid: azure.synapse.artifacts.models.TrackedResource
- name: azure.synapse.artifacts.models.Transformation
uid: azure.synapse.artifacts.models.Transformation
- name: azure.synapse.artifacts.models.Trigger
uid: azure.synapse.artifacts.models.Trigger
- name: azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus
uid: azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus
- - name: azure.synapse.artifacts.models.TriggerDependencyReference
- uid: azure.synapse.artifacts.models.TriggerDependencyReference
- name: azure.synapse.artifacts.models.TriggerListResponse
uid: azure.synapse.artifacts.models.TriggerListResponse
- name: azure.synapse.artifacts.models.TriggerPipelineReference
uid: azure.synapse.artifacts.models.TriggerPipelineReference
- - name: azure.synapse.artifacts.models.TriggerReference
- uid: azure.synapse.artifacts.models.TriggerReference
- - name: azure.synapse.artifacts.models.TriggerReferenceType
- uid: azure.synapse.artifacts.models.TriggerReferenceType
- name: azure.synapse.artifacts.models.TriggerResource
uid: azure.synapse.artifacts.models.TriggerResource
- name: azure.synapse.artifacts.models.TriggerRun
@@ -93594,22 +92506,8 @@
uid: azure.synapse.artifacts.models.TriggerRuntimeState
- name: azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus
uid: azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus
- - name: azure.synapse.artifacts.models.TumblingWindowFrequency
- uid: azure.synapse.artifacts.models.TumblingWindowFrequency
- - name: azure.synapse.artifacts.models.TumblingWindowTrigger
- uid: azure.synapse.artifacts.models.TumblingWindowTrigger
- - name: azure.synapse.artifacts.models.TumblingWindowTriggerDependencyReference
- uid: azure.synapse.artifacts.models.TumblingWindowTriggerDependencyReference
- - name: azure.synapse.artifacts.models.TwilioLinkedService
- uid: azure.synapse.artifacts.models.TwilioLinkedService
- - name: azure.synapse.artifacts.models.Type
- uid: azure.synapse.artifacts.models.Type
- - name: azure.synapse.artifacts.models.TypeConversionSettings
- uid: azure.synapse.artifacts.models.TypeConversionSettings
- name: azure.synapse.artifacts.models.UntilActivity
uid: azure.synapse.artifacts.models.UntilActivity
- - name: azure.synapse.artifacts.models.UpdateLandingZoneCredential
- uid: azure.synapse.artifacts.models.UpdateLandingZoneCredential
- name: azure.synapse.artifacts.models.UserProperty
uid: azure.synapse.artifacts.models.UserProperty
- name: azure.synapse.artifacts.models.ValidationActivity
@@ -93620,12 +92518,8 @@
uid: azure.synapse.artifacts.models.VariableType
- name: azure.synapse.artifacts.models.VerticaLinkedService
uid: azure.synapse.artifacts.models.VerticaLinkedService
- - name: azure.synapse.artifacts.models.VerticaSource
- uid: azure.synapse.artifacts.models.VerticaSource
- name: azure.synapse.artifacts.models.VerticaTableDataset
uid: azure.synapse.artifacts.models.VerticaTableDataset
- - name: azure.synapse.artifacts.models.VirtualNetworkProfile
- uid: azure.synapse.artifacts.models.VirtualNetworkProfile
- name: azure.synapse.artifacts.models.WaitActivity
uid: azure.synapse.artifacts.models.WaitActivity
- name: azure.synapse.artifacts.models.WebActivity
@@ -93644,102 +92538,52 @@
uid: azure.synapse.artifacts.models.WebClientCertificateAuthentication
- name: azure.synapse.artifacts.models.WebHookActivity
uid: azure.synapse.artifacts.models.WebHookActivity
- - name: azure.synapse.artifacts.models.WebHookActivityMethod
- uid: azure.synapse.artifacts.models.WebHookActivityMethod
- name: azure.synapse.artifacts.models.WebLinkedService
uid: azure.synapse.artifacts.models.WebLinkedService
- name: azure.synapse.artifacts.models.WebLinkedServiceTypeProperties
uid: azure.synapse.artifacts.models.WebLinkedServiceTypeProperties
- - name: azure.synapse.artifacts.models.WebSource
- uid: azure.synapse.artifacts.models.WebSource
- name: azure.synapse.artifacts.models.WebTableDataset
uid: azure.synapse.artifacts.models.WebTableDataset
- name: azure.synapse.artifacts.models.Workspace
uid: azure.synapse.artifacts.models.Workspace
- name: azure.synapse.artifacts.models.WorkspaceIdentity
uid: azure.synapse.artifacts.models.WorkspaceIdentity
- - name: azure.synapse.artifacts.models.WorkspaceKeyDetails
- uid: azure.synapse.artifacts.models.WorkspaceKeyDetails
- - name: azure.synapse.artifacts.models.WorkspaceRepositoryConfiguration
- uid: azure.synapse.artifacts.models.WorkspaceRepositoryConfiguration
- name: azure.synapse.artifacts.models.WorkspaceUpdateParameters
uid: azure.synapse.artifacts.models.WorkspaceUpdateParameters
- name: azure.synapse.artifacts.models.XeroLinkedService
uid: azure.synapse.artifacts.models.XeroLinkedService
- name: azure.synapse.artifacts.models.XeroObjectDataset
uid: azure.synapse.artifacts.models.XeroObjectDataset
- - name: azure.synapse.artifacts.models.XeroSource
- uid: azure.synapse.artifacts.models.XeroSource
- - name: azure.synapse.artifacts.models.XmlDataset
- uid: azure.synapse.artifacts.models.XmlDataset
- - name: azure.synapse.artifacts.models.XmlReadSettings
- uid: azure.synapse.artifacts.models.XmlReadSettings
- - name: azure.synapse.artifacts.models.XmlSource
- uid: azure.synapse.artifacts.models.XmlSource
- - name: azure.synapse.artifacts.models.ZendeskAuthenticationType
- uid: azure.synapse.artifacts.models.ZendeskAuthenticationType
- - name: azure.synapse.artifacts.models.ZendeskLinkedService
- uid: azure.synapse.artifacts.models.ZendeskLinkedService
- - name: azure.synapse.artifacts.models.ZipDeflateReadSettings
- uid: azure.synapse.artifacts.models.ZipDeflateReadSettings
- name: azure.synapse.artifacts.models.ZohoLinkedService
uid: azure.synapse.artifacts.models.ZohoLinkedService
- name: azure.synapse.artifacts.models.ZohoObjectDataset
uid: azure.synapse.artifacts.models.ZohoObjectDataset
- - name: azure.synapse.artifacts.models.ZohoSource
- uid: azure.synapse.artifacts.models.ZohoSource
name: azure.synapse.artifacts.models
- items:
- name: Overview
uid: azure.synapse.artifacts.operations
- - name: azure.synapse.artifacts.operations.BigDataPoolsOperations
- uid: azure.synapse.artifacts.operations.BigDataPoolsOperations
- name: azure.synapse.artifacts.operations.DataFlowDebugSessionOperations
uid: azure.synapse.artifacts.operations.DataFlowDebugSessionOperations
- name: azure.synapse.artifacts.operations.DataFlowOperations
uid: azure.synapse.artifacts.operations.DataFlowOperations
- name: azure.synapse.artifacts.operations.DatasetOperations
uid: azure.synapse.artifacts.operations.DatasetOperations
- - name: azure.synapse.artifacts.operations.IntegrationRuntimesOperations
- uid: azure.synapse.artifacts.operations.IntegrationRuntimesOperations
- - name: azure.synapse.artifacts.operations.KqlScriptOperations
- uid: azure.synapse.artifacts.operations.KqlScriptOperations
- - name: azure.synapse.artifacts.operations.KqlScriptsOperations
- uid: azure.synapse.artifacts.operations.KqlScriptsOperations
- - name: azure.synapse.artifacts.operations.LibraryOperations
- uid: azure.synapse.artifacts.operations.LibraryOperations
- - name: azure.synapse.artifacts.operations.LinkConnectionOperations
- uid: azure.synapse.artifacts.operations.LinkConnectionOperations
- name: azure.synapse.artifacts.operations.LinkedServiceOperations
uid: azure.synapse.artifacts.operations.LinkedServiceOperations
- - name: azure.synapse.artifacts.operations.MetastoreOperations
- uid: azure.synapse.artifacts.operations.MetastoreOperations
- - name: azure.synapse.artifacts.operations.NotebookOperationResultOperations
- uid: azure.synapse.artifacts.operations.NotebookOperationResultOperations
- name: azure.synapse.artifacts.operations.NotebookOperations
uid: azure.synapse.artifacts.operations.NotebookOperations
- name: azure.synapse.artifacts.operations.PipelineOperations
uid: azure.synapse.artifacts.operations.PipelineOperations
- name: azure.synapse.artifacts.operations.PipelineRunOperations
uid: azure.synapse.artifacts.operations.PipelineRunOperations
- - name: azure.synapse.artifacts.operations.RunNotebookOperations
- uid: azure.synapse.artifacts.operations.RunNotebookOperations
- - name: azure.synapse.artifacts.operations.SparkConfigurationOperations
- uid: azure.synapse.artifacts.operations.SparkConfigurationOperations
- name: azure.synapse.artifacts.operations.SparkJobDefinitionOperations
uid: azure.synapse.artifacts.operations.SparkJobDefinitionOperations
- - name: azure.synapse.artifacts.operations.SqlPoolsOperations
- uid: azure.synapse.artifacts.operations.SqlPoolsOperations
- name: azure.synapse.artifacts.operations.SqlScriptOperations
uid: azure.synapse.artifacts.operations.SqlScriptOperations
- name: azure.synapse.artifacts.operations.TriggerOperations
uid: azure.synapse.artifacts.operations.TriggerOperations
- name: azure.synapse.artifacts.operations.TriggerRunOperations
uid: azure.synapse.artifacts.operations.TriggerRunOperations
- - name: azure.synapse.artifacts.operations.WorkspaceGitRepoManagementOperations
- uid: azure.synapse.artifacts.operations.WorkspaceGitRepoManagementOperations
- - name: azure.synapse.artifacts.operations.WorkspaceOperations
- uid: azure.synapse.artifacts.operations.WorkspaceOperations
name: azure.synapse.artifacts.operations
- name: azure.synapse.artifacts.ArtifactsClient
uid: azure.synapse.artifacts.ArtifactsClient
@@ -93868,10 +92712,6 @@
- items:
- name: Overview
uid: azure.synapse.spark.models
- - name: azure.synapse.spark.models.LivyStatementStates
- uid: azure.synapse.spark.models.LivyStatementStates
- - name: azure.synapse.spark.models.LivyStates
- uid: azure.synapse.spark.models.LivyStates
- name: azure.synapse.spark.models.PluginCurrentState
uid: azure.synapse.spark.models.PluginCurrentState
- name: azure.synapse.spark.models.SchedulerCurrentState
@@ -93936,7 +92776,6 @@
uid: azure.synapse.SynapseClient
name: azure.synapse
name: azure-synapse
-
- items:
- name: Overview
uid: project-azure-synapse-accesscontrol
@@ -93999,7 +92838,6 @@
uid: azure.synapse.accesscontrol.AccessControlClient
name: azure.synapse.accesscontrol
name: azure-synapse-accesscontrol
-
- items:
- name: Overview
uid: project-azure-synapse-artifacts
@@ -95792,7 +94630,6 @@
uid: azure.synapse.artifacts.ArtifactsClient
name: azure.synapse.artifacts
name: azure-synapse-artifacts
-
- items:
- name: Overview
uid: project-azure-synapse-managedprivateendpoints
@@ -95883,7 +94720,6 @@
uid: azure.synapse.managedprivateendpoints.VnetClient
name: azure.synapse.managedprivateendpoints
name: azure-synapse-managedprivateendpoints
-
- items:
- name: Overview
uid: project-azure-synapse-monitoring
@@ -95922,7 +94758,6 @@
uid: azure.synapse.monitoring.MonitoringClient
name: azure.synapse.monitoring
name: azure-synapse-monitoring
-
- items:
- name: Overview
uid: project-azure-synapse-spark
@@ -96011,7 +94846,6 @@
uid: azure.synapse.spark.SparkClient
name: azure.synapse.spark
name: azure-synapse-spark
-
- items:
- name: Overview
uid: project-azure-template
@@ -96020,7 +94854,6 @@
- name: azure.template
uid: azure.template
name: azure-template
-
- items:
- name: Overview
uid: project-msrest
@@ -96283,7 +95116,6 @@
uid: msrest.ServiceClient
name: msrest
name: msrest
-
- items:
- name: Overview
uid: project-msrestazure
@@ -96390,4 +95222,3 @@
uid: msrestazure.AzureConfiguration
name: msrestazure
name: msrestazure
-
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
deleted file mode 100644
index 1bc971016b05..000000000000
--- a/previous/docs-ref-autogen/azure-common/azure.common.client_factory.yml
+++ /dev/null
@@ -1,122 +0,0 @@
-### 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<!-- literal_block {\"ids\": [], \"classes\": [],\
- \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"force\": false, \"highlight_args\"\
- : {}, \"xml:space\": \"preserve\", \"language\": \"python\", \"linenos\": false}\
- \ -->\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<!-- literal_block {\"ids\": [], \"classes\":\
- \ [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"force\": false, \"\
- highlight_args\": {}, \"xml:space\": \"preserve\", \"language\": \"json\", \"\
- linenos\": false} -->\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\nNew in version 1.1.7.\n\
- \nDeprecated 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:
- - <xref:str>
- 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<!-- literal_block\
- \ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\"\
- : [], \"force\": false, \"highlight_args\": {}, \"xml:space\": \"preserve\", \"\
- language\": \"python\", \"linenos\": false} -->\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<!-- literal_block {\"ids\": [], \"classes\"\
- : [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"force\": false, \"\
- highlight_args\": {}, \"xml:space\": \"preserve\", \"language\": \"python\", \"\
- linenos\": false} -->\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\nDeprecated 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\
- <!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
- : [], \"backrefs\": [], \"force\": false, \"highlight_args\": {}, \"xml:space\"\
- : \"preserve\", \"language\": \"python\", \"linenos\": false} -->\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\nNew in version 1.1.7.\n\nDeprecated 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:
- - <xref:dict>
- 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.credentials.yml b/previous/docs-ref-autogen/azure-common/azure.common.credentials.yml
deleted file mode 100644
index 83605c4f9b63..000000000000
--- a/previous/docs-ref-autogen/azure-common/azure.common.credentials.yml
+++ /dev/null
@@ -1,60 +0,0 @@
-### 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<!-- literal_block {\"ids\"\
- : [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"force\"\
- : false, \"highlight_args\": {}, \"xml:space\": \"preserve\", \"language\": \"\
- python\", \"linenos\": false} -->\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\
- \nNew in version 1.1.6.\n\nDeprecated 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:
- - <xref:str>
- - name: with_tenant
- description: If True, return a three-tuple with last as tenant ID
- defaultValue: 'False'
- types:
- - <xref:bool>
- return:
- description: tuple of Credentials and SubscriptionID (and tenant ID if with_tenant)
- types:
- - <xref:tuple>
- 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.
-
-
- *Disclaimer*: This method is not working for azure-cli-core>=2.21.0 (released
- in March 2021).
-
-
- New in version 1.1.6.
-
-
- Deprecated since version 1.1.28.'
- signature: get_cli_profile()
- return:
- description: A CLI Profile
- types:
- - <xref:azure.cli.core._profile.Profile>
- 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
deleted file mode 100644
index 919416eb3f21..000000000000
--- a/previous/docs-ref-autogen/azure-common/azure.common.exceptions.yml
+++ /dev/null
@@ -1,4 +0,0 @@
-### 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
index 97cd58e28608..dd99f3564e8b 100644
--- a/previous/docs-ref-autogen/azure-common/azure.common.yml
+++ b/previous/docs-ref-autogen/azure-common/azure.common.yml
@@ -9,7 +9,4 @@ classes:
- 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/index.yml b/previous/docs-ref-autogen/azure-common/index.yml
index ac0d76f96eac..52fa509174f8 100644
--- a/previous/docs-ref-autogen/azure-common/index.yml
+++ b/previous/docs-ref-autogen/azure-common/index.yml
@@ -7,8 +7,5 @@ packages:
- azure.common
- azure.profiles
modules:
-- azure.common.client_factory
- azure.common.cloud
-- azure.common.credentials
-- azure.common.exceptions
- azure.profiles.multiapiclient
diff --git a/previous/docs-ref-autogen/toc.yml b/previous/docs-ref-autogen/toc.yml
index 9fee8a8ea2d6..2cd482ae9e17 100644
--- a/previous/docs-ref-autogen/toc.yml
+++ b/previous/docs-ref-autogen/toc.yml
@@ -748,7 +748,6 @@
uid: azure.applicationinsights.ApplicationInsightsDataClient
name: azure.applicationinsights
name: azure-applicationinsights
-
- items:
- name: Overview
uid: project-azure-cognitiveservices-anomalydetector
@@ -791,7 +790,6 @@
uid: azure.cognitiveservices.anomalydetector.AnomalyDetectorClientConfiguration
name: azure.cognitiveservices.anomalydetector
name: azure-cognitiveservices-anomalydetector
-
- items:
- name: Overview
uid: project-azure-cognitiveservices-language-textanalytics
@@ -1102,18 +1100,11 @@
uid: azure.cognitiveservices.language.textanalytics.TextAnalyticsClient
name: azure.cognitiveservices.language.textanalytics
name: azure-cognitiveservices-language-textanalytics
-
- items:
- name: Overview
uid: project-azure-common
- - name: azure.common.client_factory
- uid: azure.common.client_factory
- name: azure.common.cloud
uid: azure.common.cloud
- - name: azure.common.credentials
- uid: azure.common.credentials
- - name: azure.common.exceptions
- uid: azure.common.exceptions
- items:
- name: Overview
uid: azure.profiles.multiapiclient
@@ -1145,7 +1136,6 @@
uid: azure.profiles.ProfileDefinition
name: azure.profiles
name: azure-common
-
- items:
- name: Overview
uid: project-azure-cosmos
@@ -1354,7 +1344,6 @@
uid: azure.cosmos.routing
name: azure.cosmos
name: azure-cosmos
-
- items:
- name: Overview
uid: project-azure-graphrbac
@@ -2141,7 +2130,6 @@
uid: azure.graphrbac.GraphRbacManagementClient
name: azure.graphrbac
name: azure-graphrbac
-
- items:
- name: Overview
uid: project-azure-keyvault
@@ -4604,7 +4592,6 @@
uid: azure.keyvault.StorageSasDefinitionId
name: azure.keyvault
name: azure-keyvault
-
- items:
- name: Overview
uid: project-azure-loganalytics
@@ -4733,7 +4720,6 @@
uid: azure.loganalytics.LogAnalyticsDataClient
name: azure.loganalytics
name: azure-loganalytics
-
- items:
- name: Overview
uid: project-azure-mgmt-agfood
@@ -4834,7 +4820,6 @@
uid: azure.mgmt.agfood.AzureAgFoodPlatformRPService
name: azure.mgmt.agfood
name: azure-mgmt-agfood
-
- items:
- name: Overview
uid: project-azure-mgmt-app
@@ -5151,7 +5136,6 @@
uid: azure.mgmt.app.ContainerAppsAPIClient
name: azure.mgmt.app
name: azure-mgmt-app
-
- items:
- name: Overview
uid: project-azure-mgmt-azureadb2c
@@ -5290,7 +5274,6 @@
uid: azure.mgmt.azureadb2c.CPIMConfigurationClient
name: azure.mgmt.azureadb2c
name: azure-mgmt-azureadb2c
-
- items:
- name: Overview
uid: project-azure-mgmt-batchai
@@ -5531,7 +5514,6 @@
uid: azure.mgmt.batchai.BatchAI
name: azure.mgmt.batchai
name: azure-mgmt-batchai
-
- items:
- name: Overview
uid: project-azure-mgmt-edgegateway
@@ -6622,7 +6604,6 @@
uid: azure.mgmt.edgegateway.DataBoxEdgeManagementClient
name: azure.mgmt.edgegateway
name: azure-mgmt-edgegateway
-
- items:
- name: Overview
uid: project-azure-mgmt-powerbiembedded
@@ -6911,7 +6892,6 @@
uid: azure.mgmt.powerbiembedded.PowerBIEmbeddedManagementClient
name: azure.mgmt.powerbiembedded
name: azure-mgmt-powerbiembedded
-
- items:
- name: Overview
uid: project-azure-mgmt-storageimportexport
@@ -7010,7 +6990,6 @@
uid: azure.mgmt.storageimportexport.StorageImportExport
name: azure.mgmt.storageimportexport
name: azure-mgmt-storageimportexport
-
- items:
- name: Overview
uid: project-azure-mgmt-videoanalyzer
@@ -7363,7 +7342,6 @@
uid: azure.mgmt.videoanalyzer.VideoAnalyzer
name: azure.mgmt.videoanalyzer
name: azure-mgmt-videoanalyzer
-
- items:
- name: Overview
uid: project-azure-mgmt-workloadmonitor
@@ -7424,7 +7402,6 @@
uid: azure.mgmt.workloadmonitor.WorkloadMonitorAPI
name: azure.mgmt.workloadmonitor
name: azure-mgmt-workloadmonitor
-
- items:
- name: Overview
uid: project-azure-storage-blob
@@ -7527,7 +7504,6 @@
- name: azure.storage.blob
uid: azure.storage.blob
name: azure-storage-blob
-
- items:
- name: Overview
uid: project-azure-storage-common
@@ -7604,7 +7580,6 @@
- name: azure.storage.common
uid: azure.storage.common
name: azure-storage-common
-
- items:
- name: Overview
uid: project-azure-storage-file
@@ -7659,7 +7634,6 @@
- name: azure.storage.file
uid: azure.storage.file
name: azure-storage-file
-
- items:
- name: Overview
uid: project-azure-storage-queue
@@ -7690,4 +7664,3 @@
- name: azure.storage.queue
uid: azure.storage.queue
name: azure-storage-queue
-
diff --git a/xrefmap.yml b/xrefmap.yml
index 397313e92f61..f0e8d2f6dfb8 100644
--- a/xrefmap.yml
+++ b/xrefmap.yml
@@ -25715,6 +25715,10 @@ references:
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