Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

[AutoPR azure-mgmt-cognitiveservices] Cognitive Services: Add missing descriptions for errors #3051

Closed
wants to merge 1 commit into from
Closed

[AutoPR azure-mgmt-cognitiveservices] Cognitive Services: Add missing descriptions for errors #3051

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions ...rvices/azure/mgmt/cognitiveservices/models/_cognitive_services_management_client_enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ class SkuTier(str, Enum):
free = "Free"
standard = "Standard"
premium = "Premium"
enterprise = "Enterprise"


class ProvisioningState(str, Enum):
Expand Down
65 changes: 40 additions & 25 deletions ...itiveservices/azure-mgmt-cognitiveservices/azure/mgmt/cognitiveservices/models/_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,19 @@
class Resource(Model):
"""Resource.

Common fields that are returned in the response for all Azure Resource
Manager resources.

Variables are only populated by the server, and will be ignored when
sending a request.

:ivar id: Fully qualified resource Id for the resource. Ex -
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
:vartype id: str
:ivar name: The name of the resource
:vartype name: str
:ivar type: The type of the resource. Ex-
Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
:ivar type: The type of the resource. E.g.
"Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
:vartype type: str
"""

Expand All @@ -49,19 +52,21 @@ def __init__(self, **kwargs):


class AzureEntityResource(Resource):
"""The resource model definition for a Azure Resource Manager resource with an
etag.
"""Entity Resource.

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.

:ivar id: Fully qualified resource Id for the resource. Ex -
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
:vartype id: str
:ivar name: The name of the resource
:vartype name: str
:ivar type: The type of the resource. Ex-
Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
:ivar type: The type of the resource. E.g.
"Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
:vartype type: str
:ivar etag: Resource Etag.
:vartype etag: str
Expand Down Expand Up @@ -451,13 +456,16 @@ class CognitiveServicesAccountProperties(Model):
:param api_properties: The api properties for special APIs.
:type api_properties:
~azure.mgmt.cognitiveservices.models.CognitiveServicesAccountApiProperties
:ivar date_created: Gets the date of cognitive services account creation.
:vartype date_created: str
"""

_validation = {
'provisioning_state': {'readonly': True},
'endpoint': {'readonly': True},
'internal_id': {'readonly': True},
'capabilities': {'readonly': True},
'date_created': {'readonly': True},
}

_attribute_map = {
Expand All @@ -472,6 +480,7 @@ class CognitiveServicesAccountProperties(Model):
'private_endpoint_connections': {'key': 'privateEndpointConnections', 'type': '[PrivateEndpointConnection]'},
'public_network_access': {'key': 'publicNetworkAccess', 'type': 'str'},
'api_properties': {'key': 'apiProperties', 'type': 'CognitiveServicesAccountApiProperties'},
'date_created': {'key': 'dateCreated', 'type': 'str'},
}

def __init__(self, **kwargs):
Expand All @@ -487,6 +496,7 @@ def __init__(self, **kwargs):
self.private_endpoint_connections = kwargs.get('private_endpoint_connections', None)
self.public_network_access = kwargs.get('public_network_access', None)
self.api_properties = kwargs.get('api_properties', None)
self.date_created = None


class CognitiveServicesResourceAndSku(Model):
Expand Down Expand Up @@ -818,13 +828,13 @@ class PrivateEndpointConnection(Resource):
Variables are only populated by the server, and will be ignored when
sending a request.

:ivar id: Fully qualified resource Id for the resource. Ex -
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
:vartype id: str
:ivar name: The name of the resource
:vartype name: str
:ivar type: The type of the resource. Ex-
Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
:ivar type: The type of the resource. E.g.
"Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
:vartype type: str
:param properties: Resource properties.
:type properties:
Expand Down Expand Up @@ -906,13 +916,13 @@ class PrivateLinkResource(Resource):
Variables are only populated by the server, and will be ignored when
sending a request.

:ivar id: Fully qualified resource Id for the resource. Ex -
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
:vartype id: str
:ivar name: The name of the resource
:vartype name: str
:ivar type: The type of the resource. Ex-
Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
:ivar type: The type of the resource. E.g.
"Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
:vartype type: str
:param properties: Resource properties.
:type properties:
Expand Down Expand Up @@ -1022,19 +1032,21 @@ def __init__(self, **kwargs):


class ProxyResource(Resource):
"""The resource model definition for a ARM proxy resource. It will have
everything other than required location and tags.
"""Proxy Resource.

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.

:ivar id: Fully qualified resource Id for the resource. Ex -
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
:vartype id: str
:ivar name: The name of the resource
:vartype name: str
:ivar type: The type of the resource. Ex-
Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
:ivar type: The type of the resource. E.g.
"Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
:vartype type: str
"""

Expand Down Expand Up @@ -1212,7 +1224,7 @@ class Sku(Model):
creation, optional for update.
:type name: str
:ivar tier: Gets the sku tier. This is based on the SKU name. Possible
values include: 'Free', 'Standard', 'Premium'
values include: 'Free', 'Standard', 'Premium', 'Enterprise'
:vartype tier: str or ~azure.mgmt.cognitiveservices.models.SkuTier
"""

Expand All @@ -1223,7 +1235,7 @@ class Sku(Model):

_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'tier': {'key': 'tier', 'type': 'SkuTier'},
'tier': {'key': 'tier', 'type': 'str'},
}

def __init__(self, **kwargs):
Expand Down Expand Up @@ -1253,20 +1265,23 @@ def __init__(self, **kwargs):


class TrackedResource(Resource):
"""The resource model definition for a ARM tracked top level resource.
"""Tracked Resource.

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.

:ivar id: Fully qualified resource Id for the resource. Ex -
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
:vartype id: str
:ivar name: The name of the resource
:vartype name: str
:ivar type: The type of the resource. Ex-
Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
:ivar type: The type of the resource. E.g.
"Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
:vartype type: str
:param tags: Resource tags.
:type tags: dict[str, str]
Expand Down
65 changes: 40 additions & 25 deletions ...eservices/azure-mgmt-cognitiveservices/azure/mgmt/cognitiveservices/models/_models_py3.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,19 @@
class Resource(Model):
"""Resource.

Common fields that are returned in the response for all Azure Resource
Manager resources.

Variables are only populated by the server, and will be ignored when
sending a request.

:ivar id: Fully qualified resource Id for the resource. Ex -
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
:vartype id: str
:ivar name: The name of the resource
:vartype name: str
:ivar type: The type of the resource. Ex-
Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
:ivar type: The type of the resource. E.g.
"Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
:vartype type: str
"""

Expand All @@ -49,19 +52,21 @@ def __init__(self, **kwargs) -> None:


class AzureEntityResource(Resource):
"""The resource model definition for a Azure Resource Manager resource with an
etag.
"""Entity Resource.

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.

:ivar id: Fully qualified resource Id for the resource. Ex -
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
:vartype id: str
:ivar name: The name of the resource
:vartype name: str
:ivar type: The type of the resource. Ex-
Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
:ivar type: The type of the resource. E.g.
"Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
:vartype type: str
:ivar etag: Resource Etag.
:vartype etag: str
Expand Down Expand Up @@ -451,13 +456,16 @@ class CognitiveServicesAccountProperties(Model):
:param api_properties: The api properties for special APIs.
:type api_properties:
~azure.mgmt.cognitiveservices.models.CognitiveServicesAccountApiProperties
:ivar date_created: Gets the date of cognitive services account creation.
:vartype date_created: str
"""

_validation = {
'provisioning_state': {'readonly': True},
'endpoint': {'readonly': True},
'internal_id': {'readonly': True},
'capabilities': {'readonly': True},
'date_created': {'readonly': True},
}

_attribute_map = {
Expand All @@ -472,6 +480,7 @@ class CognitiveServicesAccountProperties(Model):
'private_endpoint_connections': {'key': 'privateEndpointConnections', 'type': '[PrivateEndpointConnection]'},
'public_network_access': {'key': 'publicNetworkAccess', 'type': 'str'},
'api_properties': {'key': 'apiProperties', 'type': 'CognitiveServicesAccountApiProperties'},
'date_created': {'key': 'dateCreated', 'type': 'str'},
}

def __init__(self, *, custom_sub_domain_name: str=None, network_acls=None, encryption=None, user_owned_storage=None, private_endpoint_connections=None, public_network_access=None, api_properties=None, **kwargs) -> None:
Expand All @@ -487,6 +496,7 @@ def __init__(self, *, custom_sub_domain_name: str=None, network_acls=None, encry
self.private_endpoint_connections = private_endpoint_connections
self.public_network_access = public_network_access
self.api_properties = api_properties
self.date_created = None


class CognitiveServicesResourceAndSku(Model):
Expand Down Expand Up @@ -818,13 +828,13 @@ class PrivateEndpointConnection(Resource):
Variables are only populated by the server, and will be ignored when
sending a request.

:ivar id: Fully qualified resource Id for the resource. Ex -
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
:vartype id: str
:ivar name: The name of the resource
:vartype name: str
:ivar type: The type of the resource. Ex-
Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
:ivar type: The type of the resource. E.g.
"Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
:vartype type: str
:param properties: Resource properties.
:type properties:
Expand Down Expand Up @@ -906,13 +916,13 @@ class PrivateLinkResource(Resource):
Variables are only populated by the server, and will be ignored when
sending a request.

:ivar id: Fully qualified resource Id for the resource. Ex -
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
:vartype id: str
:ivar name: The name of the resource
:vartype name: str
:ivar type: The type of the resource. Ex-
Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
:ivar type: The type of the resource. E.g.
"Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
:vartype type: str
:param properties: Resource properties.
:type properties:
Expand Down Expand Up @@ -1022,19 +1032,21 @@ def __init__(self, *, status=None, description: str=None, action_required: str=N


class ProxyResource(Resource):
"""The resource model definition for a ARM proxy resource. It will have
everything other than required location and tags.
"""Proxy Resource.

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.

:ivar id: Fully qualified resource Id for the resource. Ex -
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
:vartype id: str
:ivar name: The name of the resource
:vartype name: str
:ivar type: The type of the resource. Ex-
Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
:ivar type: The type of the resource. E.g.
"Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
:vartype type: str
"""

Expand Down Expand Up @@ -1212,7 +1224,7 @@ class Sku(Model):
creation, optional for update.
:type name: str
:ivar tier: Gets the sku tier. This is based on the SKU name. Possible
values include: 'Free', 'Standard', 'Premium'
values include: 'Free', 'Standard', 'Premium', 'Enterprise'
:vartype tier: str or ~azure.mgmt.cognitiveservices.models.SkuTier
"""

Expand All @@ -1223,7 +1235,7 @@ class Sku(Model):

_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'tier': {'key': 'tier', 'type': 'SkuTier'},
'tier': {'key': 'tier', 'type': 'str'},
}

def __init__(self, *, name: str, **kwargs) -> None:
Expand Down Expand Up @@ -1253,20 +1265,23 @@ def __init__(self, *, name: str=None, value: str=None, **kwargs) -> None:


class TrackedResource(Resource):
"""The resource model definition for a ARM tracked top level resource.
"""Tracked Resource.

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.

:ivar id: Fully qualified resource Id for the resource. Ex -
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
:vartype id: str
:ivar name: The name of the resource
:vartype name: str
:ivar type: The type of the resource. Ex-
Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
:ivar type: The type of the resource. E.g.
"Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
:vartype type: str
:param tags: Resource tags.
:type tags: dict[str, str]
Expand Down
Loading