Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9lbnZpcm9ubWVudHMve30=/2024-03-01.xml (755 lines of code) (raw):
<?xml version='1.0' encoding='utf-8'?>
<CodeGen plane="mgmt-plane">
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/environments/{}" version="2024-03-01" swagger="mgmt-plane/apicenter/ResourceProviders/Microsoft.ApiCenter/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQXBpQ2VudGVyL3NlcnZpY2VzL3tzZXJ2aWNlTmFtZX0vd29ya3NwYWNlcy97d29ya3NwYWNlTmFtZX0vZW52aXJvbm1lbnRzL3tlbnZpcm9ubWVudE5hbWV9/V/MjAyNC0wMy0wMQ=="/>
<commandGroup name="apic environment">
<command name="show" version="2024-03-01">
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/environments/{}" version="2024-03-01" swagger="mgmt-plane/apicenter/ResourceProviders/Microsoft.ApiCenter/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQXBpQ2VudGVyL3NlcnZpY2VzL3tzZXJ2aWNlTmFtZX0vd29ya3NwYWNlcy97d29ya3NwYWNlTmFtZX0vZW52aXJvbm1lbnRzL3tlbnZpcm9ubWVudE5hbWV9/V/MjAyNC0wMy0wMQ=="/>
<argGroup name="">
<arg type="string" var="$Path.environmentName" options="environment-id" required="True" group="" idPart="child_name_2">
<help short="The id of the environment."/>
<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=""default""/>
<format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/>
</arg>
</argGroup>
<operation operationId="Environments_Get">
<http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/environments/{environmentName}">
<request method="get">
<path>
<param type="string" name="environmentName" arg="$Path.environmentName" 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=""2024-03-01""/>
<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/{}/environments/{}"/>
</prop>
<prop readOnly="True" type="string" name="name"/>
<prop type="object" name="properties" required="True" clientFlatten="True">
<prop type="object" name="customProperties">
<additionalProp anyType="True"/>
</prop>
<prop type="string" name="description"/>
<prop type="string" name="kind" required="True">
<enum>
<item value=""development""/>
<item value=""production""/>
<item value=""staging""/>
<item value=""testing""/>
</enum>
</prop>
<prop type="object" name="onboarding">
<prop type="array<string>" name="developerPortalUri">
<item type="string"/>
</prop>
<prop type="string" name="instructions"/>
</prop>
<prop type="object" name="server">
<prop type="array<string>" name="managementPortalUri">
<item type="string"/>
</prop>
<prop type="string" name="type">
<enum>
<item value=""AWS API Gateway""/>
<item value=""Apigee API Management""/>
<item value=""Azure API Management""/>
<item value=""Azure compute service""/>
<item value=""Kong API Gateway""/>
<item value=""Kubernetes""/>
<item value=""MuleSoft API Management""/>
</enum>
</prop>
</prop>
<prop type="string" name="title" required="True">
<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=""Application""/>
<item value=""Key""/>
<item value=""ManagedIdentity""/>
<item value=""User""/>
</enum>
</prop>
<prop type="dateTime" name="lastModifiedAt"/>
<prop type="string" name="lastModifiedBy"/>
<prop type="string" name="lastModifiedByType">
<enum>
<item value=""Application""/>
<item value=""Key""/>
<item value=""ManagedIdentity""/>
<item value=""User""/>
</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/{}/environments/{}" version="2024-03-01" swagger="mgmt-plane/apicenter/ResourceProviders/Microsoft.ApiCenter/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQXBpQ2VudGVyL3NlcnZpY2VzL3tzZXJ2aWNlTmFtZX0vd29ya3NwYWNlcy97d29ya3NwYWNlTmFtZX0vZW52aXJvbm1lbnRzL3tlbnZpcm9ubWVudE5hbWV9/V/MjAyNC0wMy0wMQ=="/>
<argGroup name="">
<arg type="string" var="$Path.environmentName" options="environment-id" required="True" group="" idPart="child_name_2">
<help short="The id of the environment."/>
<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=""default""/>
<format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/>
</arg>
</argGroup>
<operation operationId="Environments_Delete">
<http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/environments/{environmentName}">
<request method="delete">
<path>
<param type="string" name="environmentName" arg="$Path.environmentName" 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=""2024-03-01""/>
<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/{}/environments/{}" version="2024-03-01" swagger="mgmt-plane/apicenter/ResourceProviders/Microsoft.ApiCenter/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQXBpQ2VudGVyL3NlcnZpY2VzL3tzZXJ2aWNlTmFtZX0vd29ya3NwYWNlcy97d29ya3NwYWNlTmFtZX0vZW52aXJvbm1lbnRzL3tlbnZpcm9ubWVudE5hbWV9/V/MjAyNC0wMy0wMQ=="/>
<argGroup name="">
<arg type="string" var="$Path.environmentName" options="environment-id" required="True" group="" idPart="child_name_2">
<help short="The id of the environment."/>
<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=""default""/>
<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.description" options="description" group="Properties">
<help short="Environment description."/>
</arg>
<arg type="string" var="$payload.properties.kind" options="type" required="True" group="Properties">
<help short="Environment type."/>
<enum>
<item name="development" value=""development""/>
<item name="production" value=""production""/>
<item name="staging" value=""staging""/>
<item name="testing" value=""testing""/>
</enum>
</arg>
<arg type="object" var="$payload.properties.onboarding" options="onboarding" group="Properties">
<help short="Provide onboarding documentation related to your environment, e.g. {developerPortalUri:['https://developer.contoso.com'],instructions:'instructions markdown'}"/>
<arg type="array<string>" var="$payload.properties.onboarding.developerPortalUri" options="developer-portal-uri">
<help short="The location of the development portal"/>
<item type="string"/>
</arg>
<arg type="string" var="$payload.properties.onboarding.instructions" options="instructions">
<help short="Onboarding guide."/>
</arg>
</arg>
<arg type="object" var="$payload.properties.server" options="server" group="Properties">
<help short="Server information of the environment."/>
<arg type="array<string>" var="$payload.properties.server.managementPortalUri" options="management-portal-uri">
<help short="The location of the management portal"/>
<item type="string"/>
</arg>
<arg type="string" var="$payload.properties.server.type" options="type">
<help short="Type of the server that represents the environment."/>
<enum>
<item name="AWS API Gateway" value=""AWS API Gateway""/>
<item name="Apigee API Management" value=""Apigee API Management""/>
<item name="Azure API Management" value=""Azure API Management""/>
<item name="Azure compute service" value=""Azure compute service""/>
<item name="Kong API Gateway" value=""Kong API Gateway""/>
<item name="Kubernetes" value=""Kubernetes""/>
<item name="MuleSoft API Management" value=""MuleSoft API Management""/>
</enum>
</arg>
</arg>
<arg type="string" var="$payload.properties.title" options="title" required="True" group="Properties">
<help short="Environment title."/>
<format maxLength="50" minLength="1"/>
</arg>
</argGroup>
<operation operationId="Environments_CreateOrUpdate">
<http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/environments/{environmentName}">
<request method="put">
<path>
<param type="string" name="environmentName" arg="$Path.environmentName" 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=""2024-03-01""/>
<format minLength="1"/>
</const>
</query>
<body>
<json>
<schema type="object" name="payload" required="True" clientFlatten="True">
<prop type="object" name="properties" required="True" clientFlatten="True">
<prop type="object" name="customProperties" arg="$payload.properties.customProperties">
<additionalProp anyType="True"/>
</prop>
<prop type="string" name="description" arg="$payload.properties.description"/>
<prop type="string" name="kind" arg="$payload.properties.kind" required="True">
<enum>
<item value=""development""/>
<item value=""production""/>
<item value=""staging""/>
<item value=""testing""/>
</enum>
</prop>
<prop type="object" name="onboarding" arg="$payload.properties.onboarding">
<prop type="array<string>" name="developerPortalUri" arg="$payload.properties.onboarding.developerPortalUri">
<item type="string"/>
</prop>
<prop type="string" name="instructions" arg="$payload.properties.onboarding.instructions"/>
</prop>
<prop type="object" name="server" arg="$payload.properties.server">
<prop type="array<string>" name="managementPortalUri" arg="$payload.properties.server.managementPortalUri">
<item type="string"/>
</prop>
<prop type="string" name="type" arg="$payload.properties.server.type">
<enum>
<item value=""AWS API Gateway""/>
<item value=""Apigee API Management""/>
<item value=""Azure API Management""/>
<item value=""Azure compute service""/>
<item value=""Kong API Gateway""/>
<item value=""Kubernetes""/>
<item value=""MuleSoft API Management""/>
</enum>
</prop>
</prop>
<prop type="string" name="title" arg="$payload.properties.title" required="True">
<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/{}/environments/{}"/>
</prop>
<prop readOnly="True" type="string" name="name"/>
<prop type="object" name="properties" required="True" clientFlatten="True">
<prop type="object" name="customProperties">
<additionalProp anyType="True"/>
</prop>
<prop type="string" name="description"/>
<prop type="string" name="kind" required="True">
<enum>
<item value=""development""/>
<item value=""production""/>
<item value=""staging""/>
<item value=""testing""/>
</enum>
</prop>
<prop type="object" name="onboarding">
<prop type="array<string>" name="developerPortalUri">
<item type="string"/>
</prop>
<prop type="string" name="instructions"/>
</prop>
<prop type="object" name="server">
<prop type="array<string>" name="managementPortalUri">
<item type="string"/>
</prop>
<prop type="string" name="type">
<enum>
<item value=""AWS API Gateway""/>
<item value=""Apigee API Management""/>
<item value=""Azure API Management""/>
<item value=""Azure compute service""/>
<item value=""Kong API Gateway""/>
<item value=""Kubernetes""/>
<item value=""MuleSoft API Management""/>
</enum>
</prop>
</prop>
<prop type="string" name="title" required="True">
<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=""Application""/>
<item value=""Key""/>
<item value=""ManagedIdentity""/>
<item value=""User""/>
</enum>
</prop>
<prop type="dateTime" name="lastModifiedAt"/>
<prop type="string" name="lastModifiedBy"/>
<prop type="string" name="lastModifiedByType">
<enum>
<item value=""Application""/>
<item value=""Key""/>
<item value=""ManagedIdentity""/>
<item value=""User""/>
</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/{}/environments/{}" version="2024-03-01" swagger="mgmt-plane/apicenter/ResourceProviders/Microsoft.ApiCenter/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQXBpQ2VudGVyL3NlcnZpY2VzL3tzZXJ2aWNlTmFtZX0vd29ya3NwYWNlcy97d29ya3NwYWNlTmFtZX0vZW52aXJvbm1lbnRzL3tlbnZpcm9ubWVudE5hbWV9/V/MjAyNC0wMy0wMQ=="/>
<argGroup name="">
<arg type="string" var="$Path.environmentName" options="environment-id" required="True" group="" idPart="child_name_2">
<help short="The id of the environment."/>
<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=""default""/>
<format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/>
</arg>
</argGroup>
<operation operationId="Environments_Head">
<http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/environments/{environmentName}">
<request method="head">
<path>
<param type="string" name="environmentName" arg="$Path.environmentName" 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=""2024-03-01""/>
<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/{}/environments/{}" version="2024-03-01" swagger="mgmt-plane/apicenter/ResourceProviders/Microsoft.ApiCenter/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQXBpQ2VudGVyL3NlcnZpY2VzL3tzZXJ2aWNlTmFtZX0vd29ya3NwYWNlcy97d29ya3NwYWNlTmFtZX0vZW52aXJvbm1lbnRzL3tlbnZpcm9ubWVudE5hbWV9/V/MjAyNC0wMy0wMQ=="/>
<argGroup name="">
<arg type="string" var="$Path.environmentName" options="environment-id" required="True" group="" idPart="child_name_2">
<help short="The id of the environment."/>
<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.description" options="description" group="Properties">
<help short="Description."/>
</arg>
<arg type="string" var="$payload.properties.kind" options="type" group="Properties">
<help short="Environment type."/>
<enum>
<item name="development" value=""development""/>
<item name="production" value=""production""/>
<item name="staging" value=""staging""/>
<item name="testing" value=""testing""/>
</enum>
</arg>
<arg nullable="True" type="object" var="$payload.properties.onboarding" options="onboarding" group="Properties">
<help short="{developerPortalUri:['https://developer.contoso.com'],instructions:'instructions markdown'}"/>
<arg nullable="True" type="array<string>" var="$payload.properties.onboarding.developerPortalUri" options="developer-portal-uri">
<help short="The location of the development portal"/>
<item nullable="True" type="string"/>
</arg>
<arg nullable="True" type="string" var="$payload.properties.onboarding.instructions" options="instructions">
<help short="Onboarding guide."/>
</arg>
</arg>
<arg nullable="True" type="object" var="$payload.properties.server" options="server" group="Properties">
<help short="Server information of the environment."/>
<arg nullable="True" type="array<string>" var="$payload.properties.server.managementPortalUri" options="management-portal-uri">
<help short="The location of the management portal"/>
<item nullable="True" type="string"/>
</arg>
<arg nullable="True" type="string" var="$payload.properties.server.type" options="type">
<help short="Type of the server that represents the environment."/>
<enum>
<item name="AWS API Gateway" value=""AWS API Gateway""/>
<item name="Apigee API Management" value=""Apigee API Management""/>
<item name="Azure API Management" value=""Azure API Management""/>
<item name="Azure compute service" value=""Azure compute service""/>
<item name="Kong API Gateway" value=""Kong API Gateway""/>
<item name="Kubernetes" value=""Kubernetes""/>
<item name="MuleSoft API Management" value=""MuleSoft API Management""/>
</enum>
</arg>
</arg>
<arg type="string" var="$payload.properties.title" options="title" group="Properties">
<help short="Environment title."/>
<format maxLength="50" minLength="1"/>
</arg>
</argGroup>
<operation operationId="Environments_Get">
<http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/environments/{environmentName}">
<request method="get">
<path>
<param type="string" name="environmentName" arg="$Path.environmentName" 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=""2024-03-01""/>
<format minLength="1"/>
</const>
</query>
</request>
<response statusCode="200">
<header>
<item name="ETag"/>
</header>
<body>
<json var="$Instance">
<schema type="object" cls="Environment_read">
<prop readOnly="True" type="ResourceId" name="id">
<format template="/subscriptions/{}/resourceGroups/{}/providers/Microsoft.ApiCenter/services/{}/workspaces/{}/environments/{}"/>
</prop>
<prop readOnly="True" type="string" name="name"/>
<prop type="object" name="properties" required="True" clientFlatten="True">
<prop type="object" name="customProperties">
<additionalProp anyType="True"/>
</prop>
<prop type="string" name="description"/>
<prop type="string" name="kind" required="True">
<enum>
<item value=""development""/>
<item value=""production""/>
<item value=""staging""/>
<item value=""testing""/>
</enum>
</prop>
<prop type="object" name="onboarding">
<prop type="array<string>" name="developerPortalUri">
<item type="string"/>
</prop>
<prop type="string" name="instructions"/>
</prop>
<prop type="object" name="server">
<prop type="array<string>" name="managementPortalUri">
<item type="string"/>
</prop>
<prop type="string" name="type">
<enum>
<item value=""AWS API Gateway""/>
<item value=""Apigee API Management""/>
<item value=""Azure API Management""/>
<item value=""Azure compute service""/>
<item value=""Kong API Gateway""/>
<item value=""Kubernetes""/>
<item value=""MuleSoft API Management""/>
</enum>
</prop>
</prop>
<prop type="string" name="title" required="True">
<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=""Application""/>
<item value=""Key""/>
<item value=""ManagedIdentity""/>
<item value=""User""/>
</enum>
</prop>
<prop type="dateTime" name="lastModifiedAt"/>
<prop type="string" name="lastModifiedBy"/>
<prop type="string" name="lastModifiedByType">
<enum>
<item value=""Application""/>
<item value=""Key""/>
<item value=""ManagedIdentity""/>
<item value=""User""/>
</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" required="True" clientFlatten="True">
<prop type="object" name="customProperties" arg="$payload.properties.customProperties">
<additionalProp anyType="True"/>
</prop>
<prop type="string" name="description" arg="$payload.properties.description"/>
<prop type="string" name="kind" arg="$payload.properties.kind" required="True">
<enum>
<item value=""development""/>
<item value=""production""/>
<item value=""staging""/>
<item value=""testing""/>
</enum>
</prop>
<prop type="object" name="onboarding" arg="$payload.properties.onboarding">
<prop type="array<string>" name="developerPortalUri" arg="$payload.properties.onboarding.developerPortalUri">
<item type="string"/>
</prop>
<prop type="string" name="instructions" arg="$payload.properties.onboarding.instructions"/>
</prop>
<prop type="object" name="server" arg="$payload.properties.server">
<prop type="array<string>" name="managementPortalUri" arg="$payload.properties.server.managementPortalUri">
<item type="string"/>
</prop>
<prop type="string" name="type" arg="$payload.properties.server.type">
<enum>
<item value=""AWS API Gateway""/>
<item value=""Apigee API Management""/>
<item value=""Azure API Management""/>
<item value=""Azure compute service""/>
<item value=""Kong API Gateway""/>
<item value=""Kubernetes""/>
<item value=""MuleSoft API Management""/>
</enum>
</prop>
</prop>
<prop type="string" name="title" arg="$payload.properties.title" required="True">
<format maxLength="50" minLength="1"/>
</prop>
</prop>
</schema>
</json>
</instanceUpdate>
</operation>
<operation operationId="Environments_CreateOrUpdate">
<http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/environments/{environmentName}">
<request method="put">
<path>
<param type="string" name="environmentName" arg="$Path.environmentName" 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=""2024-03-01""/>
<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="@Environment_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>