Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hcGlzL3t9L2RlcGxveW1lbnRzL3t9/2024-03-01.xml (698 lines of code) (raw):

<?xml version='1.0' encoding='utf-8'?> <CodeGen plane="mgmt-plane"> <resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apis/{}/deployments/{}" version="2024-03-01" swagger="mgmt-plane/apicenter/ResourceProviders/Microsoft.ApiCenter/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQXBpQ2VudGVyL3NlcnZpY2VzL3tzZXJ2aWNlTmFtZX0vd29ya3NwYWNlcy97d29ya3NwYWNlTmFtZX0vYXBpcy97YXBpTmFtZX0vZGVwbG95bWVudHMve2RlcGxveW1lbnROYW1lfQ==/V/MjAyNC0wMy0wMQ=="/> <commandGroup name="apic api deployment"> <command name="show" version="2024-03-01"> <resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apis/{}/deployments/{}" version="2024-03-01" swagger="mgmt-plane/apicenter/ResourceProviders/Microsoft.ApiCenter/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQXBpQ2VudGVyL3NlcnZpY2VzL3tzZXJ2aWNlTmFtZX0vd29ya3NwYWNlcy97d29ya3NwYWNlTmFtZX0vYXBpcy97YXBpTmFtZX0vZGVwbG95bWVudHMve2RlcGxveW1lbnROYW1lfQ==/V/MjAyNC0wMy0wMQ=="/> <argGroup name=""> <arg type="string" var="$Path.apiName" options="api-id" required="True" group="" idPart="child_name_2"> <help short="The id of the API."/> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </arg> <arg type="string" var="$Path.deploymentName" options="deployment-id" required="True" group="" idPart="child_name_3"> <help short="The id of the API deployment."/> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </arg> <arg type="ResourceGroupName" var="$Path.resourceGroupName" options="resource-group g" required="True" idPart="resource_group"/> <arg type="string" var="$Path.serviceName" options="service-name n" required="True" group="" idPart="name"> <help short="The name of Azure API Center service."/> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </arg> <arg type="SubscriptionId" var="$Path.subscriptionId" options="subscription" required="True" idPart="subscription"/> <arg type="string" var="$Path.workspaceName" options="workspace-name workspace w" required="True" group="" idPart="child_name_1"> <help short="The name of the workspace."/> <default value="&quot;default&quot;"/> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </arg> </argGroup> <operation operationId="Deployments_Get"> <http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/deployments/{deploymentName}"> <request method="get"> <path> <param type="string" name="apiName" arg="$Path.apiName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> <param type="string" name="deploymentName" arg="$Path.deploymentName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> <param type="string" name="resourceGroupName" arg="$Path.resourceGroupName" required="True"> <format maxLength="90" minLength="1"/> </param> <param type="string" name="serviceName" arg="$Path.serviceName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> <param type="uuid" name="subscriptionId" arg="$Path.subscriptionId" required="True"/> <param type="string" name="workspaceName" arg="$Path.workspaceName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> </path> <query> <const readOnly="True" const="True" type="string" name="api-version" required="True"> <default value="&quot;2024-03-01&quot;"/> <format minLength="1"/> </const> </query> </request> <response statusCode="200"> <header> <item name="ETag"/> </header> <body> <json var="$Instance"> <schema type="object"> <prop readOnly="True" type="ResourceId" name="id"> <format template="/subscriptions/{}/resourceGroups/{}/providers/Microsoft.ApiCenter/services/{}/workspaces/{}/apis/{}/deployments/{}"/> </prop> <prop readOnly="True" type="string" name="name"/> <prop type="object" name="properties" clientFlatten="True"> <prop type="object" name="customProperties"> <additionalProp anyType="True"/> </prop> <prop type="string" name="definitionId"/> <prop type="string" name="description"> <format maxLength="500"/> </prop> <prop type="string" name="environmentId"/> <prop type="object" name="server"> <prop type="array<string>" name="runtimeUri"> <item type="string"> <format maxLength="200"/> </item> </prop> </prop> <prop type="string" name="state"> <enum> <item value="&quot;active&quot;"/> <item value="&quot;inactive&quot;"/> </enum> </prop> <prop type="string" name="title"> <format maxLength="50" minLength="1"/> </prop> </prop> <prop readOnly="True" type="object" name="systemData"> <prop type="dateTime" name="createdAt"/> <prop type="string" name="createdBy"/> <prop type="string" name="createdByType"> <enum> <item value="&quot;Application&quot;"/> <item value="&quot;Key&quot;"/> <item value="&quot;ManagedIdentity&quot;"/> <item value="&quot;User&quot;"/> </enum> </prop> <prop type="dateTime" name="lastModifiedAt"/> <prop type="string" name="lastModifiedBy"/> <prop type="string" name="lastModifiedByType"> <enum> <item value="&quot;Application&quot;"/> <item value="&quot;Key&quot;"/> <item value="&quot;ManagedIdentity&quot;"/> <item value="&quot;User&quot;"/> </enum> </prop> </prop> <prop readOnly="True" type="string" name="type"/> </schema> </json> </body> </response> <response isError="True"> <body> <json> <schema type="@MgmtErrorFormat"/> </json> </body> </response> </http> </operation> <output type="object" ref="$Instance" clientFlatten="True"/> </command> <command name="delete" version="2024-03-01" confirmation="Are you sure you want to perform this operation?"> <resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apis/{}/deployments/{}" version="2024-03-01" swagger="mgmt-plane/apicenter/ResourceProviders/Microsoft.ApiCenter/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQXBpQ2VudGVyL3NlcnZpY2VzL3tzZXJ2aWNlTmFtZX0vd29ya3NwYWNlcy97d29ya3NwYWNlTmFtZX0vYXBpcy97YXBpTmFtZX0vZGVwbG95bWVudHMve2RlcGxveW1lbnROYW1lfQ==/V/MjAyNC0wMy0wMQ=="/> <argGroup name=""> <arg type="string" var="$Path.apiName" options="api-id" required="True" group="" idPart="child_name_2"> <help short="The id of the API."/> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </arg> <arg type="string" var="$Path.deploymentName" options="deployment-id" required="True" group="" idPart="child_name_3"> <help short="The id of the API deployment."/> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </arg> <arg type="ResourceGroupName" var="$Path.resourceGroupName" options="resource-group g" required="True" idPart="resource_group"/> <arg type="string" var="$Path.serviceName" options="service-name n" required="True" group="" idPart="name"> <help short="The name of Azure API Center service."/> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </arg> <arg type="SubscriptionId" var="$Path.subscriptionId" options="subscription" required="True" idPart="subscription"/> <arg type="string" var="$Path.workspaceName" options="workspace-name workspace w" required="True" group="" idPart="child_name_1"> <help short="The name of the workspace."/> <default value="&quot;default&quot;"/> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </arg> </argGroup> <operation operationId="Deployments_Delete"> <http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/deployments/{deploymentName}"> <request method="delete"> <path> <param type="string" name="apiName" arg="$Path.apiName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> <param type="string" name="deploymentName" arg="$Path.deploymentName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> <param type="string" name="resourceGroupName" arg="$Path.resourceGroupName" required="True"> <format maxLength="90" minLength="1"/> </param> <param type="string" name="serviceName" arg="$Path.serviceName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> <param type="uuid" name="subscriptionId" arg="$Path.subscriptionId" required="True"/> <param type="string" name="workspaceName" arg="$Path.workspaceName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> </path> <query> <const readOnly="True" const="True" type="string" name="api-version" required="True"> <default value="&quot;2024-03-01&quot;"/> <format minLength="1"/> </const> </query> </request> <response statusCode="200"/> <response statusCode="204"/> <response isError="True"> <body> <json> <schema type="@MgmtErrorFormat"/> </json> </body> </response> </http> </operation> </command> <command name="create" version="2024-03-01" confirmation=""> <resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apis/{}/deployments/{}" version="2024-03-01" swagger="mgmt-plane/apicenter/ResourceProviders/Microsoft.ApiCenter/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQXBpQ2VudGVyL3NlcnZpY2VzL3tzZXJ2aWNlTmFtZX0vd29ya3NwYWNlcy97d29ya3NwYWNlTmFtZX0vYXBpcy97YXBpTmFtZX0vZGVwbG95bWVudHMve2RlcGxveW1lbnROYW1lfQ==/V/MjAyNC0wMy0wMQ=="/> <argGroup name=""> <arg type="string" var="$Path.apiName" options="api-id" required="True" group="" idPart="child_name_2"> <help short="The id of the API."/> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </arg> <arg type="string" var="$Path.deploymentName" options="deployment-id" required="True" group="" idPart="child_name_3"> <help short="The id of the API deployment."/> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </arg> <arg type="ResourceGroupName" var="$Path.resourceGroupName" options="resource-group g" required="True" idPart="resource_group"/> <arg type="string" var="$Path.serviceName" options="service-name n" required="True" group="" idPart="name"> <help short="The name of Azure API Center service."/> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </arg> <arg type="SubscriptionId" var="$Path.subscriptionId" options="subscription" required="True" idPart="subscription"/> <arg type="string" var="$Path.workspaceName" options="workspace-name workspace w" required="True" group="" idPart="child_name_1"> <help short="The name of the workspace."/> <default value="&quot;default&quot;"/> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </arg> </argGroup> <argGroup name="Properties"> <arg type="object" var="$payload.properties.customProperties" options="custom-properties" group="Properties"> <blank value="{}"/> <help short="The custom metadata defined for API catalog entities."/> <additionalProp anyType="True"/> </arg> <arg type="string" var="$payload.properties.definitionId" options="definition-id" group="Properties"> <help short="API center-scoped definition resource ID."/> </arg> <arg type="string" var="$payload.properties.description" options="description" group="Properties"> <help short="Description of the deployment."/> <format maxLength="500"/> </arg> <arg type="string" var="$payload.properties.environmentId" options="environment-id" group="Properties"> <help short="API center-scoped environment resource ID."/> </arg> <arg type="object" var="$payload.properties.server" options="server" group="Properties"> <help short="Server"/> <arg type="array<string>" var="$payload.properties.server.runtimeUri" options="runtime-uri"> <help short="Base runtime URLs for this deployment."/> <item type="string"> <format maxLength="200"/> </item> </arg> </arg> <arg type="string" var="$payload.properties.state" options="state" hide="True" group="Properties"> <help short="State of API deployment."/> <enum> <item name="active" value="&quot;active&quot;"/> <item name="inactive" value="&quot;inactive&quot;"/> </enum> </arg> <arg type="string" var="$payload.properties.title" options="title" group="Properties"> <help short="Deployment title"/> <format maxLength="50" minLength="1"/> </arg> </argGroup> <operation operationId="Deployments_CreateOrUpdate"> <http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/deployments/{deploymentName}"> <request method="put"> <path> <param type="string" name="apiName" arg="$Path.apiName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> <param type="string" name="deploymentName" arg="$Path.deploymentName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> <param type="string" name="resourceGroupName" arg="$Path.resourceGroupName" required="True"> <format maxLength="90" minLength="1"/> </param> <param type="string" name="serviceName" arg="$Path.serviceName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> <param type="uuid" name="subscriptionId" arg="$Path.subscriptionId" required="True"/> <param type="string" name="workspaceName" arg="$Path.workspaceName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> </path> <query> <const readOnly="True" const="True" type="string" name="api-version" required="True"> <default value="&quot;2024-03-01&quot;"/> <format minLength="1"/> </const> </query> <body> <json> <schema type="object" name="payload" required="True" clientFlatten="True"> <prop type="object" name="properties" clientFlatten="True"> <prop type="object" name="customProperties" arg="$payload.properties.customProperties"> <additionalProp anyType="True"/> </prop> <prop type="string" name="definitionId" arg="$payload.properties.definitionId"/> <prop type="string" name="description" arg="$payload.properties.description"> <format maxLength="500"/> </prop> <prop type="string" name="environmentId" arg="$payload.properties.environmentId"/> <prop type="object" name="server" arg="$payload.properties.server"> <prop type="array<string>" name="runtimeUri" arg="$payload.properties.server.runtimeUri"> <item type="string"> <format maxLength="200"/> </item> </prop> </prop> <prop type="string" name="state" arg="$payload.properties.state"> <enum> <item value="&quot;active&quot;"/> <item value="&quot;inactive&quot;"/> </enum> </prop> <prop type="string" name="title" arg="$payload.properties.title"> <format maxLength="50" minLength="1"/> </prop> </prop> </schema> </json> </body> </request> <response statusCode="200 201"> <header> <item name="ETag"/> </header> <body> <json var="$Instance"> <schema type="object"> <prop readOnly="True" type="ResourceId" name="id"> <format template="/subscriptions/{}/resourceGroups/{}/providers/Microsoft.ApiCenter/services/{}/workspaces/{}/apis/{}/deployments/{}"/> </prop> <prop readOnly="True" type="string" name="name"/> <prop type="object" name="properties" clientFlatten="True"> <prop type="object" name="customProperties"> <additionalProp anyType="True"/> </prop> <prop type="string" name="definitionId"/> <prop type="string" name="description"> <format maxLength="500"/> </prop> <prop type="string" name="environmentId"/> <prop type="object" name="server"> <prop type="array<string>" name="runtimeUri"> <item type="string"> <format maxLength="200"/> </item> </prop> </prop> <prop type="string" name="state"> <enum> <item value="&quot;active&quot;"/> <item value="&quot;inactive&quot;"/> </enum> </prop> <prop type="string" name="title"> <format maxLength="50" minLength="1"/> </prop> </prop> <prop readOnly="True" type="object" name="systemData"> <prop type="dateTime" name="createdAt"/> <prop type="string" name="createdBy"/> <prop type="string" name="createdByType"> <enum> <item value="&quot;Application&quot;"/> <item value="&quot;Key&quot;"/> <item value="&quot;ManagedIdentity&quot;"/> <item value="&quot;User&quot;"/> </enum> </prop> <prop type="dateTime" name="lastModifiedAt"/> <prop type="string" name="lastModifiedBy"/> <prop type="string" name="lastModifiedByType"> <enum> <item value="&quot;Application&quot;"/> <item value="&quot;Key&quot;"/> <item value="&quot;ManagedIdentity&quot;"/> <item value="&quot;User&quot;"/> </enum> </prop> </prop> <prop readOnly="True" type="string" name="type"/> </schema> </json> </body> </response> <response isError="True"> <body> <json> <schema type="@MgmtErrorFormat"/> </json> </body> </response> </http> </operation> <output type="object" ref="$Instance" clientFlatten="True"/> </command> <command name="check-exists" version="2024-03-01" confirmation=""> <resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apis/{}/deployments/{}" version="2024-03-01" swagger="mgmt-plane/apicenter/ResourceProviders/Microsoft.ApiCenter/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQXBpQ2VudGVyL3NlcnZpY2VzL3tzZXJ2aWNlTmFtZX0vd29ya3NwYWNlcy97d29ya3NwYWNlTmFtZX0vYXBpcy97YXBpTmFtZX0vZGVwbG95bWVudHMve2RlcGxveW1lbnROYW1lfQ==/V/MjAyNC0wMy0wMQ=="/> <argGroup name=""> <arg type="string" var="$Path.apiName" options="api-id" required="True" group="" idPart="child_name_2"> <help short="The id of the API."/> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </arg> <arg type="string" var="$Path.deploymentName" options="deployment-id" required="True" group="" idPart="child_name_3"> <help short="The id of the API deployment."/> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </arg> <arg type="ResourceGroupName" var="$Path.resourceGroupName" options="resource-group g" required="True" idPart="resource_group"/> <arg type="string" var="$Path.serviceName" options="service-name n" required="True" group="" idPart="name"> <help short="The name of Azure API Center service."/> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </arg> <arg type="SubscriptionId" var="$Path.subscriptionId" options="subscription" required="True" idPart="subscription"/> <arg type="string" var="$Path.workspaceName" options="workspace-name workspace w" required="True" group="" idPart="child_name_1"> <help short="The name of the workspace."/> <default value="&quot;default&quot;"/> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </arg> </argGroup> <operation operationId="Deployments_Head"> <http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/deployments/{deploymentName}"> <request method="head"> <path> <param type="string" name="apiName" arg="$Path.apiName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> <param type="string" name="deploymentName" arg="$Path.deploymentName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> <param type="string" name="resourceGroupName" arg="$Path.resourceGroupName" required="True"> <format maxLength="90" minLength="1"/> </param> <param type="string" name="serviceName" arg="$Path.serviceName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> <param type="uuid" name="subscriptionId" arg="$Path.subscriptionId" required="True"/> <param type="string" name="workspaceName" arg="$Path.workspaceName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> </path> <query> <const readOnly="True" const="True" type="string" name="api-version" required="True"> <default value="&quot;2024-03-01&quot;"/> <format minLength="1"/> </const> </query> </request> <response statusCode="200"/> <response isError="True"> <body> <json> <schema type="@MgmtErrorFormat"/> </json> </body> </response> </http> </operation> </command> <command name="update" version="2024-03-01" confirmation=""> <resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apis/{}/deployments/{}" version="2024-03-01" swagger="mgmt-plane/apicenter/ResourceProviders/Microsoft.ApiCenter/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQXBpQ2VudGVyL3NlcnZpY2VzL3tzZXJ2aWNlTmFtZX0vd29ya3NwYWNlcy97d29ya3NwYWNlTmFtZX0vYXBpcy97YXBpTmFtZX0vZGVwbG95bWVudHMve2RlcGxveW1lbnROYW1lfQ==/V/MjAyNC0wMy0wMQ=="/> <argGroup name=""> <arg type="string" var="$Path.apiName" options="api-id" required="True" group="" idPart="child_name_2"> <help short="The id of the API."/> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </arg> <arg type="string" var="$Path.deploymentName" options="deployment-id" required="True" group="" idPart="child_name_3"> <help short="The id of the API deployment."/> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </arg> <arg type="ResourceGroupName" var="$Path.resourceGroupName" options="resource-group g" required="True" idPart="resource_group"/> <arg type="string" var="$Path.serviceName" options="service-name n" required="True" group="" idPart="name"> <help short="The name of Azure API Center service."/> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </arg> <arg type="SubscriptionId" var="$Path.subscriptionId" options="subscription" required="True" idPart="subscription"/> <arg type="string" var="$Path.workspaceName" options="workspace-name workspace w" required="True" group="" idPart="child_name_1"> <help short="The name of the workspace."/> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </arg> </argGroup> <argGroup name="Properties"> <arg nullable="True" type="object" var="$payload.properties.customProperties" options="custom-properties" group="Properties"> <blank value="{}"/> <help short="The custom metadata defined for API catalog entities."/> <additionalProp anyType="True"/> </arg> <arg nullable="True" type="string" var="$payload.properties.definitionId" options="definition-id" group="Properties"> <help short="Service-scoped definition resource ID."/> </arg> <arg nullable="True" type="string" var="$payload.properties.description" options="description" group="Properties"> <help short="Description of the deployment."/> <format maxLength="500"/> </arg> <arg nullable="True" type="string" var="$payload.properties.environmentId" options="environment-id" group="Properties"> <help short="Service-scoped environment resource ID."/> </arg> <arg nullable="True" type="object" var="$payload.properties.server" options="server" group="Properties"> <help short="Server"/> <arg nullable="True" type="array<string>" var="$payload.properties.server.runtimeUri" options="runtime-uri"> <help short="Base runtime URLs for this deployment."/> <item nullable="True" type="string"> <format maxLength="200"/> </item> </arg> </arg> <arg nullable="True" type="string" var="$payload.properties.state" options="state" hide="True" group="Properties"> <help short="State of API deployment."/> <enum> <item name="active" value="&quot;active&quot;"/> <item name="inactive" value="&quot;inactive&quot;"/> </enum> </arg> <arg nullable="True" type="string" var="$payload.properties.title" options="title" group="Properties"> <help short="Title"/> <format maxLength="50" minLength="1"/> </arg> </argGroup> <operation operationId="Deployments_Get"> <http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/deployments/{deploymentName}"> <request method="get"> <path> <param type="string" name="apiName" arg="$Path.apiName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> <param type="string" name="deploymentName" arg="$Path.deploymentName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> <param type="string" name="resourceGroupName" arg="$Path.resourceGroupName" required="True"> <format maxLength="90" minLength="1"/> </param> <param type="string" name="serviceName" arg="$Path.serviceName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> <param type="uuid" name="subscriptionId" arg="$Path.subscriptionId" required="True"/> <param type="string" name="workspaceName" arg="$Path.workspaceName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> </path> <query> <const readOnly="True" const="True" type="string" name="api-version" required="True"> <default value="&quot;2024-03-01&quot;"/> <format minLength="1"/> </const> </query> </request> <response statusCode="200"> <header> <item name="ETag"/> </header> <body> <json var="$Instance"> <schema type="object" cls="Deployment_read"> <prop readOnly="True" type="ResourceId" name="id"> <format template="/subscriptions/{}/resourceGroups/{}/providers/Microsoft.ApiCenter/services/{}/workspaces/{}/apis/{}/deployments/{}"/> </prop> <prop readOnly="True" type="string" name="name"/> <prop type="object" name="properties" clientFlatten="True"> <prop type="object" name="customProperties"> <additionalProp anyType="True"/> </prop> <prop type="string" name="definitionId"/> <prop type="string" name="description"> <format maxLength="500"/> </prop> <prop type="string" name="environmentId"/> <prop type="object" name="server"> <prop type="array<string>" name="runtimeUri"> <item type="string"> <format maxLength="200"/> </item> </prop> </prop> <prop type="string" name="state"> <enum> <item value="&quot;active&quot;"/> <item value="&quot;inactive&quot;"/> </enum> </prop> <prop type="string" name="title"> <format maxLength="50" minLength="1"/> </prop> </prop> <prop readOnly="True" type="object" name="systemData"> <prop type="dateTime" name="createdAt"/> <prop type="string" name="createdBy"/> <prop type="string" name="createdByType"> <enum> <item value="&quot;Application&quot;"/> <item value="&quot;Key&quot;"/> <item value="&quot;ManagedIdentity&quot;"/> <item value="&quot;User&quot;"/> </enum> </prop> <prop type="dateTime" name="lastModifiedAt"/> <prop type="string" name="lastModifiedBy"/> <prop type="string" name="lastModifiedByType"> <enum> <item value="&quot;Application&quot;"/> <item value="&quot;Key&quot;"/> <item value="&quot;ManagedIdentity&quot;"/> <item value="&quot;User&quot;"/> </enum> </prop> </prop> <prop readOnly="True" type="string" name="type"/> </schema> </json> </body> </response> <response isError="True"> <body> <json> <schema type="@MgmtErrorFormat"/> </json> </body> </response> </http> </operation> <operation> <instanceUpdate ref="$Instance"> <json> <schema type="object" name="payload" required="True" clientFlatten="True"> <prop type="object" name="properties" clientFlatten="True"> <prop type="object" name="customProperties" arg="$payload.properties.customProperties"> <additionalProp anyType="True"/> </prop> <prop type="string" name="definitionId" arg="$payload.properties.definitionId"/> <prop type="string" name="description" arg="$payload.properties.description"> <format maxLength="500"/> </prop> <prop type="string" name="environmentId" arg="$payload.properties.environmentId"/> <prop type="object" name="server" arg="$payload.properties.server"> <prop type="array<string>" name="runtimeUri" arg="$payload.properties.server.runtimeUri"> <item type="string"> <format maxLength="200"/> </item> </prop> </prop> <prop type="string" name="state" arg="$payload.properties.state"> <enum> <item value="&quot;active&quot;"/> <item value="&quot;inactive&quot;"/> </enum> </prop> <prop type="string" name="title" arg="$payload.properties.title"> <format maxLength="50" minLength="1"/> </prop> </prop> </schema> </json> </instanceUpdate> </operation> <operation operationId="Deployments_CreateOrUpdate"> <http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/deployments/{deploymentName}"> <request method="put"> <path> <param type="string" name="apiName" arg="$Path.apiName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> <param type="string" name="deploymentName" arg="$Path.deploymentName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> <param type="string" name="resourceGroupName" arg="$Path.resourceGroupName" required="True"> <format maxLength="90" minLength="1"/> </param> <param type="string" name="serviceName" arg="$Path.serviceName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> <param type="uuid" name="subscriptionId" arg="$Path.subscriptionId" required="True"/> <param type="string" name="workspaceName" arg="$Path.workspaceName" required="True"> <format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/> </param> </path> <query> <const readOnly="True" const="True" type="string" name="api-version" required="True"> <default value="&quot;2024-03-01&quot;"/> <format minLength="1"/> </const> </query> <body> <json ref="$Instance"/> </body> </request> <response statusCode="200 201"> <header> <item name="ETag"/> </header> <body> <json var="$Instance"> <schema type="@Deployment_read"/> </json> </body> </response> <response isError="True"> <body> <json> <schema type="@MgmtErrorFormat"/> </json> </body> </response> </http> </operation> <output type="object" ref="$Instance" clientFlatten="True"/> </command> </commandGroup> </CodeGen>